コンテンツにスキップ

商品登録

POST
/products
curl --request POST \
--url https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-oms/products \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "commonCode": "pfapi_test_product_test", "commonProductCode": "pfapi_test_product_test", "name": "プラットフォームAPIテスト商品_test", "taxFlag": 1, "status": 1, "zaikoType": 2, "inventoryType": 2, "inventoryDisp": 10, "taxRate": 10, "rcatalogId": "01024", "name1": "PFAPIテスト商品", "name2": "プラットフォームAPIテスト商品", "delivKbn": 1, "restoreInventoryFlag": 1, "backorderFlag": 1, "normalDelvdateId": 1, "backorderDelvdateId": 1, "productsClass": { "price02": 1000, "productTypeId": 1, "stockUpdateFlg": 2, "stockUpdateValue": 100, "rcatalogId": "010245", "delvdateChk": 1, "restoreInventoryFlag": 1, "backorderFlag": 1, "normalDelvdateId": 2, "backorderDelvdateId": 2, "posProductId": 999, "class": [ { "name": "サイズ", "classType": 1, "classcategory": [ { "name": "S", "rakutenSubcode": "-s" }, { "name": "M", "rakutenSubcode": "-m" }, { "name": "L", "rakutenSubcode": "-l" } ] }, { "name": "カラー", "classType": 2, "classcategory": [ { "name": "青", "rakutenSubcode": "-b" }, { "name": "赤", "rakutenSubcode": "-r" }, { "name": "緑", "rakutenSubcode": "-g" } ] } ] }, "productsClassShop": [ { "shopId": 1, "productTypeId": 1, "rcatalogId": "4900000000001", "classShop": [ { "name": "サイズ", "classType": 1, "classcategoryShop": [ { "name": "S", "rakutenSubcode": "-s" }, { "name": "M", "rakutenSubcode": "-m" } ] }, { "name": "カラー", "classType": 2, "classcategoryShop": [ { "name": "青", "rakutenSubcode": "-b" }, { "name": "赤", "rakutenSubcode": "-r" } ] } ] }, { "shopId": 2, "productTypeId": 1, "rcatalogId": "4900000000002", "classShop": [ { "name": "サイズ", "classType": 1, "classcategoryShop": [ { "name": "S" }, { "name": "M" } ] } ] } ], "productsSpecialShop": [ { "shopId": 1, "productCode": "testProductCode", "code": "testCode", "orgExpFlg": 1, "productType": 1 }, { "shopId": 2, "orgExpFlg": 1, "productType": 0 } ] }'

商品を登録します。

Media typeapplication/json
Product
object
commonCode
required

商品管理番号
※ユニークでなければエラーになります。

string
>= 1 characters <= 32 characters
commonProductCode
required

商品番号

string
>= 1 characters <= 200 characters
name
required

商品名

string
>= 1 characters <= 255 characters
taxFlag
required

消費税

integer
<= 999999999
status
required

倉庫指定

  • 1: 販売中
  • 2: 倉庫
integer
Allowed values: 1 2
zaikoType
required

在庫タイプ

integer
<= 999999999
nokori

在庫表示設定(通常在庫)
※在庫タイプに1:通常在庫を設定している場合は必須

  • 0: 残り在庫を表示しない
  • 1: 残り在庫を表示する
  • 2: 在庫がn以下になったら「残りあとわずか」を表示する
integer
Allowed values: 0 1 2
nokoriDisp

残り表示閾値(通常在庫)
※在庫表示設定(通常在庫)に2:在庫がn以下になったら「残りあとわずか」を表示するを設定している場合は必須

integer
<= 20
inventoryType

在庫表示設定(項目選択肢別在庫)
※在庫タイプに2:項目選択肢別在庫を設定している場合は必須

  • 1: 残り在庫を表示する
  • 2: 残り在庫を表示しない
  • 3: 在庫がn以下になったら「△」の印を表示する
integer
Allowed values: 1 2 3
inventoryDisp

残り表示閾値(項目選択肢別在庫)
※在庫表示設定(項目選択肢別在庫)に3:在庫がn以下になったら「△」の印を表示するを設定している場合は必須

