Manifest Shipments Async

By manifesting shipments you declare what shipments are ready for dispatch and will be handed over to the carrier.
The API allows you to manifest via the below methods (parameters):

- shipping location
- shipping account
- shipment status (picked)
- service code
- container

Note: If no parameters are set, all shipments in the LabelPrinted or Picked status will be manifested (excluding future dated shipments or shipments assigned to a container).

The API response contains a manifest image which should be printed and handed over to the driver (if required).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Carrier Code

Body Params

Manifest Request

string | null

Shipping Location Identifier
PRO SHIPPING Shipping Location Id (assigned by PRO SHIPPING) or Alias (assigned by you) that we are manifesting.


Required if you have more than one shipping location.

string | null

Container Id
Populate if you want to manifest a container.
You must have created the container and added the shipments to manifest to it first.
If this is populated, no other values other than the Shipping Location can be populated.

string
enum

Shipment Status

Manifest only the shipments with the status of:
Picked

Otherwise all shipments in a Label Printed or Picked status will be manifested.
Not valid if you are manifesting by container.

Allowed:
string | null

Shipping Account Identifier
PRO SHIPPING Shipping Account Id (assigned by PRO SHIPPING) or Alias (assigned by you) that you want to manifest.
Populate if want to manifest a specific shipping account only.
Not valid if you are manifesting by container.

string | null

Service Code
Populate if want to manifest a specific service only.
Not valid if you are manifesting by container.

Responses

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json