EC運営者向け
リテールEC連携API
店舗とECの在庫・注文・顧客データを統合し、オムニチャネル販売を実現します。商品・注文・チャネル・在庫の4つのサブAPIで構成されています。
api/v1/store/ecommerce
APIリファレンスで確認
エンドポイント一覧
| メソッド | パス | 説明 | レスポンス |
|---|---|---|---|
| GET |
/api/v1/store/ecommerce/products/{id}
|
EC商品詳細を取得
ECカタログの商品詳細を取得します。
|
200 404 |
| GET |
/api/v1/store/ecommerce/products/search
|
EC商品を検索
キーワード、SKU、カテゴリでEC商品を検索します。
|
200 |
| POST |
/api/v1/store/ecommerce/products
|
EC商品を作成・更新（Upsert）
ECプラットフォームに商品を登録・更新します。
|
200 |
| GET |
/api/v1/store/ecommerce/orders/{id}
|
EC注文詳細を取得
購入商品、顧客情報、フルフィルメントステータスを含む注文詳細を取得します。
|
200 404 |
| GET |
/api/v1/store/ecommerce/orders/search
|
EC注文を検索
日付範囲、ステータス、チャネルで注文を検索します。
|
200 |
| POST |
/api/v1/store/ecommerce/orders
|
EC注文を作成・更新
ECシステムに注文を登録・更新します。
|
200 |
| PATCH |
/api/v1/store/ecommerce/orders/{id}/status
|
注文ステータスを更新
注文ステータス（支払済、発送済、キャンセルなど）を更新します。
|
200 404 |
| POST |
/api/v1/store/ecommerce/orders/{id}/fulfill
|
注文を発送済みにする
配送業者、追跡番号、発送日を含むフルフィルメント情報を更新します。
|
200 404 |
| GET |
/api/v1/store/ecommerce/channels
|
ECチャネル一覧
接続済みのECプラットフォームと連携ステータスを一覧表示します。
|
200 |
| GET |
/api/v1/store/ecommerce/inventory/{productId}
|
商品の在庫状況を取得
オンライン・オフライン チャネルの在庫数をリアルタイムで返します。
|
200 404 |
| POST |
/api/v1/store/ecommerce/inventory/sync
|
在庫一括同期
接続済みECプラットフォームとの一括在庫同期を実行します。
|
200 |
エンドポイント詳細
ECカタログの商品詳細を取得します。
完全パス：
GET /api/v1/store/ecommerce/products/{id}
レスポンスコード：
200
404
キーワード、SKU、カテゴリでEC商品を検索します。
完全パス：
GET /api/v1/store/ecommerce/products/search
レスポンスコード：
200
ECプラットフォームに商品を登録・更新します。
完全パス：
POST /api/v1/store/ecommerce/products
レスポンスコード：
200
購入商品、顧客情報、フルフィルメントステータスを含む注文詳細を取得します。
完全パス：
GET /api/v1/store/ecommerce/orders/{id}
レスポンスコード：
200
404
日付範囲、ステータス、チャネルで注文を検索します。
完全パス：
GET /api/v1/store/ecommerce/orders/search
レスポンスコード：
200
ECシステムに注文を登録・更新します。
完全パス：
POST /api/v1/store/ecommerce/orders
レスポンスコード：
200
注文ステータス（支払済、発送済、キャンセルなど）を更新します。
完全パス：
PATCH /api/v1/store/ecommerce/orders/{id}/status
レスポンスコード：
200
404
配送業者、追跡番号、発送日を含むフルフィルメント情報を更新します。
完全パス：
POST /api/v1/store/ecommerce/orders/{id}/fulfill
レスポンスコード：
200
404
接続済みのECプラットフォームと連携ステータスを一覧表示します。
完全パス：
GET /api/v1/store/ecommerce/channels
レスポンスコード：
200
オンライン・オフライン チャネルの在庫数をリアルタイムで返します。
完全パス：
GET /api/v1/store/ecommerce/inventory/{productId}
レスポンスコード：
200
404
接続済みECプラットフォームとの一括在庫同期を実行します。
完全パス：
POST /api/v1/store/ecommerce/inventory/sync
レスポンスコード：
200
リクエスト例
リクエスト
GET /api/v1/store/ecommerce/orders/search?status=paid&from=2025-03-01
Authorization: Bearer {access_token}
レスポンス
{
"results": [
{
"id": "ord-001",
"customerName": "佐藤 花子",
"total": 4500,
"status": "paid",
"channel": "Shopify",
"orderedAt": "2025-03-15T14:30:00Z"
}
]
}
認証について
このAPIを利用するには、Authorization: Bearer {access_token} ヘッダーが必要です。
トークンの取得方法は認証ガイドをご確認ください。