integer
<= 20
taxRate

消費税率

integer
<= 999
rcatalogId

JANコード

string
0 <= 50 characters
name1

商品略称(内部用)

string
0 <= 255 characters
name2

商品略称(お客様用)

string
0 <= 255 characters
delivKbn

配送温度区分

integer
<= 999999999
restoreInventoryFlag

在庫戻し設定

  • 0: 注文キャンセル時に在庫を戻さない
  • 1: 注文キャンセル時に在庫を戻す(増やす)
integer
Allowed values: 0 1
backorderFlag

在庫切れ時の注文

  • 0: 在庫切れになったら注文を受け付けない
  • 1: 在庫切れになっても注文を受け付ける
integer
Allowed values: 0 1
normalDelvdateId

在庫あり時の納期

integer
<= 999999999
backorderDelvdateId

在庫切れ時の納期

integer
<= 999999999
productsClass
required
object
price02
required

販売価格

integer
>= -9999999 <= 99999999
productTypeId
required

商品種別

  • 1: 通常商品
  • 3: 予約商品
integer
Allowed values: 1 3
stockUpdateFlg
required

在庫連携指定

  • 0: 連携しない
  • 1: 有効在庫
  • 2: 指定値
  • 3: 比率(%)
integer
Allowed values: 0 1 2 3
stockUpdateValue

在庫指定値
※在庫連携指定に2:指定値、3: 比率(%)を設定している場合は必須

integer
<= 99999999
rcatalogId

JANコード

string
0 <= 50 characters
delvdateChk

在庫納期情報個別設定

  • 0: 在庫を個別で設定しない
  • 1: 在庫を個別で設定
integer
Allowed values: 0 1
restoreInventoryFlag

在庫戻し設定

  • 0: 注文キャンセル時に在庫を戻さない
  • 1: 注文キャンセル時に在庫を戻す(増やす)
integer
Allowed values: 0 1
backorderFlag

在庫切れ時の注文

  • 0: 在庫切れになったら注文を受け付けない
  • 1: 在庫切れになっても注文を受け付ける
integer
Allowed values: 0 1
normalDelvdateId

在庫あり時の納期管理番号

integer
<= 999999999
backorderDelvdateId

在庫切れ時の納期管理番号

integer
<= 999999999
posProductId

スマレジ商品ID

integer
<= 999999999
class

※在庫タイプに2:項目選択肢別在庫を設定している場合は必須

Array<object>
object
name
required

規格名

string
>= 1 characters <= 50 characters
classType
required

規格軸

  • 1: 横軸(規格1)
  • 2: 縦軸(規格2)
integer
Allowed values: 1 2
classcategory
required
Array<object>
<= 20 items
object
name
required

規格名詳細

string
>= 1 characters <= 50 characters
rakutenSubcode

枝番

string
<= 32 characters
productsClassShop
required
Array<object>
object
shopId
required

店舗ID

integer
<= 999999999
productTypeId
required

商品種別

  • 1: 通常商品
  • 3: 予約商品
integer
Allowed values: 1 3
rcatalogId

JANコード

string
0 <= 50 characters
classShop

※在庫タイプに2:項目選択肢別在庫を設定している場合は必須

Array<object>
>= 1 items <= 6 items
object
name
required

店舗別規格名

string
>= 1 characters <= 50 characters
classType
required

店舗別規格軸

  • 楽天以外: 1, 2
  • 楽天: 16
integer
>= 1 <= 6
classcategoryShop
required

店舗別規格値

Array<object>
>= 1 items <= 20 items
object
name
required

店舗別規格値名

string
>= 1 characters <= 50 characters
rakutenSubcode

店舗別規格枝番

string
0 <= 32 characters
productsSpecialShop
required
Array<object>
object
shopId
required

店舗ID

integer
<= 999999999
productCode

商品コード

string
0 <= 200 characters
code

商品管理番号

string
0 <= 32 characters
orgExpFlg
required

モール反映フラグ

  • 0: なし
  • 1: あり
integer
Allowed values: 0 1
productType

