Manifests
The Manifests resource is used for generating the paperwork required for dropping off Overpacks at a collection center or carrier facility at the end of the day. It also transmits the shipment data to the carrier(s) electronically. In order to create a manifest you must provide a list of the Overpacks that will be dropped off together. A manifest consists of all Shipments that are linked to each Overpack.
entry_point
, can't be empty, or missing weight and dimensionsSome manifests may have separate forms or no forms at all for the different carriers depending on the routes utilized by the affected shipments. Shipments should be sorted into Overpacks based on the carrier and other details prior to manifesting. Multiple copies of a form may exist for the driver and facility.
Actions
GET /manifests |
Retrieves a paginated list of manifests |
GET /manifests/{id} |
Retrieves a manifest or paperwork |
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. |
page_token |
Used for selecting the page after the initial query. |
GET /manifests
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" }, { "...": "..." } ], "next_page": "ZGF0ZV9lbmQ9MjAyMy0wNy0yOCZsaW1pdD01MCZvcmRlcj1kZXNjJnBhZ2U9MSZsYXN0X2lkPTkyNTYzOQ==" }
type |
The data stream type if you don't want the manifest details, but need the paperwork or forms. 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, "service": "BoxC Parcel", "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, "service": "BoxC Parcel", "weight": 3, "width": 20 }, { "...": "..." } ], "total_shipments": 123, "tracking_number": "9410293108", "warehouse_no": null } }