Manifest all shipments for a carrier.

post

https://api.shipium.com/api/v2/manifest/carrier

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

carrierAccountId

string

Shipium id of the carrier account that will be manifested.

carrierServiceMethodIds

array of strings

The carrierServiceMethodIds that should be included in the manifest. If this is empty or null, it will behave the same as if it included all of the carrier's service methods.

carrierServiceMethodIds

previousManifestDateTime

date-time

The date time when the last successful manifest completed.
Optional, if missing this will manifest all unmanifested labels.

This is used to facilitate reprocessing of partially successful manifests, for carriers that support date range searches of manifests.

toDateTime

date-time

The most recent date time that a label can have been created in order to be included in the manifest.
Optional, defaults to the current time.

This is used to facilitate reprocessing of partially successful manifests, for carriers that support date range searches of manifests.

carrierId

string

required

Carrier id of the carrier that will be manifested

countryCode

string

Country code of the FC that will be getting manifested. Required if fulfillmentContextId is not provided.

postalCode

string

Postal code of the FC that will be manifested. Required if fulfillmentContextId is not provided.

fulfillmentContextId

string

Fulfillment context ID to manifest. If provided, countryCode and postalCode are not required.

injectionSiteId

string

Injection site ID to manifest.

tenantId

string

Tenant id to be manifested

testMode

boolean

Boolean to see if we will use carrier's sandbox environment. Defaults to false

Headers

X-DELEGATED-PARTNER-ID

string

Response

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200Manifested shipments successfully.