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.

Note: All overpacks in a manifest must have the same entry_point or else an error will be returned.

Important: Once a manifest is created, the associated overpacks and shipments cannot be modified.

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`	`{"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": "SZCN"}` 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.
`overpacks`	{ "overpacks": [ 100001, 100002 ] } Array - The list of overpacks linked to the manifest. Required.
`total_overpacks`	`{"total_overpacks": 21}` Integer - Total number of overpacks in a manifest. Only viewable while searching. Set by system.
`total_shipments`	`{"total_shipments": 420}` Integer - Total number of shipments in a manifest. Only viewable while searching. Set by system.
`tracking_number`	`{"tracking_number": "9410293108"}` String - The tracking number for the overpacks being delivered to the warehouse. Optional. Max length: 40

GET

/manifests

Retrieves a paginated list of manifests

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

request

GET /manifests

date_start=2015-04-01&date_end=2015-04-30&page=2=&limit=50&order=desc

response

HTTP/1.1 200 OK

{
    "manifests": [
        {
            "carrier": "DHL",
            "created": "2016-10-31 23:49:01",
            "entry_point": "HKGI01",
            "id": 909888,
            "total_overpacks": 31,
            "total_shipments": 420,
            "tracking_number": "9410293108"
        },
        {
            "...": "..."
        }
    ],
    "total_manifests": 120,
    "total_pages": 3
}

GET

/manifests/{id}

Retrieves a manifest or ticket

`type`	The data stream type if you don't want the manifest details, but need the delivery ticket. 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": "SZCN",
        "id": 1002910,
        "overpacks": [
            100001,
            100002
        ],
        "tracking_number": null
    }
}

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": "SZCN",
        "id": 1002910,
        "overpacks": [
            100001,
            100002
        ],
        "tracking_number": "9410293108"
    }
}

Basics

Reference

Actions

Properties