Update the specified carrier labels with the carrier and Shipium manifest ids.

put

https://api.shipium.com/api/v1/deliveryexperience/shipment/carrierSelection/labels/manifest/metadata

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

carrierManifestId

string

The carrier's identifier for the manifest containing these shipments. Omitted when a manifest run claims labels before the carrier manifest id is known; supplied later when the run resolves.

shipiumManifestId

string

required

Shipium's identifier for the manifest containing these shipments

shipiumLabelIds

array of strings

required

The Shipium-generated label identifiers for the shipments to update

shipiumLabelIds*

overwriteManifestIds

boolean

Defaults to false

If false, this update will only set the manifest ids for labels that are not already associated with a manifest. If true, this update will set the manifest ids for labels regardless of whether they are already associated with a manifest.

status

string

enum

Optional label status to set on the matched labels alongside the manifest ids (e.g. manifesting when a manifest run claims the labels, manifested when it resolves them). When omitted, the existing status is left unchanged.

Headers

X-DELEGATED-PARTNER-ID

string

Response

200Information about how many labels were updated.