POST /v1/orders/{id}/trackings

Scope

write_shipping

Request parameters

Name	In	Type	Required	Description
id	path	string	required	order_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.
order_shipping_id	body	string	required	The ID of the shipping destination. Take it from shippings in the order detail response.
carrier_id	body	string	required	The carrier ID. Obtain it from GET /v1/delivery_companies.
tracking_number	body	string	required	Tracking number.
delivery_date	body	string	optional	The delivery date (scheduled or actual), as YYYY-MM-DD.

Response example

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

Description

Register a tracking number. 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