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

ロス取得

GET
/losses/{loss_id}

ロス情報を取得します。

対象プラン

  • リテールビジネス

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
loss_id
required
string

ロスID

Example
3

Query Parameters

Section titled “Query Parameters ”
fields
array

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

Example
storeId,memo
with_details
string
default: none
Allowed values: all none

ロス明細を付加するか(付加する場合はall, しない場合はnone)

Example
all

Responses

Section titled “ Responses ”

200

Section titled “200 ”

取得成功

object
lossId

ロスID

string
3
storeId

店舗ID

string
1
division

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

string
1
memo

メモ

string
ロスメモ
lossDateTime

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

string
2025-01-01T00:00:00+09:00
identificationNo

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

string
123456789
staffId

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

string
1
staffName

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

string
管理者
insDateTime

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

string
2025-01-01T00:01:00+09:00
updDateTime

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

string
2025-01-01T00:01:00+09:00
details

ロス明細(with_details=all時のみ返される)

Array<object>
object
lossDetailId

ロス明細ID

string
3
lossId

ロスID

string
3
productId

商品ID：数字15桁以内。

string
8000001
taxRate

税率

string
10.000
cost

原価

string
10.00000
quantity

数量

string
2
rfidTags

RFIDタグリスト

Array<string>
[
  "RFID001",
  "RFID002"
]
insDateTime

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

string
2025-01-01T00:01:00+09:00
updDateTime

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

string
2025-01-01T00:01:00+09:00
Example
{
  "lossId": "3",
  "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",
  "details": [
    {
      "lossDetailId": "3",
      "lossId": "3",
      "productId": "8000001",
      "taxRate": "10.000",
      "cost": "10.00000",
      "quantity": "2",
      "rfidTags": [
        "RFID001",
        "RFID002"
      ],
      "insDateTime": "2025-01-01T00:01:00+09:00",
      "updDateTime": "2025-01-01T00:01:00+09:00"
    }
  ]
}

404

Section titled “404 ”
  • リソースが存在しない場合
object
type
required
string
title
required
string
detail
string
status
integer
Examples
{
  "type": "about:blank",
  "title": "NotFound",
  "detail": "指定されたIDのリソースが見つかりません",
  "status": 404
}