商品タイプ ※一部の店舗にのみ設定されます

  • 0: 通常
  • 1: MOVE商品
integer
Allowed values: 0 1
Example
{
"commonCode": "pfapi_test_product_test",
"commonProductCode": "pfapi_test_product_test",
"name": "プラットフォームAPIテスト商品_test",
"taxFlag": 1,
"status": 1,
"zaikoType": 2,
"inventoryType": 2,
"inventoryDisp": 10,
"taxRate": 10,
"rcatalogId": "01024",
"name1": "PFAPIテスト商品",
"name2": "プラットフォームAPIテスト商品",
"delivKbn": 1,
"restoreInventoryFlag": 1,
"backorderFlag": 1,
"normalDelvdateId": 1,
"backorderDelvdateId": 1,
"productsClass": {
"price02": 1000,
"productTypeId": 1,
"stockUpdateFlg": 2,
"stockUpdateValue": 100,
"rcatalogId": "010245",
"delvdateChk": 1,
"restoreInventoryFlag": 1,
"backorderFlag": 1,
"normalDelvdateId": 2,
"backorderDelvdateId": 2,
"posProductId": 999,
"class": [
{
"name": "サイズ",
"classType": 1,
"classcategory": [
{
"name": "S",
"rakutenSubcode": "-s"
},
{
"name": "M",
"rakutenSubcode": "-m"
},
{
"name": "L",
"rakutenSubcode": "-l"
}
]
},
{
"name": "カラー",
"classType": 2,
"classcategory": [
{
"name": "",
"rakutenSubcode": "-b"
},
{
"name": "",
"rakutenSubcode": "-r"
},
{
"name": "",
"rakutenSubcode": "-g"
}
]
}
]
},
"productsClassShop": [
{
"shopId": 1,
"productTypeId": 1,
"rcatalogId": "4900000000001",
"classShop": [
{
"name": "サイズ",
"classType": 1,
"classcategoryShop": [
{
"name": "S",
"rakutenSubcode": "-s"
},
{
"name": "M",
"rakutenSubcode": "-m"
}
]
},
{
"name": "カラー",
"classType": 2,
"classcategoryShop": [
{
"name": "",
"rakutenSubcode": "-b"
},
{
"name": "",
"rakutenSubcode": "-r"
}
]
}
]
},
{
"shopId": 2,
"productTypeId": 1,
"rcatalogId": "4900000000002",
"classShop": [
{
"name": "サイズ",
"classType": 1,
"classcategoryShop": [
{
"name": "S"
},
{
"name": "M"
}
]
}
]
}
],
"productsSpecialShop": [
{
"shopId": 1,
"productCode": "testProductCode",
"code": "testCode",
"orgExpFlg": 1,
"productType": 1
},
{
"shopId": 2,
"orgExpFlg": 1,
"productType": 0
}
]
}

登録成功

Media typeapplication/json
Product
object
productId

商品ID

string
>= 1 characters <= 9 characters
commonCode

商品管理番号

string
>= 1 characters <= 32 characters
commonProductCode

商品番号

string
>= 1 characters <= 200 characters
name

商品名

string
>= 1 characters <= 255 characters
taxFlag

消費税

string
>= 1 characters <= 1 characters
status

倉庫指定

string
>= 1 characters <= 1 characters
zaikoType

在庫タイプ

string
>= 1 characters <= 9 characters
inventoryType

在庫表示設定(項目選択肢別在庫)

string
nullable <= 1 characters
inventoryDisp

残り表示閾値(項目選択肢別在庫)

string
nullable <= 2 characters
taxRate

消費税率

string
nullable <= 3 characters
rcatalogId

JANコード

string
nullable <= 50 characters
name1

商品略称(内部用)

string
nullable <= 255 characters
name2

商品略称(お客様用)

string
nullable <= 255 characters
delivKbn

配送温度区分

string
nullable <= 9 characters
restoreInventoryFlag

在庫戻し設定

string
nullable <= 1 characters
backorderFlag

在庫切れ時の注文

string
nullable <= 1 characters
normalDelvdateId

