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.

Note: All overpacks in a manifest must have the same entry_point, can't be empty, or missing weight and dimensions

Some 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.

Note: It can take up to several minutes before forms are available for download after manifesting because the required background tasks run asynchronously.
Important: Once a manifest is created the associated overpacks and shipments can't be modified.

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

{"carrier": "DHL Express"}

String - The carrier delivering the overpacks to the warehouse. Optional. Max length: 20
created

{"created": "2015-05-05 15:43:03"}

String - The date and time the manifest was created. Set by the system.
entry_point

{"entry_point": "SZXI01"}

String - The drop off location for the overpacks. Inherited from the overpacks used to create the manifest.
id

{"id": 1002329}

Integer - The manifest ID. Set by the system.
mawb_id

{"mawb_id": 1229}

Integer - The ID for the Master Airway Bill this manifest is attached to. Set by the system. Not immediately available after creation. Default is null.
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_overpacks": 21}

Integer - Total number of overpacks in the manifest. Only viewable while searching. Set by system.
total_shipments

{"total_shipments": 420}

Integer - Total number of shipments in the manifest. Set by system. This may show as null while the manifest is being created in the background.
tracking_number

{"tracking_number": "9410293108"}

String - The tracking number for the overpacks being delivered to the warehouse. Optional. Max length: 40
warehouse_no

{"warehouse_no": "753906563638"}

String - An 11 or 12 character string for internal reference. It may not be immediately available after creating a manifest. Set by the system.
GET
/manifests/{id}
Retrieves a manifest or the paperwork for the manifest.
type The data stream type if you don't want the manifest details, but need the paperwork or forms. Only PDF is accepted.
request
GET /manifests/1002910 

		

		

		

			
response

			
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"
    }
}

		

		

		

			
request

			GET /manifests/1002910
			
type=PDF

		

		

		

			
response

			
HTTP/1.1 200 OK

			
[BLOB]

		

	






	

		
POST

		
/manifests

	

	

		Creates and transmits a manifest
	

	

		

			
request

			POST /manifests
						
{
    "manifest": {
        "carrier": "DHL",
        "overpacks": [
            100001,
            100002
        ],
        "tracking_number": "9410293108"
    }
}

		

		

		

			
response

			
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
    }
}