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

ロス登録

POST
/losses
curl --request POST \
  --url https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/losses \
  --header 'Content-Type: application/json' \
  --data '{ "storeId": "1", "division": "1", "memo": "ロスメモ", "lossDateTime": "2025-01-01T00:00:00+09:00", "identificationNo": "123456789", "staffId": "1", "details": [ { "productId": "8000001", "taxRate": "10.000", "quantity": "5" } ] }'

ロス情報を登録します。

対象プラン

  • リテールビジネス

Authorizations

Section titled “Authorizations”

Request Body

Section titled “Request Body”
Media typeapplication/json
object
storeId
required
店舗ID

店舗ID。登録時のみ指定可能。更新時は変更不可。
※店舗マスタが存在しない場合エラー

string format: int
>= 1 <= 999999999
division
required
ロス区分

ロス区分コードを設定。
※ロス区分マスタが存在しない場合エラー

string format: int
>= 1 <= 99
memo
メモ

メモ

string
<= 1000 characters
lossDateTime
required
ロス発生日時

ロス発生時の日時。[YYYY-MM-DDThh:mm:ssTZD]
※未来日時を設定することはできません

string format: date-time
identificationNo
識別番号

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

string
<= 32 characters
staffId
スタッフID

スタッフID
※スタッフ情報が存在しない場合エラー

string format: int
>= 1 <= 999999999
details
required
ロス明細

ロス明細(objectList) 登録時は明細は必須
※明細の最大件数は1000件です

Array<object>
object
productId
required
商品ID

商品ID。15桁以内。
※商品マスタが存在しない場合エラー

string format: int
>= 1 <= 999999999999999
taxRate

税率
小数点3桁まで
未設定の場合、ロス登録時の税率を設定する。

string format: decimal
<= 100
quantity
required
数量

数量

string format: int
>= 1 <= 99999
Example
{
  "storeId": "1",
  "division": "1",
  "memo": "ロスメモ",
  "lossDateTime": "2025-01-01T00:00:00+09:00",
  "identificationNo": "123456789",
  "staffId": "1",
  "details": [
    {
      "productId": "8000001",
      "taxRate": "10.000",
      "quantity": "5"
    }
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

取得成功

Media typeapplication/json
object
lossId

ロスID。ロス毎に付与するID。自動採番。

string
storeId

店舗ID。登録時のみ指定可能。更新時は変更不可。
※店舗マスタが存在しない場合エラー

string
division

ロス区分コードを設定。
※ロス区分マスタが存在しない場合エラー

string
memo

メモ

string
lossDateTime

ロス発生時の日時。[YYYY-MM-DDThh:mm:ssTZD]
※未来日時を設定することはできません

string
identificationNo

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

string
staffId

スタッフID
※スタッフ情報が存在しない場合エラー

string
staffName

スタッフIDがある場合、スタッフマスタのスタッフ名を設定

string
insDateTime

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

string
updDateTime

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

string
details

ロス明細(objectList) 登録時は明細は必須

Array<object>
object
lossDetailId

ロス明細ID。ロス明細毎に付与するID。自動採番。

string
lossId

ロスID。ロス毎に付与するID。

string
productId

商品ID。15桁以内。
※商品マスタが存在しない場合エラー

string
taxRate

税率

string
cost

商品IDに紐づく商品の原価を自動で設定。

string
quantity

数量

string
insDateTime

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

string
updDateTime

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

string
Example
{
  "lossId": "2",
  "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": "2",
      "lossId": "2",
      "productId": "8000001",
      "taxRate": "10.000",
      "cost": "100.00000",
      "quantity": "5",
      "insDateTime": "2025-01-01T00:01:00+09:00",
      "updDateTime": "2025-01-01T00:01:00+09:00"
    }
  ]
}

400

Section titled “400”
  • 店舗IDが存在しない場合
  • ロス区分IDが存在しない場合
  • スタッフIDが存在しない場合
  • 商品IDが存在しない場合
  • ロス明細がない場合
  • ロス明細件数が1000件を超過した場合
Media typeapplication/json
object
type
required
string
title
required
string
detail
string
status
integer
Examples
{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "storeId:513 店舗(倉庫)が存在しません",
  "status": 400
}