Update Shipment Seal ID (Multiple)
This REST API is used to capture a shipment level Seal ID of multiple Shipments in packing workflow in Uniware.
Tip
It is recommended to check out Notes for the reader. You might find this helpful as it contains Guidelines for using API references and Terminologies used here.
Basic Information
NAME | DETAILS |
---|---|
Endpoint: | /services/rest/v1/package/updateMultiple |
Request Type: | POST |
Level: | Tenant |
Scheme: | HTTPS |
Header (Content-Type): | application/json |
Header (Authorization): | bearer {access-token}, Eg.: bearer b30f3aea-7978-49bb-9ea7-33eddfc80afa |
Header (Facility): | facility code as in Uniware (refer FAQs) |
Request Payload
{
"packages": [
{
"shippingPackageCode": "05P1006717",
"shippingPackageTypeCode": "String",
"sptItemSealID": "123456",
"shipmentActualWeightCalculationRequired": true
},
{
"shippingPackageCode": "02P1001772",
"shippingPackageTypeCode": "String",
"sptItemSealID": "123457",
"shipmentActualWeightCalculationRequired": true
}
]
}
Request Payload Details
LEVEL | PARAMETER | TYPE | DESCRIPTION | MANDATORY | NOTES |
---|---|---|---|---|---|
1 | packages | Object | Shipping package details | Yes | - |
1.1 | shippingPackageCode | string | Shipping package code | Yes | - |
1.2 | shippingPackageTypeCode | string | Shipping package type code | Yes | - |
1.3 | sptItemSealID | string | Seal id associated with Shipping package | Yes | unique seal id for each shipping package id |
1.4 | shipmentActualWeightCalculationRequired | boolean | true to Weight calculation logic. else, false | No | - |
Response Payload
{
"successful": true,
"message": "string",
"errors": [
{
"code": 0,
"fieldName": "string",
"description": "string",
"message": "string",
"errorParams": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
}
}
],
"warnings": [
{
"code": 0,
"message": "string",
"description": "string"
}
],
"shippingPackageFullDTO": null
}
Response Payload Details
LEVEL | PARAMETER | TYPE | DESCRIPTION | NOTES |
---|---|---|---|---|
1 | successful | true | Request success status | - |
2 | message | string | Response message | - |
3 | errors | list | List of errors (if any) | - |
3.1 | code | number | Error code | - |
3.2 | fieldName | string | Field with error | - |
3.3 | description | string | Error description | - |
3.4 | message | string | Error message | - |
3.5 | errorParams | object | Parameters with error | - |
3.5.1 | additionalProp1 | object | Parameter 1 with error | - |
3.5.2 | additionalProp2 | object | Parameter 2 with error | - |
3.5.3 | additionalProp3 | object | Parameter 3 with error | - |
4 | warnings | list | List of warnings (if any) | - |
4.1 | code | number | Warning code | - |
4.2 | message | string | Warning message | - |
4.3 | description | string | Warning description | - |
5 | shippingPackageFullDTO | list | Array of updated inventory items | - |