Update shipment

Update the tracking information on a shipment.

For an in-depth explanation of each parameter, refer to the Create shipment endpoint.

Access with

API key

Organization access token with shipments.write

OAuth access with shipments.write

Path Params
string
required

Provide the ID of the related order.

string
required

Provide the ID of the related shipment.

Query Params
boolean

Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Body Params
tracking
object
required

Shipment tracking details. Can be omitted if tracking details are not available or not applicable.

Responses

Language
Credentials
LoadingLoadingโ€ฆ
Response
Choose an example:
application/hal+json