店舗向け
販売管理（OMS）API
受注のライフサイクル（確定→処理→発送→配達）を管理します。POSとの取引連携、配送業者・追跡番号付きの発送登録に対応。スコープ: store.orders.read / store.orders.write
api/v1/orders
APIリファレンスで確認
エンドポイント一覧
| メソッド | パス | 説明 | レスポンス |
|---|---|---|---|
| GET |
/api/v1/orders/
|
注文一覧・検索
ステータス（Pending/Confirmed/Processing/Shipped/Delivered/Cancelled/Refunded）、チャネル、支払いステータスで絞り込みできます。
|
200 403 |
| GET |
/api/v1/orders/{orderId}
|
注文詳細を取得
明細・顧客情報・支払い・配送情報を含む注文詳細を返します。
|
200 404 |
| POST |
/api/v1/orders/
|
注文を作成
新規注文を登録します。
|
200 400 |
| PUT |
/api/v1/orders/{orderId}
|
注文を更新
注文内容を更新します。
|
200 404 |
| POST |
/api/v1/orders/{orderId}/confirm
|
注文を確定
Pending → Confirmed に遷移します。
|
200 404 |
| POST |
/api/v1/orders/{orderId}/process
|
処理中に変更
Confirmed → Processing に遷移します。
|
200 404 |
| POST |
/api/v1/orders/{orderId}/cancel
|
注文をキャンセル
注文をキャンセルします。
|
200 404 |
| POST |
/api/v1/orders/{orderId}/ship
|
発送登録（配送業者＋追跡番号）
出荷を作成し発送済みにします。1回の呼び出しで完結します。
|
200 404 |
| POST |
/api/v1/orders/{orderId}/fulfill-via-pos
|
POS取引で完了
店頭受け取りなど、POS取引と紐付けて注文を完了します。
|
200 404 |
| DELETE |
/api/v1/orders/{orderId}
|
注文を削除
注文を削除します。
|
204 404 |
エンドポイント詳細
ステータス（Pending/Confirmed/Processing/Shipped/Delivered/Cancelled/Refunded）、チャネル、支払いステータスで絞り込みできます。
完全パス：
GET /api/v1/orders/
レスポンスコード：
200
403
明細・顧客情報・支払い・配送情報を含む注文詳細を返します。
完全パス：
GET /api/v1/orders/{orderId}
レスポンスコード：
200
404
新規注文を登録します。
完全パス：
POST /api/v1/orders/
レスポンスコード：
200
400
注文内容を更新します。
完全パス：
PUT /api/v1/orders/{orderId}
レスポンスコード：
200
404
Pending → Confirmed に遷移します。
完全パス：
POST /api/v1/orders/{orderId}/confirm
レスポンスコード：
200
404
Confirmed → Processing に遷移します。
完全パス：
POST /api/v1/orders/{orderId}/process
レスポンスコード：
200
404
注文をキャンセルします。
完全パス：
POST /api/v1/orders/{orderId}/cancel
レスポンスコード：
200
404
出荷を作成し発送済みにします。1回の呼び出しで完結します。
完全パス：
POST /api/v1/orders/{orderId}/ship
レスポンスコード：
200
404
店頭受け取りなど、POS取引と紐付けて注文を完了します。
完全パス：
POST /api/v1/orders/{orderId}/fulfill-via-pos
レスポンスコード：
200
404
注文を削除します。
完全パス：
DELETE /api/v1/orders/{orderId}
レスポンスコード：
204
404
リクエスト例
リクエスト
POST /api/v1/orders/{orderId}/ship
Authorization: Bearer {access_token}
Content-Type: application/json
{
"carrier": "ヤマト運輸",
"trackingNumber": "1234-5678-9012"
}
レスポンス
{
"order": {
"id": "ord-001",
"status": "Shipped"
},
"shipment": {
"id": "shp-001",
"carrier": "ヤマト運輸",
"trackingNumber": "1234-5678-9012"
}
}
認証について
このAPIを利用するには、Authorization: Bearer {access_token} ヘッダーが必要です。
トークンの取得方法は認証ガイドをご確認ください。