API Reference

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

patch
https://api.shipium.com/api/v1/deliveryexperience/shipment//carrierSelection//label/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
string
required
string
required
Body Params
boolean

Whether this shipment can be manifested (true, null), or is being held (false) so that it should not be manifested.

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.

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.

Responses

Updated 10 days ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 days ago