在庫一覧取得

GET

/stock

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/stock';
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/pos/stock \
  --header 'Authorization: Bearer <token>'

在庫情報一覧を取得します。

※ 商品の在庫情報はその商品の在庫数が変動してはじめて取得できます（在庫数の変動例: 販売・入出荷・店間移動・棚卸・在庫調整・ロス登録など）。

対象プラン

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

Authorizations

AppAccessToken
pos.stock:read
UserAccessToken
pos.stock:read

Parameters

Query Parameters

fields

array

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

sort

string

並び順（カンマ区切りで指定可）

指定可能なパラメータ

productId：商品ID
storeId：店舗ID

limit

integer

上限数

page

integer

ページ

store_id

integer

店舗ID
※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗IDを指定してください。

product_id

string

商品ID

upd_date_time-from

string

更新日時(from)：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]
※ From〜Toの期間は最大31日までの指定でご利用ください

upd_date_time-to

string

更新日時(to)：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]
※ From〜Toの期間は最大31日までの指定でご利用ください

Responses

200

取得成功

application/json

Array<object>

object

storeId

店舗ID：数字9桁以内。

string

productId

商品ID：数字15桁以内。

string

stockAmount

在庫数：現在の在庫数。

string

layawayStockAmount

取置き在庫数：現在の取置き在庫数。

string

updDateTime

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

string

Example

[
  {
    "storeId": "string",
    "productId": "string",
    "stockAmount": "string",
    "layawayStockAmount": "string",
    "updDateTime": "string"
  }
]

400

更新日時のFrom/To片方しか設定されていない場合
更新日時のFrom-Toの範囲が上限を超えている場合

application/json

object

type

required

string

title

required

string

detail

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "範囲の終了を指定して下さい。(QUERY PARAMETER-{QUERY PARAMETER})",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "{範囲}の範囲で入力してください。(QUERY PARAMETER-{QUERY PARAMETER})",
  "status": 400
}