Waybill Cancellation
This REST API is used by Unicommerce to call for cancelling any AWB(waybill) assignment once orders is cancelled (before dispatch).
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.
- The shipping provider is required to share details of their supported shipment statuses with Unicommerce. These details shall mention the status definitions and forward/reverse flags.
Tip
Complete integration flow is available on Basic Overview page.
Basic Information
| NAME | DETAILS |
|---|---|
| Usage: | Optional |
| Endpoint: | /cancel |
| Request Type: | POST |
| Scheme: | HTTPS |
| Header (Content-Type): | application/json |
| Header (Authorization): | token (got from SP Authentication) |
Request Payload
{
"waybill": "string"
}Request Payload Details
| PARAMETERS | TYPE | DESCRIPTION | MANDATORY | NOTES |
|---|---|---|---|---|
| waybill | string | Way bill numbers (inside quotes) | Yes | Only one waybill in each API request, Eg.: “3113210963421” |
Response Payload
{
"status":"SUCCESS",
"waybill": "string",
"errorMessage":"Pickup is successfully cancelled"
}Response Payload (Error)
{
"status":"FAILED",
"waybill": "string",
"errorMessage":"Pickup is not cancelled due to ... reason"
}Response Payload Details
| PARAMETER | TYPE | DESCRIPTION | NOTES |
|---|---|---|---|
| waybill | string | AWB no with Most recent shipment status | Eg: ABC123456- |
| status | string | Status of the API request | Allowable: SUCCESS, FAILED |
| errorMessage | string | Response message | Eg: Pickup is successfully cancelled, Pickup is not cancelled due to … reason |
Error Codes
Refer Response Codes section to know about specific errors codes.