商品SKU一覧取得

GET

/products_sku

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-oms/products_sku?limit=100&page=1&fields=productSkuId%2CshipperId&product_sku_id=1%2C2&shipper=%E3%83%86%E3%82%B9%E3%83%88%E8%8D%B7%E4%B8%BB1%2C%E3%83%86%E3%82%B9%E3%83%88%E8%8D%B7%E4%B8%BB2&product_sku_code=test_sku_code_1%2Ctest_sku_code_2&jan_code=4900000000000%2C4900000000001&detail_kbn=1%2C2&product_sku_name=%E3%83%86%E3%82%B9%E3%83%88%E5%95%86%E5%93%811%2C%E3%83%86%E3%82%B9%E3%83%88%E5%95%86%E5%93%812&product_sku_name2=%E3%83%86%E3%82%B9%E3%83%88%E5%95%86%E5%93%811%EF%BC%88%E3%81%8A%E5%AE%A2%E6%A7%98%E7%94%A8%EF%BC%89%2C%E3%83%86%E3%82%B9%E3%83%88%E5%95%86%E5%93%812%EF%BC%88%E3%81%8A%E5%AE%A2%E6%A7%98%E7%94%A8%EF%BC%89&product_sku_kana=%E3%83%86%E3%82%B9%E3%83%88%E3%82%B7%E3%83%A7%E3%82%A6%E3%83%92%E3%83%B31%2C%E3%83%86%E3%82%B9%E3%83%88%E3%82%B7%E3%83%A7%E3%82%A6%E3%83%92%E3%83%B32&tax_flag=0%2C1&price01=1000%2C2000&price02=1200%2C2200&stock_price=800%2C900&cost_price=700%2C750&stock_flag=0%2C1&stock_reserve_flag=0%2C1&yuko_flag=0%2C1&product_print_flag=0%2C1&unit_name=1%2C2&stock_lot_unit=0%2C1&pos_product_id=12345%2C67890&sort=productSkuCode%3Adesc';
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?limit=100&page=1&fields=productSkuId%2CshipperId&product_sku_id=1%2C2&shipper=%E3%83%86%E3%82%B9%E3%83%88%E8%8D%B7%E4%B8%BB1%2C%E3%83%86%E3%82%B9%E3%83%88%E8%8D%B7%E4%B8%BB2&product_sku_code=test_sku_code_1%2Ctest_sku_code_2&jan_code=4900000000000%2C4900000000001&detail_kbn=1%2C2&product_sku_name=%E3%83%86%E3%82%B9%E3%83%88%E5%95%86%E5%93%811%2C%E3%83%86%E3%82%B9%E3%83%88%E5%95%86%E5%93%812&product_sku_name2=%E3%83%86%E3%82%B9%E3%83%88%E5%95%86%E5%93%811%EF%BC%88%E3%81%8A%E5%AE%A2%E6%A7%98%E7%94%A8%EF%BC%89%2C%E3%83%86%E3%82%B9%E3%83%88%E5%95%86%E5%93%812%EF%BC%88%E3%81%8A%E5%AE%A2%E6%A7%98%E7%94%A8%EF%BC%89&product_sku_kana=%E3%83%86%E3%82%B9%E3%83%88%E3%82%B7%E3%83%A7%E3%82%A6%E3%83%92%E3%83%B31%2C%E3%83%86%E3%82%B9%E3%83%88%E3%82%B7%E3%83%A7%E3%82%A6%E3%83%92%E3%83%B32&tax_flag=0%2C1&price01=1000%2C2000&price02=1200%2C2200&stock_price=800%2C900&cost_price=700%2C750&stock_flag=0%2C1&stock_reserve_flag=0%2C1&yuko_flag=0%2C1&product_print_flag=0%2C1&unit_name=1%2C2&stock_lot_unit=0%2C1&pos_product_id=12345%2C67890&sort=productSkuCode%3Adesc' \
  --header 'Authorization: Bearer <token>'

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

Authorizations

AppAccessToken
ec-oms.products-sku:read

Parameters

Query Parameters

limit

integer

default: 100 >= 1 <= 1000

取得件数

page

integer

default: 1 >= 1

ページ

fields

Array<string>

>= 1 items unique items

