PATCH /v1/orders/{id}/trackings/{tid}

Scope

write_shipping

Request parameters

Name	In	Type	Required	Description
id	path	string	required	order_id
tid	path	string	required	tracking_id
Idempotency-Key	header	string	required	Idempotency key (required). A UUID v4 is recommended. Resending the same key replays the original result, and the response carries Idempotent-Replay: true. Sending a different body with the same key returns 422, so always retry with the identical request.
carrier_id	body	string	optional	ID of the target resource.
tracking_number	body	string	optional	Tracking number. Omit it to leave the current value unchanged.
delivery_date	body	string	optional	Send null to clear the value.

Response example

{
  "tracking_id": "1",
  "order_id": "1",
  "order_shipping_id": "1",
  "carrier_id": "1",
  "tracking_number": "string",
  "delivery_date": "string"
}

Description

Correct a tracking record. Applied synchronously. (write_shipping)

Error response example

{
  "error": {
    "code": "insufficient_scope",
    "message": "requires scope 'write_shipping'",
    "request_id": "req_01H..."
  }
}

Possible errors: 401 / 403 / 404 / 503