在庫あり時の納期

string
nullable <= 9 characters
backorderDelvdateId

在庫切れ時の納期

string
nullable <= 9 characters
class

規格情報

Array<object>
object
classId

規格ID

string
>= 1 characters <= 9 characters
name

規格名

string
>= 1 characters <= 50 characters
classType

規格軸

  • 1: 横軸(規格1)
  • 2: 縦軸(規格2)
string
>= 1 characters <= 1 characters
Allowed values: 1 2
classcategory
Array<object>
object
classcategoryId

規格詳細ID

string
>= 1 characters <= 9 characters
name

規格名詳細

string
>= 1 characters <= 50 characters
subcode

枝番

string
nullable <= 32 characters
productsClass
Array<object>
object
productClassId

商品クラスID

string
>= 1 characters <= 9 characters
productId

商品ID

string
>= 1 characters <= 9 characters
classcategoryId1

商品規格ID(横軸)

string
nullable <= 9 characters
classcategoryId2

商品規格ID(縦軸)

string
nullable <= 9 characters
productCode

商品番号

string
0 <= 200 characters
price02

販売価格

string
>= 1 characters <= 9 characters
productTypeId

商品種別

string
>= 1 characters <= 1 characters
stockUpdateFlg

在庫連携指定

string
>= 1 characters <= 1 characters
stockUpdateValue

在庫指定値

string
nullable <= 9 characters
rcatalogId

JANコード

string
nullable <= 50 characters
delvdateChk

在庫納期情報個別設定

string
nullable <= 1 characters
restoreInventoryFlag

在庫戻し設定

string
nullable <= 1 characters
backorderFlag

在庫切れ時の注文

string
nullable <= 1 characters
normalDelvdateId

在庫あり時の納期管理番号

string
nullable <= 9 characters
backorderDelvdateId

在庫切れ時の納期管理番号

string
nullable <= 9 characters
smaregiProductId

スマレジ商品ID

string
nullable <= 9 characters
classShop

店舗別規格情報

Array<object>
object
classId

店舗別規格ID

string
shopId

店舗ID

string
productId

商品ID

string
name

店舗別規格名

string
classType

店舗別規格軸

  • 楽天以外: 1, 2
  • 楽天: 16
string
>= 1 characters <= 1 characters
Allowed values: 1 2 3 4 5 6
classcategoryShop
Array<object>
object
classcategoryId

店舗別規格詳細ID

string
shopId

店舗ID

string
classId

店舗別規格ID

string
productId

商品ID

string
name

店舗別規格詳細名

string
rakutenCode

商品コード

string
subcode

枝番

string
productsClassShop
Array<object>

店舗別商品規格です。各 classcategoryId1classcategoryId6 には、その行が使用する店舗別規格値IDを返し、使用していない規格軸は 0 を返します。
通常在庫商品の基準行では6項目すべてが 0 です。
商品一覧取得・商品取得では有効な行だけを返すため、項目選択肢別在庫の削除扱いの基準行は含みません。

object
productClassId

商品クラスID

string
>= 1 characters <= 9 characters
shopId

店舗ID

string
>= 1 characters <= 9 characters
productId

商品ID

string
>= 1 characters <= 9 characters
classcategoryId1

店舗別規格値ID1。未使用時は 0

string
>= 1 characters <= 9 characters
classcategoryId2

店舗別規格値ID2。未使用時は 0

string
>= 1 characters <= 9 characters
classcategoryId3

店舗別規格値ID3。未使用時は 0

string
>= 1 characters <= 9 characters
classcategoryId4

店舗別規格値ID4。未使用時は 0

string
>= 1 characters <= 9 characters
classcategoryId5

店舗別規格値ID5。未使用時は 0

string
>= 1 characters <= 9 characters
classcategoryId6

店舗別規格値ID6。未使用時は 0

string
>= 1 characters <= 9 characters
productCode

店舗別商品コード

string
nullable 0 <= 200 characters
productTypeId

商品種別

string
>= 1 characters <= 1 characters
rcatalogId

JANコード

