店舗向け
商品管理（PIM）API
ビジネスアカウントの商品マスター（PIM）を管理します。商品の検索・作成・更新・部分更新・削除に対応。価格変更は連携中の Shopify 商品にも自動反映されます。スコープ: store.products.read / store.products.write
api/v1/products
View in API Reference
Endpoints
| Method | Path | Description | Response |
|---|---|---|---|
| GET |
/api/v1/products/
|
商品一覧・検索
商品名・SKU・JANの部分一致検索、カテゴリ・ブランドの完全一致フィルタに対応します。
|
200 403 |
| GET |
/api/v1/products/{productId}
|
商品詳細を取得
スペック・価格・画像・バリエーションを含む商品詳細を返します。
|
200 404 |
| POST |
/api/v1/products/
|
商品を作成
商品名は必須。その他の項目は任意です。
|
200 400 |
| PUT |
/api/v1/products/{productId}
|
商品を更新（全置換）
送信した内容で全項目を置き換えます。部分的な変更には PATCH を使用してください。
|
200 404 |
| PATCH |
/api/v1/products/{productId}
|
商品を部分更新
送信した項目だけ更新し、それ以外は保持します。価格だけ変えたい場合などに安全です。
|
200 404 |
| DELETE |
/api/v1/products/{productId}
|
商品を削除（ソフト）
一覧から非表示になりますが、過去の POS 明細との関連は保持されます。
|
204 404 |
Endpoint details
商品名・SKU・JANの部分一致検索、カテゴリ・ブランドの完全一致フィルタに対応します。
Full path:
GET /api/v1/products/
Response codes:
200
403
スペック・価格・画像・バリエーションを含む商品詳細を返します。
Full path:
GET /api/v1/products/{productId}
Response codes:
200
404
商品名は必須。その他の項目は任意です。
Full path:
POST /api/v1/products/
Response codes:
200
400
送信した内容で全項目を置き換えます。部分的な変更には PATCH を使用してください。
Full path:
PUT /api/v1/products/{productId}
Response codes:
200
404
送信した項目だけ更新し、それ以外は保持します。価格だけ変えたい場合などに安全です。
Full path:
PATCH /api/v1/products/{productId}
Response codes:
200
404
一覧から非表示になりますが、過去の POS 明細との関連は保持されます。
Full path:
DELETE /api/v1/products/{productId}
Response codes:
204
404
Example request
Request
PATCH /api/v1/products/{productId}
Authorization: Bearer {access_token}
Content-Type: application/json
{
"basePrice": 1280
}
Response
{
"id": "prd-001",
"productName": "有機マンゴージュース",
"sku": "MNG-001",
"pricing": {
"basePrice": 1280,
"baseCostPrice": 640,
"taxRate": 0.08
},
"status": "Active"
}
About authentication
To use this API, the Authorization: Bearer {access_token} header is required. See the authentication guide for how to obtain a token.