Patch a previously generated shipment label. Fields that are present in the patch will be upserted against the existing label.

LoadingLoading…

Shipium API Parameters

• shipmentId
  Type: string
  Required: true

• carrierSelectionId
  Type: string
  Required: true

• shipiumLabelId
  Type: string
  Required: true

• eligibleForManifest
  Type: boolean
  Description: Whether this shipment can be manifested (true, null), or is being held (false) so that it should not be manifested.

• manifestDateTime
  Type: date-time
  Description: Client-supplied date time for when the label was manifested in their system or by an end-of-day process.

• trackingInfo
  Type: object
  Description: Details of the tracking history and status of the package.

• shipiumTrackingId
  Type: string
  Description: Shipium's tracking identification for the package.

• customLabelEntries
  Type: object
  Description: A free-form map of string key-value pairs to be applied to the label. When provided, the label will be regenerated incorporating the new metadata. Uses full-replacement semantics — the entire set of entries will be replaced with whatever is provided in the request.

API Responses

• 200: Updated carrier label.
• 404: Unable to find Carrier Label

Updated 28 days ago

Programming Language Examples

• Shell
• Node
• Ruby
• PHP
• Python

API Request Example

{
  "status": "Loading",
  "message": "Loading…"
}

API Response Status Codes

• 200
• 404

Updated 28 days ago