Patch a previously generated shipment label. Fields that are present in the patch will be upserted against the existing label.
| Time | Status | User Agent | |
|---|---|---|---|
| Make a request to see history. |
URL Expired
The URL for this request expired after 30 days.
shipiumShipmentId
string
required
carrierSelectionId
string
required
shipiumLabelId
string
required
eligibleForManifest
boolean
Whether this shipment can be manifested (true, null), or is being held (false) so that it should not be manifested.
truefalse
manifestDateTime
date-time
Client-supplied date time for when the label was manifested in their system or by an end-of-day process.
trackingInfo
object
Details of the tracking history and status of the package.
trackingInfoobject
shipiumTrackingId
string
Shipium's tracking identification for the package.
customLabelEntries
object
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.
customLabelEntriesobject
`200 Updated carrier label.
`404 Unable to find Carrier Label
Updated 26 days ago
ShellNodeRubyPHPPython
Bearer
xxxxxxxxxx
curl --request PATCH \
--url https://api.shipium.com/api/v1/deliveryexperience/shipment/shipiumShipmentId/carrierSelection/carrierSelectionId/label/shipiumLabelId \
--header 'accept: application/json' \
--header 'content-type: application/json'
Click Try It! to start a request and see the response here! Or choose an example:
application/json
200404
Updated26 days ago