string
nullable 0 <= 50 characters
productsSpecialShop
Array<object>

モール別個別設定情報です。 org[xxxx]...[xxxx] にはモール名(英名・先頭大文字)が入ります。 例: モールキーが rakuten の場合、orgRakutenProductCode となります。

object
productId

商品ID

string
>= 1 characters <= 9 characters
shopId

店舗ID

string
>= 1 characters <= 9 characters
org[xxxx]ProductCode

商品コード

string
0 <= 200 characters
org[xxxx]ProductCodeChk

商品コード設定。一部の店舗にのみ設定されます。

string
>= 1 characters <= 1 characters
org[xxxx]Code

商品管理番号

string
0 <= 32 characters
org[xxxx]ProductType

商品タイプ。一部の店舗にのみ設定されます。

string
>= 1 characters <= 1 characters
orgExpFlg

モール反映フラグ

string
>= 1 characters <= 1 characters
Examples
Exampledefault
{
"productId": "2277",
"commonCode": "pfapi_test_product_test33",
"commonProductCode": "pfapi_test_product_test_2",
"name": "プラットフォームAPIテスト商品_test33",
"taxFlag": "1",
"status": "1",
"zaikoType": "2",
"inventoryType": "2",
"inventoryDisp": "10",
"taxRate": "10",
"rcatalogId": "010245",
"name1": "PFAPIテスト商品",
"name2": "プラットフォームAPIテスト商品",
"delivKbn": "1",
"restoreInventoryFlag": "1",
"backorderFlag": "1",
"normalDelvdateId": "1",
"backorderDelvdateId": "1"
}
  • 指定された項目が不正な場合
  • productsClassが存在しない場合
  • productsClassがオブジェクトでない場合
  • productsClassShopが存在しない場合
  • productsClassShopが配列でない場合
  • productsSpecialShopが存在しない場合
  • productsSpecialShopが配列でない場合
  • 在庫タイプが2:項目選択肢別在庫でclassが存在しない場合
  • classが配列でない場合
  • 在庫タイプが2:項目選択肢別在庫でclasscategoryが存在しない場合
  • classcategoryが配列でない場合
  • 在庫タイプが2:項目選択肢別在庫でclassShopが存在しない場合
  • classShopが配列でない場合
  • 在庫タイプが2:項目選択肢別在庫でclasscategoryShopが存在しない場合
  • classcategoryShopが配列でない場合
  • 指定された店舗別規格軸が存在しない場合
  • 指定された商品タイプが存在しない場合
  • 指定された消費税が存在しない場合
  • 指定された在庫タイプが存在しない場合
  • 指定された配送温度区分が存在しない場合
  • 指定された在庫あり時の納期が存在しない場合
  • 指定された在庫切れ時の納期が存在しない場合
  • 指定された在庫あり時の納期管理番号が存在しない場合
  • 指定された在庫切れ時の納期管理番号が存在しない場合
  • 指定された店舗IDが存在しない場合
  • 規格値が上限を超える場合
  • 店舗別規格値が上限を超える場合
  • バリエーション数が上限を超える場合
  • productsClassShopにのみ存在するshopIdがある場合
  • productsSpecialShopにのみ存在するshopIdがある場合
Media typeapplication/json
object
type
required
string
title
required
string
detail
One of:
string
status
integer
Examples
{
"type": "about:blank",
"title": "BadRequest",
"detail": [
"指定された項目が不正です: invalidKey"
],
"status": 400
}
  • 指定された商品管理番号が重複している場合
  • 指定された規格名が重複している場合
  • 指定された規格名詳細が重複している場合
  • 指定された規格名枝番が重複している場合
  • 指定された店舗別規格名が重複している場合
  • 指定された店舗別規格軸が重複している場合
  • 指定された店舗別規格値名が重複している場合
  • 指定された店舗別規格枝番が重複している場合
Media typeapplication/json
object
type
required
string
title
required
string
detail
One of:
string
status
integer
Examples
{
"type": "about:blank",
"title": "Conflict",
"detail": "商品管理番号が重複しています",
"status": 409
}

サーバー内部エラー

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
}