v1

latestOpenAPI 3.1.0CC-BY-NC-SA-4.02026-07-2413803.8 MB

Shipments API

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

Advanced access token with shipments.write

OAuth access with shipments.write

patch/orders/{orderId}/shipments/{shipmentId}

Query parameters

testmodeboolean

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.

Request body

Example request

{
  "tracking": {
    "carrier": "PostNL",
    "code": "3SKABA000000000",
    "url": "http://postnl.nl/tracktrace/?B=3SKABA000000000&P=1015CW&D=NL&T=C"
  }
}

Response

The updated shipment object.