Allowed values: productSkuId shipperId shipper productSkuCode makerProductSkuCode janCode detailKbn productCategory productSkuName productSkuName2 productSkuKana taxFlag price01 price02 stockPrice costPrice stockFlag stockFlagJa stockReserveFlag stockReserveFlagJa yukoFlag yukoFlagJa productPrintFlag unitName unitNameJa stockQuantity stockQuantityLogical secureStock placingOrderPoint safetyStockPoint placingYoteiQuantity stockLotUnit memo posProductId

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

Example

?fields=productSkuId,shipperId

product_sku_id

Array<string>

>= 1 items unique items

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

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

Example

?product_sku_id=1,2

shipper

Array<string>

>= 1 items unique items

荷主（会社名）で絞り込みを行います。

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

Example

?shipper=%E3%83%86%E3%82%B9%E3%83%88%E8%8D%B7%E4%B8%BB1,%E3%83%86%E3%82%B9%E3%83%88%E8%8D%B7%E4%B8%BB2

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

jan_code

Array<string>

>= 1 items unique items

JANコードで絞り込みを行います。

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

Example

?jan_code=4900000000000,4900000000001

detail_kbn

Array<string>

>= 1 items unique items

商品SKU種別で絞り込みを行います。

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

Example

?detail_kbn=1,2

product_sku_name

Array<string>

>= 1 items unique items

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

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

Example

?product_sku_name=%E3%83%86%E3%82%B9%E3%83%88%E5%95%86%E5%93%811,%E3%83%86%E3%82%B9%E3%83%88%E5%95%86%E5%93%812

product_sku_name2

Array<string>

>= 1 items unique items

商品SKU名（お客様用）で絞り込みを行います。

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

Example

?product_sku_name2=%E3%83%86%E3%82%B9%E3%83%88%E5%95%86%E5%93%811%EF%BC%88%E3%81%8A%E5%AE%A2%E6%A7%98%E7%94%A8%EF%BC%89,%E3%83%86%E3%82%B9%E3%83%88%E5%95%86%E5%93%812%EF%BC%88%E3%81%8A%E5%AE%A2%E6%A7%98%E7%94%A8%EF%BC%89

product_sku_kana

Array<string>

>= 1 items unique items

商品SKU名カナで絞り込みを行います。

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

Example

?product_sku_kana=%E3%83%86%E3%82%B9%E3%83%88%E3%82%B7%E3%83%A7%E3%82%A6%E3%83%92%E3%83%B31,%E3%83%86%E3%82%B9%E3%83%88%E3%82%B7%E3%83%A7%E3%82%A6%E3%83%92%E3%83%B32

tax_flag

Array<string>

>= 1 items unique items

消費税（0：別、1:込）で絞り込みを行います。

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

Example

?tax_flag=0,1

price01

Array<string>

>= 1 items unique items

通常価格で絞り込みを行います。

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

Example

?price01=1000,2000

price02

Array<string>

>= 1 items unique items

販売価格で絞り込みを行います。

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

Example

?price02=1200,2200

stock_price

Array<string>

>= 1 items unique items

売上原価（税抜）で絞り込みを行います。

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

Example

?stock_price=800,900

cost_price

Array<string>

>= 1 items unique items

仕入価格（税抜）で絞り込みを行います。

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

Example

?cost_price=700,750

stock_flag

Array<string>

>= 1 items unique items

在庫管理対象で絞り込みを行います。

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

Example

?stock_flag=0,1

stock_reserve_flag

Array<string>

>= 1 items unique items

在庫引当区分で絞り込みを行います。

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

Example

?stock_reserve_flag=0,1

yuko_flag

Array<string>

>= 1 items unique items

有効フラグで絞り込みを行います。

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

Example

?yuko_flag=0,1

product_print_flag

Array<string>

>= 1 items unique items

伝票出力フラグ（0：出力しない、1:出力する）で絞り込みを行います。

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

Example

?product_print_flag=0,1

unit_name

Array<string>

>= 1 items unique items

単位コードで絞り込みを行います。

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

Example

?unit_name=1,2

stock_lot_unit

Array<string>

>= 1 items unique items

仕入単位（0:単品、1:ロット）で絞り込みを行います。

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

Example

?stock_lot_unit=0,1

pos_product_id

Array<string>

>= 1 items unique items

スマレジ商品IDで絞り込みを行います。

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

Example

?pos_product_id=12345,67890

sort

string

default: productSkuCode:desc

Allowed values: productSkuCode productSkuCode:desc

ソート

productSkuCode: 商品SKUコード

Example

