商品SKU紐づけ一覧取得

GET

/products_sku_sets

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-oms/products_sku_sets?limit=100&page=1&fields=productClassId%2CproductId&product_class_id=1%2C2&product_id=1%2C2&product_sku_code=test_sku_code_1%2Ctest_sku_code_2&sort=productClassId';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-oms/products_sku_sets?limit=100&page=1&fields=productClassId%2CproductId&product_class_id=1%2C2&product_id=1%2C2&product_sku_code=test_sku_code_1%2Ctest_sku_code_2&sort=productClassId' \
  --header 'Authorization: Bearer <token>'

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

Authorizations

AppAccessToken
ec-oms.products-sku-sets:read

Parameters

Query Parameters

limit

integer

default: 100 >= 1 <= 1000

取得件数

page

integer

default: 1 >= 1

ページ

fields

Array<string>

>= 1 items unique items

Allowed values: productClassId productId productSkuCode quantity optionCond

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

Example

?fields=productClassId,productId

product_class_id

Array<string>

>= 1 items unique items

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

完全一致で判定します（部分一致は不可）。
カンマ区切りで複数指定した場合はOR条件として扱います（例: A,B はAまたはBに一致するレコードを返却します）。
空文字を指定した場合や、カンマ区切り内に空要素を含む場合（例: A,,B）は400エラーを返却します。
パラメータを省略した場合は絞り込みを行いません。

Example

?product_class_id=1,2

product_id

Array<string>

>= 1 items unique items

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

完全一致で判定します（部分一致は不可）。
カンマ区切りで複数指定した場合はOR条件として扱います（例: A,B はAまたはBに一致するレコードを返却します）。
空文字を指定した場合や、カンマ区切り内に空要素を含む場合（例: A,,B）は400エラーを返却します。
パラメータを省略した場合は絞り込みを行いません。

Example

?product_id=1,2

product_sku_code

Array<string>

>= 1 items unique items

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

完全一致で判定します（部分一致は不可）。
カンマ区切りで複数指定した場合はOR条件として扱います（例: A,B はAまたはBに一致するレコードを返却します）。
空文字を指定した場合や、カンマ区切り内に空要素を含む場合（例: A,,B）は400エラーを返却します。
パラメータを省略した場合は絞り込みを行いません。

Example

?product_sku_code=test_sku_code_1,test_sku_code_2

sort

string

default: productClassId

Allowed values: productClassId productClassId:desc

ソート

productClassId: 商品規格ID

Example

productClassId

Responses

200

取得成功

application/json

Array<object>

object

productClassId

商品規格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

default

[
  {
    "productClassId": "1",
    "productId": "1",
    "productSkuCode": "pf_api_test_product",
    "quantity": "10",
    "optionCond": "テスト"
  }
]

Headers

Link

string

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

400

limitが範囲外の場合
pageが範囲外の場合

application/json

object

type

required

string

title

required

string

detail

One of:

string
Array<string>

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "BadRequest",
  "detail": "limitは1〜1000の範囲で入力してください",
  "status": 400
}

{
  "type": "about:blank",
  "title": "BadRequest",
  "detail": "pageは1以上で入力してください",
  "status": 400
}

500

サーバー内部エラー

application/json

object

type

required

string

title

required

string

detail

One of:

string
Array<string>

string

status

integer

Examples

default

{
  "type": "about:blank",
  "title": "InternalServerError",
  "status": 500
}