ロス区分更新

PATCH

/losses/divisions/{code}

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/losses/divisions/5';
const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: '{"name":"新規ロス区分","color":"#00FF00","activeFlag":"1","displaySequence":"1"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/losses/divisions/5 \
  --header 'Content-Type: application/json' \
  --data '{ "name": "新規ロス区分", "color": "#00FF00", "activeFlag": "1", "displaySequence": "1" }'

ロス区分を更新します。

対象プラン

リテールビジネス

Authorizations

AppAccessToken
pos.losses:write

Parameters

Path Parameters

code

required

string

コード

Example

Request Body

application/json

object

name

ロス区分名

ロス区分名

string

<= 8 characters

color

色

ロス一覧に表示される色。カラーコード。[#FFFFFF]

string

/^#([0-9a-fA-F]{1,6})$/

activeFlag

有効フラグ

有効フラグ(0:無効 1:有効)

string

Allowed values: 0 1

displaySequence

表示順

表示順

string format: int

>= 1 <= 999

Example

{
  "name": "新規ロス区分",
  "color": "#00FF00",
  "activeFlag": "1",
  "displaySequence": "1"
}

Responses

200

取得成功

application/json

object

code

ユニーク値 コード

string

name

ロス区分名

string

color

ロス一覧に表示される色。カラーコード。[#FFFFFF]

string

activeFlag

有効フラグ(0:無効 1:有効)

string

displaySequence

表示順

string

insDateTime

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

string

updDateTime

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

string

Example

{
  "code": "5",
  "name": "新規ロス区分",
  "color": "#00FF00",
  "activeFlag": "1",
  "displaySequence": "1",
  "insDateTime": "2025-01-01T00:00:00+09:00",
  "updDateTime": "2025-01-01T00:01:00+09:00"
}

404

指定したロス区分データが存在しない場合

application/json

object

type

required

string

title

required

string

detail

string

status

integer

Examples

リソースが存在しない場合

{
  "type": "about:blank",
  "title": "NotFound",
  "detail": "指定されたIDのリソースが見つかりません",
  "status": 404
}