商品SKU取得

GET

/products_sku/{product_sku_id}

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-oms/products_sku/example?fields=productSkuId%2CshipperId';
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/example?fields=productSkuId%2CshipperId' \
  --header 'Authorization: Bearer <token>'

商品SKUを取得します。

Authorizations

AppAccessToken
ec-oms.products-sku:read

Parameters

Path Parameters

product_sku_id

required

string

>= 1 characters

商品SKUID

Query Parameters

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

Responses

200

取得成功

application/json

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"
}

400

Fieldsに指定外の値が設定されている場合

application/json

object

type

required

string

title

required

string

detail

One of:

string
Array<string>

string

status

integer

Examples

fieldsに指定外の値が設定されている場合

{
  "type": "about:blank",
  "title": "BadRequest",
  "detail": "指定されたfields項目が不正です: {invalid_field}",
  "status": 400
}

404

指定されたIDのリソースが存在しない場合

application/json

object

type

required

string

title

required

string

detail

One of:

string
Array<string>

string

status

integer

Examples

指定したリソースが存在しない場合

{
  "type": "about:blank",
  "title": "NotFound",
  "detail": "指定されたIDのリソースが見つかりません",
  "status": 404
}

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
}