SHshipium
ManifestControllerV2

Manifest all shipments for a carrier.

Changed on
post/api/v2/manifest/carrier

Request

Request body

carrierAccountIdstring

Shipium id of the carrier account that will be manifested.

carrierServiceMethodIdsstring[]

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.

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

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

carrierIdstring required

Carrier id of the carrier that will be manifested

countryCodestring

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

postalCodestring

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

fulfillmentContextIdstring

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

injectionSiteIdstring

Injection site ID to manifest.

tenantIdstring

Tenant id to be manifested

testModeboolean

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

Response

Manifested shipments successfully.

manifestIdstring

ID for this manifest attempt

partnerIdstring

Id of partner requesting to have the manifest created.

tenantIdstring

Id of tenant requesting to have the manifest created.

trackingIdsstring[]

List of tracking ids that are being manifested

Example response

{
  "shipFrom": {
    "addressLineComponents": {
      "streetName": "U.H. Fovisste Fuentes Brotantes",
      "primaryAddressNumber": "12",
      "secondaryAddressNumber": "302",
      "district": "Iztacalco",
      "neighborhood": "Agrícola Pantitlán"
    }
  }
}

Changes

  • 3edfc3693c7bRevision changes
    • warning

      deleted the header request parameter X-DELEGATED-PARTNER-ID

    • warning

      added the new TXT enum value to the // response property for the response status

    • info

      added the optional property // to the response with the status