コンテンツにスキップ
スマレジ・プラットフォームAPI リファレンス

店舗別商品SKU紐づけ一覧取得

GET
/products_shop_sku_sets
curl --request GET \
  --url 'https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-oms/products_shop_sku_sets?limit=100&page=1&fields=productClassId%2CshopId%2Cquantity&product_class_id=3001%2C3002&shop_id=10%2C11&product_id=1001%2C1002&product_sku_code=SKU-001%2CSKU-002&sort=productClassId%3Adesc' \
  --header 'Authorization: Bearer <token>'

店舗別商品SKU紐づけの一覧を取得します。

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
integer
default: 100 >= 1 <= 1000

取得件数

page
integer
default: 1 >= 1

ページ

fields
Array<string>
>= 1 items unique items
Allowed values: productClassId shopId productId productSkuCode quantity optionCond

取得するフィールドをカンマ区切りで指定します。 指定がない場合すべてのフィールドを取得します。

Example
?fields=productClassId,shopId,quantity
product_class_id
Array<string>
>= 1 items unique items

店舗別商品規格IDで絞り込みを行います。

  • 完全一致で判定します（部分一致は不可）。
  • カンマ区切りで複数指定した場合はOR条件として扱います（例: 3001,3002）。
  • 空文字を指定した場合や、カンマ区切り内に空要素を含む場合（例: 3001,,3002）は400エラーを返却します。
  • パラメータを省略した場合は絞り込みを行いません。
Example
?product_class_id=3001,3002
shop_id
Array<string>
>= 1 items unique items

店舗IDで絞り込みを行います。

  • 完全一致で判定します（部分一致は不可）。
  • カンマ区切りで複数指定した場合はOR条件として扱います（例: 10,11）。
  • 空文字を指定した場合や、カンマ区切り内に空要素を含む場合（例: 10,,11）は400エラーを返却します。
  • パラメータを省略した場合は絞り込みを行いません。
Example
?shop_id=10,11
product_id
Array<string>
>= 1 items unique items

商品IDで絞り込みを行います。

  • 完全一致で判定します（部分一致は不可）。
  • カンマ区切りで複数指定した場合はOR条件として扱います（例: 1001,1002）。
  • 空文字を指定した場合や、カンマ区切り内に空要素を含む場合（例: 1001,,1002）は400エラーを返却します。
  • パラメータを省略した場合は絞り込みを行いません。
Example
?product_id=1001,1002
product_sku_code
Array<string>
>= 1 items unique items

商品SKUコードで絞り込みを行います。

  • 完全一致で判定します（部分一致は不可）。
  • カンマ区切りで複数指定した場合はOR条件として扱います（例: SKU-001,SKU-002）。
  • 空文字を指定した場合や、カンマ区切り内に空要素を含む場合（例: SKU-001,,SKU-002）は400エラーを返却します。
  • パラメータを省略した場合は絞り込みを行いません。
Example
?product_sku_code=SKU-001,SKU-002
sort
string
default: productClassId:desc
Allowed values: productClassId productClassId:desc

ソート

  • productClassId: 店舗別商品規格ID
Example
productClassId:desc

Responses

Section titled “Responses”

200

Section titled “200”

取得成功

Media typeapplication/json
Array<object>
object
productClassId

店舗別商品規格ID

string
>= 1 characters <= 9 characters
shopId

店舗ID

string
>= 1 characters <= 9 characters
productId

商品ID

string
>= 1 characters <= 9 characters
productSkuCode

商品SKUコード

string
>= 1 characters <= 50 characters
quantity

数量

string
>= 1 characters <= 9 characters
optionCond

引き当て条件

string
nullable 0 <= 3000 characters
Examples
Exampledefault
[
  {
    "productClassId": "3001",
    "shopId": "10",
    "productId": "1001",
    "productSkuCode": "SKU-001",
    "quantity": "2",
    "optionCond": "定期購入のみ"
  },
  {
    "productClassId": "3002",
    "shopId": "10",
    "productId": "1001",
    "productSkuCode": "SKU-002",
    "quantity": "1",
    "optionCond": null
  }
]

Headers

Section titled “Headers”
Link
string

<前ページURI>; rel="prev", <次ページURI>; rel="next"

400

Section titled “400”
  • limitが範囲外の場合
  • pageが範囲外の場合
  • fieldsに指定外の値が設定されている場合
  • sortに指定外の値が設定されている場合
  • クエリパラメータに空の値を指定した場合
Media typeapplication/json
object
type
required
string
title
required
string
detail
One of:
string
status
integer
Examples
{
  "type": "about:blank",
  "title": "BadRequest",
  "detail": "limitは1〜1000の範囲で入力してください",
  "status": 400
}

500

Section titled “500”

サーバー内部エラー

Media typeapplication/json
object
type
required
string
title
required
string
detail
One of:
string
status
integer
Examples
Exampledefault
{
  "type": "about:blank",
  "title": "InternalServerError",
  "status": 500
}