Get Courier Details
This REST API is used to fetch the courier details from the marketplace. This is required only when the orders are shipped by the marketplace. The courier details mentioned in response such as the shipper name and the AWB no. (tracking no.) are used to generate label in Uniware, when it is not fetched from the marketplace.
Tip
- This API is used only when the orders are shipped by the marketplace.
- 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.
Flow
Tip
Complete integration flow is available on Basic Overview page.
Basic Information
| NAME | DETAILS |
|---|---|
| Usage: | Optional, |
| Endpoint: | /courierDetails |
| Request Type: | GET |
| Scheme: | HTTPS |
| Header (Content-Type): | application/json |
| Header (apiKey): | accessToken (got from Get Authentication) |
Sample URL
https://{MarketplaceBaseUrl}/courierDetails?orderItemIds=abc123
Query Parameters
| PARAMETERS | TYPE | DESCRIPTION | MANDATORY | NOTES |
|---|---|---|---|---|
| orderItemIds | list | Item IDs (comma separated) | Yes | - |
Response Payload
{
"awbNo": "string",
"status": "AVAILABLE",
"courierCode": "string",
"courierName": "string",
"additionalInfo": "string"
}Response Payload Details
| LEVEL | PARAMETER | TYPE | DESCRIPTION | MANDATORY | NOTES |
|---|---|---|---|---|---|
| 1 | awbNo | string | Way bill no. (shipment tracking no.) | Yes | Eg: BHDESKFASLKEF |
| 2 | status | string | AVAILABLE if courier and tracking number is available | Yes | Allowable: AVAILABLE, SELLER_SHIPPING, COURIER_NOT_ASSIGNED |
| 3 | courierCode | string | Code of shipping provider | Yes | Eg: Fedex09 |
| 4 | courierName | string | Name of shipping provider | Yes | Eg: Fedex |
| 5 | additionalInfo | string | Any additional information | No | - |
Error Codes
Refer Response Codes section to know about specific errors codes.
FAQs/Notes
Q1. In this API’s Response Payload, if the courier and AWB number is not AVAILABLE, then what status would be reflected in the response?
Ans. This case will be same as the COURIER_NOT_ASSIGNED case. Accordingly the status would be reflected.
Q2. In case of SELLERSHIPPING and COURIER\NOT_ASSIGNED statuses, what will be the response message that is displayed?
Ans. These cases will generally not happen as the API will not be build of this occurs.
Q3. Is SELLER_SHIPPING not redundant?
Ans. No. It would be relevant when the MP handles both self shipping and third party shipping for certain cases.
Q4. In the lag cases, where the courier allotment at MP is taking more than 2-3 seconds to give response in this asynchronous API, how does UC provide solution to this?
Ans. In this case, as soon as the orders are created at the seller panel, the MP can allocate it to the shipping provider and generate AWB numbers in advance at that instant, to reduce the lag at the time of allotment of AWB numbers during this API call. By this solution, this API can act as a synchronous API.