部門グループ更新

PATCH

/category_groups/{category_group_id}

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/category_groups/example';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"categoryGroupCode":"string","categoryGroupName":"string","displaySequence":"123456789"}'
};

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/category_groups/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "categoryGroupCode": "string", "categoryGroupName": "string", "displaySequence": "123456789" }'

指定された部門グループを更新します。

対象プラン

スタンダード
プレミアム
プレミアムプラス
フードビジネス
リテールビジネス

Authorizations

AppAccessToken
pos.products:write
UserAccessToken
pos.products:write

Parameters

Path Parameters

category_group_id

required

string

部門グループID

Request Body

application/json

object

categoryGroupCode

部門グループコード

部門グループコード

string

<= 10 characters /^[ -~]+$/

categoryGroupName

部門グループ名

部門グループ名

string

<= 85 characters

displaySequence

表示順

表示順

string format: int

<= 999999999

Example

{
  "categoryGroupCode": "string",
  "categoryGroupName": "string",
  "displaySequence": "123456789"
}

Responses

200

更新成功

application/json

object

categoryGroupId

部門グループID

string

categoryGroupCode

部門グループコード

string

categoryGroupName

部門グループ名

string

displaySequence

表示順

string

insDateTime

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

string

updDateTime

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

string

Example

{
  "categoryGroupId": "string",
  "categoryGroupCode": "string",
  "categoryGroupName": "string",
  "displaySequence": "string",
  "insDateTime": "string",
  "updDateTime": "string"
}

400

入力チェックエラーの場合
指定された部門グループコードが重複する場合

application/json

object

type

required

string

title

required

string

detail

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "[categoryGroupCode]半角英数記号で入力して下さい",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "指定された部門グループコードは既に登録されています。",
  "status": 400
}

404

指定されたIDが存在しない場合

application/json

object

type

required

string

title

required

string

detail

string

status

integer

Examples

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

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