ロス区分一覧取得

GET

/losses/divisions

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/losses/divisions?fields=code%2Ccolor&sort=code&limit=10&page=2&active_flag=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/divisions?fields=code%2Ccolor&sort=code&limit=10&page=2&active_flag=1'

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

対象プラン

リテールビジネス

Authorizations

AppAccessToken
pos.losses:read

Parameters

Query Parameters

fields

array

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

Example

code,color

sort

string

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

指定可能なパラメータ

code：コード
displaySequence：表示順
updDateTime：更新日時：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

Example

code

limit

integer

上限数

Example

page

integer

ページ

Example

active_flag

string

Allowed values: 0 1

有効フラグ：0:無効 1:有効

Example

Responses

200

取得成功

application/json

Array<object>

object

code

コード

string

name

ロス区分名

string

color

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

string

activeFlag

有効フラグ：（0：無効 1：有効）

string

Allowed values: 0 1

displaySequence

表示順

string

insDateTime

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

string

updDateTime

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

string

Example

[
  {
    "code": "1",
    "name": "廃棄",
    "color": "#000000",
    "activeFlag": "1",
    "displaySequence": "1",
    "insDateTime": "2025-01-01T00:00:00+09:00",
    "updDateTime": "2025-01-01T00:00:00+09:00"
  }
]