棚卸一覧取得

GET

/stocktaking

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/stocktaking?fields=stocktakingInfoId%2CstoreId&sort=stocktakingInfoId&limit=10&page=2&store_id=1&target_date=2025-01-31&status=2';
const options = {method: 'GET'};

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/stocktaking?fields=stocktakingInfoId%2CstoreId&sort=stocktakingInfoId&limit=10&page=2&store_id=1&target_date=2025-01-31&status=2'

棚卸情報一覧を取得します。

対象プラン

リテールビジネス

Authorizations

AppAccessToken
pos.stocktaking:read

Parameters

Query Parameters

fields

array

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

Example

stocktakingInfoId,storeId

sort

string

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

指定可能なパラメータ

stocktakingInfoId：棚卸情報ID
storeId：店舗ID
targetDate：棚卸日：[YYYY-MM-DD]
status：ステータス：（0：棚卸途中、1：調整中、2：完了）
updDateTime：更新日時：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

Example

stocktakingInfoId

limit

integer

上限数

Example

page

integer

ページ

Example

store_id

string

店舗ID

Example

target_date

string

棚卸日：[YYYY-MM-DD]

Example

2025-01-31

status

string

Allowed values: 0 1 2 3

ステータス： 0：棚卸途中、1：調整中、2：完了

Example

Responses

200

取得成功

application/json

Array<object>

object

stocktakingInfoId

棚卸情報ID

string

storeId

店舗ID

string

divisionUnit

分割単位：分割単位を設定。（0：分割なし、1：部門）

string

Allowed values: 0 1

stockCountDivision

在庫計上区分：在庫計上区分(1:更新日、 2:計上日)

string

Allowed values: 1 2

targetDate

棚卸日：[YYYY-MM-DD]

string

adjustmentDateTime

調整日時：[YYYY-MM-DDThh:mm:ssTZD]

string

stocktakingInputCompleteDate

入力完了日時：[YYYY-MM-DDThh:mm:ssTZD]

string

stocktakingCompleteDateTime

棚卸完了日時：[YYYY-MM-DDThh:mm:ssTZD]

string

status

ステータス：（0：棚卸途中、1：調整中、2：棚卸完了、3：入力完了）

string

Allowed values: 0 1 2 3

autoFollowingFlag

自動追従フラグ：自動追従フラグ(0：利用しない、1：利用する)

string

Allowed values: 0 1

layawayStockIncludeFlag

取置在庫取扱フラグ：取置在庫取扱フラグ（0：棚卸数量に取置在庫を含まない、1：棚卸数量に取置在庫を含む）

string

Allowed values: 0 1

insDateTime

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

string

updDateTime

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

string

Example

[
  {
    "stocktakingInfoId": "1",
    "storeId": "1",
    "divisionUnit": "0",
    "stockCountDivision": "2",
    "targetDate": "2025-01-31",
    "adjustmentDateTime": "2025-01-31T00:02:00+09:00",
    "stocktakingInputCompleteDate": "2025-01-31T00:01:00+09:00",
    "stocktakingCompleteDateTime": "2025-01-31T00:02:00+09:00",
    "status": "2",
    "autoFollowingFlag": "1",
    "layawayStockIncludeFlag": "1",
    "insDateTime": "2025-01-01T00:00:00+09:00",
    "updDateTime": "2025-01-31T00:02:00+09:00"
  }
]