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

GET /v1/orders/{id}/shipments

scope​

read_orders

リクエストパラメーター​

名前位置型必須説明
idパスstring必須対象のリソース ID

レスポンスの例​

{
"data": [
{
"id": "9001",
"carrier_id": "string",
"shipping_cost": {
"amount": 3200,
"currency": "JPY"
},
"delivery_date": "string",
"delivery_time_zone": "string",
"tracking_number": "string",
"tracking_registered_at": "2026-10-01T03:00:00.000Z",
"tracking_delivery_date": "2026-10-03",
"recipient": {
"name": "string",
"zip": "string",
"prefecture": "string",
"city": "string",
"address_1": "string",
"address_2": "string",
"phone": "string"
}
}
]
}

解説​

注文の配送情報を取得します。read_orders_pii を持つ場合のみお届け先 recipient(氏名・住所・電話)が含まれます。送り状は tracking_number(番号)・tracking_registered_at(登録日時・UTC)・tracking_delivery_date(お届け予定日・日本時間の日付)で返します。1 つの配送に送り状が複数ある場合は、最初に登録された送り状の値です。delivery_date は購入者が指定した配送希望日で、送り状のお届け予定日とは別の項目です。番号なしで登録された送り状は tracking_number が空文字になります。tracking_registered_at があれば、その時点で送り状が登録されていた(発送の手続きが行われていた)ことが分かります。null は未発送を意味しません(送り状を登録せずに発送済みにできます。API の送り状登録で登録した送り状も、現在は登録日時が記録されず null です)。

エラーレスポンスの例​

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

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