店舗向け

商品管理(PIM)API

ビジネスアカウントの商品マスター(PIM)を管理します。商品の検索・作成・更新・部分更新・削除に対応。価格変更は連携中の Shopify 商品にも自動反映されます。スコープ: store.products.read / store.products.write


端點清單

方法 路徑 說明 回應
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

端點詳細資訊

商品名・SKU・JANの部分一致検索、カテゴリ・ブランドの完全一致フィルタに対応します。

完整路徑: GET /api/v1/products
回應碼: 200 403

スペック・価格・画像・バリエーションを含む商品詳細を返します。

完整路徑: GET /api/v1/products/{productId}
回應碼: 200 404

商品名は必須。その他の項目は任意です。

完整路徑: POST /api/v1/products
回應碼: 200 400

送信した内容で全項目を置き換えます。部分的な変更には PATCH を使用してください。

完整路徑: PUT /api/v1/products/{productId}
回應碼: 200 404

送信した項目だけ更新し、それ以外は保持します。価格だけ変えたい場合などに安全です。

完整路徑: PATCH /api/v1/products/{productId}
回應碼: 200 404

一覧から非表示になりますが、過去の POS 明細との関連は保持されます。

完整路徑: DELETE /api/v1/products/{productId}
回應碼: 204 404

請求範例

請求
PATCH /api/v1/products/{productId}
Authorization: Bearer {access_token}
Content-Type: application/json

{
  "basePrice": 1280
}
回應
{
  "id": "prd-001",
  "productName": "有機マンゴージュース",
  "sku": "MNG-001",
  "pricing": {
    "basePrice": 1280,
    "baseCostPrice": 640,
    "taxRate": 0.08
  },
  "status": "Active"
}
關於驗證

使用此 API 需要 Authorization: Bearer {access_token} 標頭。取得權杖的方式請參閱驗證指南。

查看驗證與存取 API