コンテンツにスキップ

店舗取扱商品一覧取得

GET
/stores/{store_id}/products

指定した店舗が取り扱っている商品一覧を取得します。

対象プラン

  • スタンダード
  • プレミアム
  • プレミアムプラス
  • フードビジネス
  • リテールビジネス
store_id
required
string

店舗ID

fields
array

検索パラメータ(カンマ区切りで指定可)
Response項目を指定可能
※一部項目(withで指定する項目、2階層目以降の項目)については指定不可

sort
string

並び順(カンマ区切りで指定可)

指定可能なパラメータ

  • productId:商品ID
  • categoryId:部門ID
  • productCode:商品コード
  • groupCode:グループコード
  • displaySequence:表示順
  • updDateTime:更新日時
limit
integer

上限数

page
integer

ページ

category_id
string

部門ID

product_code
string

商品コード

group_code
string

グループコード

display_flag
string

端末表示 (0:表示しない、1:表示する)

division
string

商品区分(0:通常、1:セット、2:オプション)

sales_division
string

売上区分(0:売上対象、1:売上対象外)

stock_control_division
string
Allowed values: 0 1

在庫管理区分:(0:在庫管理対象、1:在庫管理対象外)

supplier_product_no
string

品番

with_stores
string
default: none
Allowed values: all none

店舗情報を付加するか(付加する場合はall, しない場合はnone)
"all" を指定した場合、store_idに指定したIDの店舗情報を1件のみ取得します。

取得成功

Array<object>
object
productId

商品ID:数字15桁以内。

string
categoryId

部門ID:数字9桁以内。

string
productCode

商品コード:半角英数記号20文字以内。

string
productName

商品名:85文字以内。

string
productKana

商品カナ:全角カナ85文字以内。

string
taxDivision

税区分:商品価格の消費税の扱いに関する設定。 (0:内税、1:外税、2:非課税)

string
productPriceDivision

商品価格区分:商品をオープン価格販売するかどうか設定。未設定の場合1を設定。 (1:通常価格、2:オープン価格)

string
price

商品単価:数字8桁以内。販売価格を設定。

string
customerPrice

会員価格:数字8桁以内。会員価格を設定。

string
cost

原価:数字8桁以内(少数5桁まで)。未設定の場合0を設定。

string
attribute

規格:1000文字以内。商品のカラー・サイズなどを設定。

string
description

説明:1000文字以内。商品説明などを設定。

string
catchCopy

キャッチコピー:1000文字以内。商品のキャッチコピーなどを設定。

string
size

サイズ:85文字以内。

string
color

カラー:85文字以内。

string
tag

タグ:85文字以内。複数ある場合は、カンマで区切り。

string
groupCode

グループコード:関連商品として紐付ける為のグループコードを設定。 例えば、AとBの商品に同じグループコード001を設定すると、AとBは関連商品となります。サイズ、カラーが異なる場合などに使用してください。

string
url

URL:255文字以内。 スマレジ端末でWEBページを表示したい場合設定。

string
printReceiptProductName

レシート印字商品名:レシートに印字する商品名。64文字以内。

string
displaySequence

表示順:数字9桁以内。

string
salesDivision

売上区分:取引時に売上計上するか否かの設定。 (0:売上対象、1:売上対象外)

string
stockControlDivision

在庫管理区分:棚卸対象商品とするか否かの設定。 (0:在庫管理対象、1:在庫管理対象外)

string
displayFlag

端末表示:スマレジ端末に表示するか否かの判定。未設定の場合1を設定。 (0:表示しない、1:表示する)

string
division

商品区分:商品の種類を設定。未設定の場合0を設定。 (0:通常商品、1:回数券(*1)、2:オプション商品)

string
productOptionGroupId

オプショングループID:オプショングループの設定方法が「全店舗共通」の場合、適用可能なオプショングループがあればそのIDがこちらに設定されます。無ければnullが設定されます。

string
pointNotApplicable

ポイント対象:ポイント対象にするか否かの設定(0:ポイント対象、1:ポイント対象外)

