GET /v1/orders/{id}/items
scope
read_orders
リクエストパラメーター
| 名前 | 位置 | 型 | 必須 | 説明 |
|---|---|---|---|---|
id | パス | string | 必須 | 対象のリソース ID |
レスポンスの例
{
"data": [
{
"id": "5001",
"item_id": "1",
"name": "string",
"sku": "string",
"variant": {
"id": "2",
"sku": "TS-001-WH-M",
"name": "白 / M"
},
"quantity": 2,
"unit_price": {
"amount": 3200,
"currency": "JPY"
},
"total_price": {
"amount": 3200,
"currency": "JPY"
}
}
]
}
解説
注文の明細行(商品名・数量・単価・小計)を取得します。個人情報は含みません。バリエーションのある商品の明細には、購入された種類 variant(購入時点の SKU と種類名、現在のバリエーション ID)が付きます。sku は親商品の現在の SKU で、同じ商品の種類違いでは同じ値になるため、種類の特定には variant を使ってください。variant.id は、購入時点の SKU に一致する種類がその商品にちょうど 1 つあり、かつ現在の種類名が購入時点の種類名と同じときだけ返ります(種類の削除・作り直し、SKU や種類名の変更、SKU の重複があると null)。variant のキー自体が無い応答は「取得できなかった」ことを表し、null(種類なし)とは意味が異なります。その場合は時間をおいて再取得してください。
エラーレスポンスの例
{
"error": {
"code": "insufficient_scope",
"message": "requires scope 'read_orders'",
"request_id": "req_01H..."
}
}
返しうるエラー: 401 / 403 / 404 / 429