Manifest all shipments for a carrier.

URL Expired

The URL for this request expired after 30 days.

Parameters

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

• 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

Example Request

curl --request POST \
     --url https://api.shipium.com/api/v2/manifest/carrier \
     --header 'accept: */*' \
     --header 'content-type: application/json'

Response Status

``200 Manifested shipments successfully.