Manifests
The Manifests resource is used for generating the paperwork required for dropping off Overpacks at a collection center at the end of the day. A user will provide a list of their Overpacks that will be dropped off together. A manifest consists of all Shipments and their respective Labels (tracking numbers) that are linked to each Overpack used to create the manifest. The user should print the PDF that's given to the collection center when dropping off their overpacks.
entry_point
, can't be empty, or contain test shipments.Actions
GET /manifests |
Retrieves a paginated list of manifests |
GET /manifests/{id} |
Retrieves a manifest or ticket |
POST /manifests |
Creates and transmits a manifest |
Properties
carrier |
|
created |
|
entry_point |
|
id |
|
mawb_id |
|
overpacks |
{ "overpacks": [ 100001, 100002 ] }Array - The list of overpacks linked to the manifest. Required when creating a manifest. |
overpacks_details |
{ "overpacks_details": [ { "created": "2020-04-20 02:59:45", "id": 1002677, "height": 20, "length": 20, "service": "BoxC Parcel", "weight": 3, "width": 20 } ] } Array - A list of the overpacks and their details that are part of this manifest. Only available when creating and requesting a single manifest. Set by the system. created: String - Datetime the overpack was created.id: Integer - The ID of the overpack. height: Integer - The height of the overpack in CM. length: Integer - The length of the overpack in CM. service: String - The shipping service of the overpack. weight: Integer - The weight of the overpack in KG. width: Integer - The width of the overpack in CM. |
total_overpacks |
|
total_shipments |
|
tracking_number |
|
warehouse_no |
|
entry_point |
Filter that returns manifests for a single entry point. |
date_start |
The inclusive date to begin the search in YYYY-MM-DD format. Default is 90 days ago. |
date_end |
The inclusive date to end the search in YYYY-MM-DD format. Default is now. |
limit |
The number of results to return. Max: 100. Default: 50. |
order |
The order of the results. Options are "asc" for ascending, or "desc" (default) for descending. |
page |
The page number of the results. Default is 1. |
GET /manifests
date_start=2015-04-01&date_end=2015-04-30&page=2=&limit=50&order=desc&entry_point=
HTTP/1.1 200 OK
{ "manifests": [ { "carrier": "DHL", "created": "2016-10-31 23:49:01", "entry_point": "HKGI01", "id": 909888, "mawb_id": 1005, "total_overpacks": 31, "total_shipments": 420, "tracking_number": "9410293108", "warehouse_no": "753906563638" }, { "...": "..." } ], "total_manifests": 0, "total_pages": 0 }
type |
The data stream type if you don't want the manifest details, but need the delivery ticket. Only PDF is accepted. |
GET /manifests/1002910
HTTP/1.1 200 OK
{ "manifest": { "carrier": null, "created": "2015-10-10 21:09:30", "entry_point": "SZXI01", "id": 1002910, "mawb_id": 1229, "overpacks": [ 100001, 100002 ], "overpacks_details": [ { "created": "2015-10-09 20:15:12", "id": 100001, "height": 20, "length": 20, "weight": 3, "width": 20 }, { "...": "..." } ], "total_shipments": 200, "tracking_number": null, "warehouse_no": "753906563638" } }
GET /manifests/1002910
type=PDF
HTTP/1.1 200 OK
[BLOB]
POST /manifests
{ "manifest": { "carrier": "DHL", "overpacks": [ 100001, 100002 ], "tracking_number": "9410293108" } }
HTTP/1.1 201 Created
{ "manifest": { "carrier": "DHL", "created": "2015-10-10 21:09:30", "entry_point": "SZXI01", "id": 1002910, "mawb_id": null, "overpacks": [ 100001, 100002 ], "overpacks_details": [ { "created": "2015-10-09 20:15:12", "id": 100001, "height": 20, "length": 20, "weight": 3, "width": 20 }, { "...": "..." } ], "total_shipments": 123, "tracking_number": "9410293108", "warehouse_no": null } }