操作
GET一覧取得 · ステータス一覧 — 注文/api/v1/order-statuses
GET一覧取得 — 注文/api/v1/orders
GET取得 — 注文/api/v1/orders/{order_id}
PATCH更新 · 支払いステータス — 注文/api/v1/orders/{order_id}/payment-status
PATCH更新 · ステータス — 注文/api/v1/orders/{order_id}/status
仕組み
注文一覧と詳細には delivery.dates が含まれます。YYYY-MM-DD 形式の日付は予定であり、発送済みを示しません。現在の日付が優先され、古い注文には保存された予測が使われます。削除済みまたは不明な値は null です。詳細にはすべての注文明細と商品画像も含まれます。
有効なステータス識別子は /api/v1/order-statuses から取得します。注文と支払いのステータスには、それぞれ別の PATCH エンドポイントと権限があります。記録上の支払いステータスを変えても、カードへの請求や決済事業者経由の返金は行われません。
delivery.dates: planned_dispatch_on, dispatch_timezone, estimated_delivery_from, estimated_delivery_to. 発送日と配送予定日: YYYY-MM-DD; null. 発送のタイムゾーン: IANA.
注文 · 合計
金額と税率は、項目の訂正を含む保存済み注文に基づきます。履歴が欠けている場合は null となり、現在の商品カタログの税率では補完しません。金額は十進数の文字列のまま扱います。
- tax_country_code · 課税国 · 保存された注文データ · ISO 3166-1 alpha-2; null.
- lines[].unit_* · 1単位 · 割引前; lines[].original_total_* · 割引前; lines[].total_* · 割引後.
- lines[].discount_* · 割引; manual_discount · 手動割引; percentage "10" = 10%.
- delivery.net / tax / gross · 割引後; delivery.original_* · 割引前; delivery.discount_* · 割引.
- tax_rate: "0.23" = 23%; "0" ≠ null. 不明: null、既知のゼロ: 0.
- totals · 合計; tax_breakdown.groups · 税グループ; 未配分の税額 = order.tax − Σ groups.tax; ±.
一覧は概要を返します。各結果に対して GET /api/v1/orders/{order_id} を取得し、完全な金額明細を出力します。GET の再試行回数は制限され、Retry-After に従います。作成日による出力は、その後の訂正を同期しません。
payment.amount は注文合計です。支払状態から支払済み額、返金額、未払額は確定できません。