ManifestControllerV2

Download manifest report from carrier

post/api/v2/manifest/download

Request

Base URL
https://api.shipium.com
Auth
OAuth 2
Password
Token URLhttps://auth.shipium.com/oauth/token
Scopesdelivery-experience-service
TypeScript
https://skmtc.dev/shipium/apis/shipium-api/docs/api/v2/manifest/download/post.ts
A function with typed inputs. Its response is checked against the schema.

carrierAccountIdstring

Shipium id of the carrier account that corresponds to the manifest trying to download.

manifestJobIdstring required

The carrier supplied id for tracking/downloading the manifest

shipiumManifestIdstring required

The Shipium-generated id for tracking the manifest.

carrierIdstring required

Carrier id of the carrier that corresponds to the manifest trying to download

countryCodestring

Country code of the FC that is trying to download the manifest. Required if fulfillmentContextId is not provided.

fulfillmentContextIdstring

Fulfillment context ID for the manifest download. If provided, countryCode and postalCode are not required.

injectionSiteIdstring

Injection site ID for the manifest download.

postalCodestring

Postal code of the FC that is trying to download the manifest. Required if fulfillmentContextId is not provided.

tenantIdstring

Tenant id trying to download the manifest

testModeboolean

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

Successfully downloaded manifest report