コンテンツにスキップ
スマレジ・プラットフォームAPI リファレンス

商品一覧取得

GET
/products
curl --request GET \
  --url 'https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-b2b/products?limit=10&page=1&sort=createdAt%3Adesc' \
  --header 'Authorization: Bearer <token>'

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
integer
default: 10 >= 1 <= 100

取得件数

page
integer
default: 1 >= 1

ページ

sort
string
default: createdAt:desc
Allowed values: referenceIdentifier referenceIdentifier:desc createdAt createdAt:desc updatedAt updatedAt:desc

ソート

  • referenceIdentifier: 管理番号
  • createdAt: 作成日時
  • updatedAt: 更新日時
Example
createdAt:desc
name
string
<= 255 characters

商品名で絞り込み（完全一致）

reference_identifier
string
<= 200 characters

管理番号で絞り込み（完全一致）

tag
string

タグ名で絞り込み（完全一致）

Responses

Section titled “Responses”

200

Section titled “200”

取得成功

Media typeapplication/json
Array
ProductResponse
object
id

商品ID

string format: uuid
productGroupId

商品グループID

string format: uuid
referenceIdentifier

管理番号

使用可能文字: 半角英数字および - _ . #

string
>= 1 characters <= 200 characters /^[0-9A-Za-z\-_.#]+$/
name

商品名

string
<= 255 characters
publishCode

公開ステータス

  • 1: 公開
  • 2: 下書き
  • 3: 公開期間あり
integer
Allowed values: 1 2 3
publishStartAt

公開開始日時

string format: date-time
nullable
publishEndAt

公開終了日時

string format: date-time
nullable
sellingPriceNoTax

販売価格（税抜）

string
taxRate

税率

integer
orderAcceptanceFormatCode

受注受付形式

  • 1: 自由入力
integer
Allowed values: 1
packageType

荷姿

string
nullable <= 30 characters
quantityPerPackage

入数

integer
nullable
unit

単位

string
nullable <= 10 characters
purchaseUnitType

購入単位区分

  • 1: 個数
  • 2: 容量指定

2（容量指定）の場合は unitCode・baseUnit が必須です。 1（個数）の場合、unitCode・baseUnit・isOrderUnit・orderUnit・isMinimumOrderQuantity・minimumOrderQuantity は指定しても無視されます（保存されません）。

integer
Allowed values: 1 2
unitCode

容量単位

  • 1: g
  • 2: kg
  • 3: cm
  • 4: m
  • 5: km
  • 6: mL
  • 7: L

purchaseUnitType が 2（容量指定）の場合は必須です。

integer
nullable
Allowed values: 1 2 3 4 5 6 7
baseUnit

基準容量

この容量（unitCode の単位）あたりの価格を sellingPriceNoTax で指定します。 purchaseUnitType が 2（容量指定）の場合は必須です。0 より大きく 9999999999.99 以下の小数2桁で指定してください。

string
nullable /^(([1-9][0-9]{0,9})(\.[0-9]{1,2})?|0\.([1-9][0-9]?|0[1-9]))$/
isOrderUnit

注文単位設定フラグ

  • true: 注文単位を設定する
  • false: 設定しない
boolean
orderUnit

注文単位

isOrderUnit が true の場合は必須です。0 より大きく 9999999999.99 以下の小数2桁で指定してください。

string
nullable /^(([1-9][0-9]{0,9})(\.[0-9]{1,2})?|0\.([1-9][0-9]?|0[1-9]))$/
isMinimumOrderQuantity

最低注文容量設定フラグ

  • true: 最低注文容量を設定する
  • false: 設定しない
boolean
minimumOrderQuantity

最低注文容量

isMinimumOrderQuantity が true の場合は必須です。0 より大きく 9999999999.99 以下の小数2桁で指定してください。

string
nullable /^(([1-9][0-9]{0,9})(\.[0-9]{1,2})?|0\.([1-9][0-9]?|0[1-9]))$/
weight

重量

integer
nullable
size

サイズ

0 以上 9999999999.99 以下の小数2桁で指定します。

string
nullable /^[0-9]{1,10}(\.[0-9]{1,2})?$/
shippingFeeFormatCode

送料形式

  • 1: 送料別
  • 2: 送料込
integer
Allowed values: 1 2
isInventory

在庫管理フラグ

boolean
isBackOrder

在庫無し注文受付フラグ

boolean
createdAt

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

string format: date-time
updatedAt

更新日時。[YYYY-MM-DDThh:mm:ssTZD]

string format: date-time
productGroup

商品グループ

object
id

商品グループID

string format: uuid
name

グループ名

string
detailPageText

詳細ページテキスト

string
nullable
productTags

商品タグ一覧

Array<object>
object
id

商品タグID

string format: uuid
name

タグ名

string
productImages

商品画像一覧

Array<object>
object
id

商品画像ID

string format: uuid
url

画像URL

完全なURLを推奨します。ただし現行システムからの移行データではファイル名（相対パス）が格納・返却される場合があるため、URL形式の検証は行わず素の文字列として扱います。

string
alt

代替テキスト

string
nullable
inventory

在庫情報

object
id

在庫ID

string format: uuid
productId

商品ID

string format: uuid
actual

実在庫数

integer
pending

未発送在庫

integer
isInventoryNotification

在庫通知フラグ

boolean
inventoryLowLimit

在庫通知下限値

integer
required

確保必要在庫

integer
available

有効在庫

integer
frontend

フロント在庫

integer
Examples
Exampledefault
[
  {
    "id": "55555555-5555-5555-5555-555555555555",
    "productGroupId": "12345678-1234-1234-1234-1234567890ab",
    "referenceIdentifier": "product-001",
    "name": "テスト商品A",
    "publishCode": 1,
    "publishStartAt": null,
    "publishEndAt": null,
    "sellingPriceNoTax": "100.00",
    "taxRate": 10,
    "orderAcceptanceFormatCode": 1,
    "packageType": null,
    "quantityPerPackage": null,
    "unit": "個",
    "purchaseUnitType": 1,
    "unitCode": null,
    "baseUnit": null,
    "isOrderUnit": false,
    "orderUnit": null,
    "isMinimumOrderQuantity": false,
    "minimumOrderQuantity": null,
    "weight": null,
    "size": null,
    "shippingFeeFormatCode": 1,
    "isInventory": false,
    "isBackOrder": false,
    "createdAt": "2025-06-01T10:00:00+09:00",
    "updatedAt": "2025-06-09T14:15:40+09:00",
    "productGroup": {
      "id": "77777777-7777-7777-7777-777777777777",
      "name": "商品グループ1700",
      "detailPageText": null
    },
    "productTags": [],
    "productImages": [],
    "inventory": null
  }
]

Headers

Section titled “Headers”
Link
string

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

400

Section titled “400”
  • 入力チェックエラーの場合
Media typeapplication/json
object
type
required
string
title
required
string
detail
string
status
integer
Examples
{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "request_json:[limit]は100以下の数字を指定してください。",
  "status": 400
}