Manifest Shipments

post

https://api.proshipping.net/v4/manifests/{carrierCode}

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

Path Params

carrierCode

string

required

Carrier Code

Body Params

Manifest Request

ShippingLocationId

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.

ContainerId

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.

Status

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:

ShippingAccountId

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.

ServiceCode

string | null

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

Async

boolean

Async
Set to true if you don't want to wait for the manifest response. You will get an OK response with no data and can retrieve the manifest at a later point using the API.
This will happen in the background, so the manifest won't be available immediately and there's some validation that will not happen (for example, if there are no shipments to manifest)

Responses

401

Unauthorized

403

Forbidden

500

Internal Server Error

200The shipments have been manifested successfully and all created manifests returned.

400Invalid request response.