productSkuCode:desc

Responses

200

取得成功

application/json

Array<object>

ProductSku

object

productSkuId

商品SKUID

string

>= 1 characters <= 9 characters

shipperId

荷主ID

string

>= 1 characters <= 9 characters

shipper

荷主会社名

string

nullable >= 1 characters <= 50 characters

productSkuCode

商品SKUコード

string

>= 1 characters <= 50 characters

makerProductSkuCode

メーカー品番

string

nullable 0 <= 50 characters

janCode

JANコード

string

nullable 0 <= 200 characters

detailKbn

商品SKU種別

string

>= 1 characters <= 9 characters

productCategory

商品SKU種別（和名）

string

nullable >= 1 characters <= 50 characters

productSkuName

商品SKU名

string

>= 1 characters <= 200 characters

productSkuName2

商品SKU名（お客様用）

string

>= 1 characters <= 200 characters

productSkuKana

商品SKU名カナ

string

nullable 0 <= 200 characters

taxFlag

消費税

string

>= 1 characters <= 1 characters

price01

通常価格（税抜・税込）

string

nullable >= 1 characters <= 9 characters

price02

販売価格（税抜・税込）

string

nullable >= 1 characters <= 9 characters

stockPrice

売上原価（税抜）

string

nullable >= 1 characters <= 9 characters

costPrice

仕入価格（税抜）

string

nullable >= 1 characters <= 9 characters

stockFlag

在庫管理対象

string

>= 1 characters <= 9 characters

stockFlagJa

在庫管理対象（和名）

string

nullable >= 1 characters <= 50 characters

stockReserveFlag

在庫引当区分

string

>= 1 characters <= 9 characters

stockReserveFlagJa

在庫引当区分（和名）

string

nullable >= 1 characters <= 50 characters

yukoFlag

有効フラグ

string

>= 1 characters <= 9 characters

yukoFlagJa

有効フラグ（和名）

string

nullable >= 1 characters <= 50 characters

productPrintFlag

伝票出力フラグ

string

>= 1 characters <= 1 characters

unitName

単位コード

string

>= 1 characters <= 9 characters

unitNameJa

単位（和名）

string

nullable >= 1 characters <= 50 characters

stockQuantity

実在庫

string

>= 1 characters <= 9 characters

stockQuantityLogical

有効在庫

string

>= 1 characters <= 9 characters

secureStock

確保在庫

string

>= 1 characters <= 9 characters

placingOrderPoint

発注点

string

nullable >= 1 characters <= 9 characters

safetyStockPoint

安全在庫量

string

nullable >= 1 characters <= 9 characters

placingYoteiQuantity

発注予定数

string

nullable >= 1 characters <= 9 characters

stockLotUnit

仕入単位

string

nullable >= 1 characters <= 9 characters

memo

備考

string

nullable 0 <= 3000 characters

posProductId

スマレジ商品ID

string

nullable >= 1 characters <= 9 characters

Examples

default

[
  {
    "productSkuId": "1",
    "shipperId": "1",
    "shipper": "荷主会社名",
    "productSkuCode": "pf_api_test_product",
    "makerProductSkuCode": "makerProductSkuCode",
    "janCode": "123",
    "detailKbn": "1",
    "productCategory": "通常商品",
    "productSkuName": "PFAPIテスト商品",
    "productSkuName2": "プラットフォームエーピーアイテスト商品",
    "productSkuKana": "PFAPIテストショウヒン",
    "taxFlag": "1",
    "price01": "800",
    "price02": "1000",
    "stockPrice": "800",
    "costPrice": "700",
    "stockFlag": "0",
    "stockFlagJa": "管理しない",
    "stockReserveFlag": "1",
    "stockReserveFlagJa": "即時",
    "yukoFlag": "1",
    "yukoFlagJa": "有効",
    "productPrintFlag": "0",
    "unitName": "1",
    "unitNameJa": "個",
    "stockQuantity": "30",
    "stockQuantityLogical": "20",
    "secureStock": "10",
    "placingOrderPoint": "5",
    "safetyStockPoint": "10",
    "placingYoteiQuantity": "10",
    "stockLotUnit": "1",
    "memo": "メモ",
    "posProductId": "1"
  }
]

Headers

Link

string

<前ページURI>; rel="prev", <次ページURI>; rel="next", <最初ページURI>; rel="start", <最終ページURI>; rel="last"

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
}