string
taxFreeDivision

免税区分:免税区分の設定。未設定の場合0を設定。 (0:対象外、1:一般品、2:消耗品)
免税機能を利用しない場合は「対象外」としてください
「対象外」免税対象ではない商品
「一般品」電化製品、服、着物、カバンなど
「消耗品」酒、食品類、薬品類、化粧品類など
※部門の免税区分よりも、商品の免税区分を優先します。
(部門売りで適用されます。)

string
supplierProductNo

品番:85文字以内。

string
calcDiscount

値引割引計算対象:小計値引/割引(クーポン値引、ポイント値引き含む)の対象かどうかを設定 (0:対象外、1:対象)未設定の場合、1:対象 を設定。

string
staffDiscountRate

社員販売割引率:数字3桁以内。社員販売時の割引率を設定。

string
useCategoryReduceTax

部門の税設定を使用:商品に設定した税設定を使用するか、その商品に設定した部門の税設定を使用するかを選択。
(0:商品の税設定を使用、1:部門の税設定を使用)
「軽減税率ID(税設定)」に値が設定されている場合「0:商品の税設定を使用」。
「軽減税率ID(税設定)」の値が未設定(null)の場合「1:部門の税設定を使用」を設定

string
reduceTaxId

軽減税率ID(税設定):軽減税率ID。 軽減税率設定画面で設定した軽減税率ID、または、下記の軽減税率ID。標準税率の場合はnull。
軽減:10000001 (特定商品の軽減税率適用)
選択[標準]:10000002(状態による適用[適用しない])
選択[軽減]:10000003(状態による適用[適用する])
選択[選択]:10000004(状態による適用[都度選択する])

string
reduceTaxPrice

軽減税率用商品単価:軽減税率用商品単価を設定。 当項目は、レジ端末で販売時に、軽減税率を選択した時の価格になります。
未設定の場合は、「商品単価」が軽減税率を選択した時の価格になります。
税込の場合設定可能。税抜価格の場合計算して算出できるため税込の場合のみ設定できます。

string
reduceTaxCustomerPrice

軽減税率用商品会員単価:軽減税率用会員単価を設定。 設定内容については、「軽減税率用商品単価」と同様となります。

string
appStartDateTime

適用開始日時:商品が端末に適用される日時を設定。 未設定の場合は未使用。[YYYY-MM-DD]

string
insDateTime

作成日時:登録時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string
updDateTime

更新日時:登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string
stores

商品取扱店舗

Array<object>
object
productId

商品ID:数字15桁以内。

string
storeId

店舗ID:数字9桁以内。

string
productOptionGroupId

オプショングループID:オプショングループの設定方法が「店舗ごと」の場合、適用可能なオプショングループのIDがあればこちらに設定されます。無ければnullが設定されます。

string
assignDivision

取扱区分:0:販売する/1:販売しない

string
Example
[
{
"productId": "string",
"categoryId": "string",
"productCode": "string",
"productName": "string",
"productKana": "string",
"taxDivision": "string",
"productPriceDivision": "string",
"price": "string",
"customerPrice": "string",
"cost": "string",
"attribute": "string",
"description": "string",
"catchCopy": "string",
"size": "string",
"color": "string",
"tag": "string",
"groupCode": "string",
"url": "string",
"printReceiptProductName": "string",
"displaySequence": "string",
"salesDivision": "string",
"stockControlDivision": "string",
"displayFlag": "string",
"division": "string",
"productOptionGroupId": "string",
"pointNotApplicable": "string",
"taxFreeDivision": "string",
"supplierProductNo": "string",
"calcDiscount": "string",
"staffDiscountRate": "string",
"useCategoryReduceTax": "string",
"reduceTaxId": "10000001",
"reduceTaxPrice": "string",
"reduceTaxCustomerPrice": "string",
"appStartDateTime": "string",
"insDateTime": "string",
"updDateTime": "string",
"stores": [
{
"productId": "string",
"storeId": "string",
"productOptionGroupId": "string",
"assignDivision": "string"
}
]
}
]