Shipment Delivered
This REST API is used to notify the Partner when the shipment has been delivered 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: | /delivered |
| Request Type: | POST |
| Scheme: | HTTPS |
| Header (Content-Type): | application/json |
| Header (Authorization): | token value(got from Authentication |
Request Payload
{
"status": "delivered",
"saleOrderCode": "string",
"shippingPackageCode": "string",
"trackingNumber": "AB4568",
"courier": "SELF",
"timestamp": "Jul 9, 2024 3:34:35 PM",
"comment": ""
}Request Payload Details
| LEVEL | PARAMETER | TYPE | DESCRIPTION | MANDATORY | NOTES |
|---|---|---|---|---|---|
| 1 | status | string | Shipment status | Yes | - |
| 2 | saleOrderCode | string | Sale order code | Yes | - |
| 3 | shippingPackageCode | string | Shipment code | Yes | - |
| 4 | trackingNumber | string | trackingNumber(AWB) | Yes | - |
| 5 | courier | string | Shipping provider | Yes | - |
| 6 | timestamp | Date | date-time Eg: Jul 9, 2024 3:34:35 PM | Yes | - |
| 7 | comment | string | - | Yes | - |
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.