POST /v1/orders/{id}/trackings
scope
write_shipping
リクエストパラメーター
| 名前 | 位置 | 型 | 必須 | 説明 |
|---|---|---|---|---|
id | パス | integer | 必須 | order_id |
Idempotency-Key | ヘッダー | string | 必須 | 冪等キー(必須・ADR-010)。UUID v4 推奨。同一キー再送は保存レスポンスを再生 |
order_shipping_id | ボディ | integer | 必須 | 配送先(order_shipping)の ID。注文詳細 EP の shippings から取得 |
carrier_id | ボディ | integer | 必須 | 配送業者 ID(GET /v1/delivery_companies) |
tracking_num | ボディ | string | 必須 | |
delivery_date | ボディ | string | 任意 | 配達(予定)日 YYYY-MM-DD |
レスポンスの例
{
"tracking_id": 0,
"order_id": 0,
"order_shipping_id": 0,
"carrier_id": 0,
"tracking_num": "string",
"delivery_date": "string"
}
解説
送り状(配送業者・追跡番号・配達予定日)を登録します。order_shipping_id は GET /v1/orders/{id}/shipments で取得してください。登録はマーチャントの修正ログに記録されます。Idempotency-Key 必須。
エラーレスポンスの例
{
"error": {
"code": "insufficient_scope",
"message": "requires scope 'read_orders'",
"request_id": "req_01H..."
}
}
返しうるエラー: 401 / 403 / 404 / 503