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

在庫一覧取得

GET
/stores/{store_id}/stock_list

受注店舗の在庫参照店舗の在庫情報一覧を取得します。

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
store_id
required
string

受注店舗ID
※通常店舗及び倉庫の店舗IDは指定できません。

Example
23

Query Parameters

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

取得件数

Example
30
page
integer
default: 1 >= 1

ページ

Example
1
sort
string
default: updatedAt:desc
Allowed values: updatedAt updatedAt:desc reserveUpdatedAt reserveUpdatedAt:desc

ソート

  • updatedAt: 在庫数の最終更新日時
  • reserveUpdatedAt: 引当数の最終更新日時
Example
updatedAt:desc
product_ids
string
>= 1 characters

スマレジの商品ID
商品IDで指定された商品在庫を取得します。
（1以上の整数値をカンマ区切りで複数指定可、最大100件）

Example
8005735,8005736,8005737
updated_at_from
string format: date-time

在庫数の最終更新日時(From)[YYYY-MM-DDThh:mm:ssTZD]
在庫数の最終更新日時が指定された日時以降の商品在庫を取得します。

Example
2025-06-01T00:00:00+09:00
updated_at_to
string format: date-time

在庫数の最終更新日時(To)[YYYY-MM-DDThh:mm:ssTZD]
在庫数の最終更新日時が指定された日時以前の商品在庫を取得します。

Example
2025-06-02T00:00:00+09:00
reserve_updated_at_from
string format: date-time

引当数の最終更新日時(From)[YYYY-MM-DDThh:mm:ssTZD]
引当数の最終更新日時が指定された日時以降の商品在庫を取得します。

Example
2025-06-01T00:00:00+09:00
reserve_updated_at_to
string format: date-time

引当数の最終更新日時(To)[YYYY-MM-DDThh:mm:ssTZD]
引当数の最終更新日時が指定された日時以前の商品在庫を取得します。

Example
2025-06-02T00:00:00+09:00

Responses

Section titled “ Responses ”

200

Section titled “200 ”

取得成功

Array<object>
Stock
object
productId
required

スマレジの商品ID

string
>= 1 characters 
8005735
stockAmount
required

在庫数（フリー在庫）

integer
964
updatedAt
required

在庫数の最終更新日時[YYYY-MM-DDThh:mm:ssTZD]
在庫数が未更新の商品の場合はnullとなります。

string format: date-time
nullable 
2025-06-02T15:27:50+09:00
reserveAmount
required

引当数
受注ステータスが「出荷待ち」以前の受注の明細のうち、引当されている個数

integer
27
nonReserveAmount
required

未引当数
受注ステータスが「出荷待ち」以前の受注の明細のうち、引当されていない個数

integer
12
reserveUpdatedAt
required

引当数の最終更新日時[YYYY-MM-DDThh:mm:ssTZD]
引当数が未更新の商品の場合はnullとなります。

string format: date-time
nullable 
2025-05-07T13:42:04+09:00
Example
[
  {
    "productId": "8005735",
    "stockAmount": 964,
    "updatedAt": "2025-06-02T15:27:50+09:00",
    "reserveAmount": 27,
    "nonReserveAmount": 12,
    "reserveUpdatedAt": "2025-05-07T13:42:04+09:00"
  },
  {
    "productId": "8005736",
    "stockAmount": 150,
    "updatedAt": "2025-06-02T10:15:30+09:00",
    "reserveAmount": 5,
    "nonReserveAmount": 3,
    "reserveUpdatedAt": "2025-05-07T09:20:15+09:00"
  }
]

Headers

Section titled “Headers ”
Link

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

string

400

Section titled “400 ”
  • 指定された商品IDの件数が100件を超える場合
  • 指定された商品IDに1以上の整数値でない値が含まれる場合
  • 在庫数の最終更新日時(To)が在庫数の最終更新日時(From)より過去の場合
  • 引当数の最終更新日時(To)が引当数の最終更新日時(From)より過去の場合
object
type
required
string
title
required
string
detail
string
status
integer
Examples
{
  "type": "about:blank",
  "title": "BadRequest",
  "detail": "指定された商品IDの件数が100件を超えています。",
  "status": 400
}