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

ロス更新

PATCH
/losses/{loss_id}

ロスを更新します。

対象プラン

  • リテールビジネス

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
loss_id
required
string

ロスID

Example
5

Request Body

Section titled “Request Body ”
object
division
ロス区分

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

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

メモ

string
<= 1000 characters 
ロスメモ
identificationNo
識別番号

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

string
<= 32 characters 
123456789
staffId
スタッフID

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

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

ロス明細(objectList) ロス更新時にロス明細を追加登録できます
※明細は既存件数と追加件数の合計が1000件以下になるようにしてください

Array<object>
object
lossDetailId
ロス明細ID

既存のロス明細更新時には入力する。未入力の場合追加登録される

string format: int
>= 1 <= 999999999 
5
productId
商品ID

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

string format: int
>= 1 <= 999999999999999 
8000001
taxRate

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

string format: decimal
<= 100 
10.000
quantity
数量

数量

string format: int
>= 1 <= 99999 
5
Example
{
  "division": "1",
  "memo": "ロスメモ",
  "identificationNo": "123456789",
  "staffId": "1",
  "details": [
    {
      "lossDetailId": "5",
      "productId": "8000001",
      "taxRate": "10.000",
      "quantity": "5"
    }
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

取得成功

object
lossId

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

string
5
division

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

string
1
memo

メモ

string
ロスメモ
identificationNo

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

string
123456789
staffId

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

string
1
staffName

スタッフIDがある場合、スタッフマスタのスタッフ名（販売員名）を設定

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:02:00+09:00
details

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

Array<object>
object
lossDetailId

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

string
5
lossId

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

string
5
productId

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

string
8000001
taxRate

税率

string
10.000
cost

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

string
100.00000
quantity

数量

string
5
insDateTime

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

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

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

string
2025-01-01T00:02:00+09:00
Example
{
  "lossId": "5",
  "division": "1",
  "memo": "ロスメモ",
  "identificationNo": "123456789",
  "staffId": "1",
  "staffName": "管理者",
  "insDateTime": "2025-01-01T00:01:00+09:00",
  "updDateTime": "2025-01-01T00:02:00+09:00",
  "details": [
    {
      "lossDetailId": "5",
      "lossId": "5",
      "productId": "8000001",
      "taxRate": "10.000",
      "cost": "100.00000",
      "quantity": "5",
      "insDateTime": "2025-01-01T00:01:00+09:00",
      "updDateTime": "2025-01-01T00:02:00+09:00"
    }
  ]
}

400

Section titled “400 ”
  • ロス区分IDが存在しない場合
  • スタッフIDが存在しない場合
  • 商品IDが存在しない場合
  • 在庫管理設定にある「ロス完了後の編集可否」が「編集不可」に設定されている場合
  • ロス明細がない場合
  • ロス明細IDも商品IDも指定していない場合
  • ロス明細件数が1000件を超過した場合
object
type
required
string
title
required
string
detail
string
status
integer
Examples
{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "[division] 存在しないロス区分が指定されています。(division-6)",
  "status": 400
}