ロス一覧取得

GET

/losses

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/losses?fields=lossId%2Cmemo&sort=lossId&limit=10&page=2&store_id=1&division=1';
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/losses?fields=lossId%2Cmemo&sort=lossId&limit=10&page=2&store_id=1&division=1'

ロス情報一覧を取得します。

対象プラン

リテールビジネス

Authorizations

AppAccessToken
pos.losses:read

Parameters

Query Parameters

fields

array

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

Example

lossId,memo

sort

string

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

指定可能なパラメータ

lossId：ロスID
storeId：店舗ID
division：ロス区分：ロス区分一覧より設定可能。
lossDateTime：ロス発生日時：ロス発生時の日時。[YYYY-MM-DDThh:mm:ssTZD]
updDateTime：更新日時：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

Example

lossId

limit

integer

上限数

Example

page

integer

ページ

Example

store_id

string

店舗ID

Example

division

string

ロス区分：ロス区分一覧より設定可能。

Example

Responses

200

取得成功

application/json

Array<object>

object

lossId

ロスID

string

storeId

店舗ID

string

division

ロス区分：ロス区分一覧より設定可能。

string

memo

メモ

string

lossDateTime

ロス発生日時：ロス発生時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string

identificationNo

識別番号：ロス情報を管理するための任意の文字列を設定出来る項目。

string

staffId

スタッフID：ロス処理時のスタッフID。

string

staffName

スタッフ名：ロス処理時のスタッフ名。

string

insDateTime

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

string

updDateTime

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

string

Example

[
  {
    "lossId": "1",
    "storeId": "1",
    "division": "1",
    "memo": "ロスメモ",
    "lossDateTime": "2025-01-01T00:00:00+09:00",
    "identificationNo": "123456789",
    "staffId": "1",
    "staffName": "管理者",
    "insDateTime": "2025-01-01T00:01:00+09:00",
    "updDateTime": "2025-01-01T00:01:00+09:00"
  }
]