Generate Manifest
This REST API is used to get manifest from shipping provider/aggregator against AWB Nos. Uniware in this POST request sends the AWB nos. whose manifest is required. The shipping provider in response sends the manifest in pdf format for each listed AWB. In case of shipping aggregators, they are required to provide shipping provider specific (bifurcated) manifests.
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.
Flow
Tip
Complete integration flow is available on Basic Overview page.
Basic Information
NAME | DETAILS |
---|---|
Usage: | Mandatory for shipping aggregators |
Endpoint: | /manifest |
Request Type: | POST |
Scheme: | HTTPS |
Header (Content-Type): | application/json |
Header (Authorization): | token (got from SP Authentication) |
Request Payload
{
"awbNumbers":["16090109","16090108"]
}
Request Payload Details
PARAMETERS | TYPE | DESCRIPTION | MANDATORY | NOTES |
---|---|---|---|---|
awbNumbers | string | Way bill numbers (inside quotes) | Yes | Eg.: “16090109”,“16090108” |
Response 201:Success
Manifest in .pdf format will get generated for printing.
NOTE:
- It is mandatory to send manifest in .pdf format.
- It is mandatory to send success response code as 201.
{
"manifestNumber":343434334,
[Unique generated manifest number/id"]
"manifestDownloadUrl":"downloadable URL"[Downloadable URL which contains details of order shipping providers]
}
Response 400:
Manifest already generated for some AWBs, Please try again after removing them.
{
"message": "Manifest already generated for some AWBs, Please try again after removing them",
"alreadyManifestedAWBs": [
16090109s]
}
Response 40X:
Missing Fields or Invalid Data.
{
"message": "Some invalid AWBs provided, Please try again after removing them",
"invalidAWBs": [
16090109
]
}