POST /v1/orders/{id}/trackings
Scope
write_shipping
Request parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | integer | required | order_id |
Idempotency-Key | header | string | required | 冪等キー(必須・ADR-010)。UUID v4 推奨。同一キー再送は保存レスポンスを再生 |
order_shipping_id | body | integer | required | 配送先(order_shipping)の ID。注文詳細 EP の shippings から取得 |
carrier_id | body | integer | required | 配送業者 ID(GET /v1/delivery_companies) |
tracking_num | body | string | required | |
delivery_date | body | string | optional | 配達(予定)日 YYYY-MM-DD |
Response example
{
"tracking_id": 0,
"order_id": 0,
"order_shipping_id": 0,
"carrier_id": 0,
"tracking_num": "string",
"delivery_date": "string"
}
Description
送り状(追跡番号)を登録する(同期直行)(write_shipping)
Error response example
{
"error": {
"code": "insufficient_scope",
"message": "requires scope 'read_orders'",
"request_id": "req_01H..."
}
}
Possible errors: 401 / 403 / 404 / 503