Shipment Ready To Ship
This REST API is used to notify the Partner when the shipment has been ready to ship in Uniware.
Tip
- The access token received in response is required in Header (Authorization) in all subsequent API requests.
- 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 |
|---|---|
| BaseUrl: | https://{PartnerBaseUrl} |
| Endpoint: | /assignAWB |
| Request Type: | POST |
| Scheme: | HTTPS |
| Header (Content-Type): | application/json |
| Header (Authorization): | token value(got from Authentication |
Request Payload
{
"invoiceCode": "string",
"invoiceDisplayCode": "string",
"shippingPackageCode": "string",
"saleOrderCode": "string",
"shippingProviderCode": "string",
"shippingProviderName": "string",
"shippingCourier": "string",
"trackingNumber": "AB4568",
"facilityCode": "WEARCOMETDELHI",
"created": "Jul 19, 2024 9:04:40 AM",
"label": "string",
"saleOrderItemCodes": [
"string"
],
"customFieldValues": [
{
"name": "string",
"value": "string"
}
]
}Request Payload Details
| LEVEL | PARAMETER | TYPE | DESCRIPTION | MANDATORY | NOTES |
|---|---|---|---|---|---|
| 1 | invoiceCode | string | Invoice code | Yes | - |
| 2 | invoiceDisplayCode | string | Invoice Display code | Yes | - |
| 3 | shippingPackageCode | string | Shipment code | Yes | - |
| 4 | saleOrderCode | string | Sale Order code | Yes | - |
| 5 | shippingProviderCode | string | Shipping provider code | Yes | - |
| 6 | shippingProviderName | string | Shipping provider name | Yes | - |
| 7 | trackingNumber | string | trackingNumber(AWB) | Yes | - |
| 8 | label | string | Label detail | Yes | - |
| 9 | saleOrderItemCodes | List | Order item codes | Yes | - |
| 9 | facilityCode | string | Order item codes | Yes | - |
| 9 | created | Date | date-time Eg: Feb 13, 2023 4:01:45 PM | Yes | - |
| 10 | customFieldValues | Object | Custom field details | Yes | - |
| 10.1 | name | string | Custom field name | No | - |
| 10.2 | value | string | Custom field value | No | - |
Response Payload
{
"status": "Success",
"message": "Detail is updated successfully"
}Response Payload Details
| LEVEL | PARAMETER | TYPE | DESCRIPTION | MANDATORY | NOTES |
|---|---|---|---|---|---|
| 1 | status | string | Success after notification is acknowledged | Yes | Success/Failed |
| 2 | message | string | Readable response message | Yes | - |
Error Codes
Refer Response Codes section to know about specific errors codes.
FAQs/Notes
Q1. What would be that frequency of Notification push to partner?
Ans. Real-time or nearly real-time.