メインコンテンツまでスキップ

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

scope

write_shipping

リクエストパラメーター

名前位置必須説明
idパスstring必須order_id
tidパスstring必須tracking_id
Idempotency-Keyヘッダーstring必須冪等キー(必須)。UUID v4 を推奨します。同一キーの再送は最初の結果をそのまま再生し、応答に Idempotent-Replay: true が付きます。同一キーで異なるボディを送ると 422 になるため、リトライは必ず同一リクエストで行ってください
carrier_idボディstring任意対象のリソース ID
tracking_numberボディstring任意送り状番号。省略すると変更しません
delivery_dateボディstring任意null で消去

レスポンスの例

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

解説

登録済みの送り状を訂正します(配送業者・追跡番号・配達日のいずれか 1 つ以上)。実際に変化したフィールドだけが修正ログに差分記録されます。Idempotency-Key 必須。

エラーレスポンスの例

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

返しうるエラー: 401 / 403 / 404 / 503