Update Tracking Status
This REST API is used to post updated shipment status 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/oms/updateShipmentTrackingStatus |
| Request Type: | POST |
| Level: | Facility |
| 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
{
"providerCode": "string",
"trackingNumber": "string",
"trackingStatus": "string",
"statusDate": "2020-07-08T06:35:09.454Z",
"shipmentTrackingStatusName": "string",
"rtoTrackingNumber": "string",
"rtoReason": "string"
}Request Payload Details
| LEVEL | PARAMETER | TYPE | DESCRIPTION | MANDATORY | NOTES |
|---|---|---|---|---|---|
| 1 | providerCode | string | Provider code | Yes | - |
| 2 | trackingNumber | string | Forward Tracking no. | Yes | - |
| 3 | trackingStatus | string | Tracking status | Yes | - |
| 4 | statusDate | date | Status date | No | - |
| 5 | shipmentTrackingStatusName | string | Shipment Tracking Status Name | Yes | - |
| 6 | rtoTrackingNumber | string | RTO Tracking no. | No | Pass if rto has a different tracking number than forward |
| 7 | rtoReason | string | RTO Reason | 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"
}
],
"totalPolled": 0,
"failures": 0,
"totalChanged": 0
}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 | totalPolled | integer | Total polled | - |
| 6 | failures | integer | Failures | - |
| 7 | totalChanged | integer | Total changed | - |
Error Codes
Refer Response Codes section to know about specific errors codes.