客層更新

PATCH

/customer_groups/{customer_group_id}

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/customer_groups/example';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"customerGroupSectionId":"12345","label":"string","displayFlag":"0","displaySequence":"12345"}'
};

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/customer_groups/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "customerGroupSectionId": "12345", "label": "string", "displayFlag": "0", "displaySequence": "12345" }'

客層情報を更新します。

対象プラン

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

Authorizations

AppAccessToken
pos.transactions:write
UserAccessToken
pos.transactions:write

Parameters

Path Parameters

customer_group_id

required

string

客層ID

Request Body

application/json

object

customerGroupSectionId

客層セクションID

string format: int

>= 1 <= 99999

label

ラベル

string

<= 85 characters

displayFlag

表示フラグ

端末で表示するか判定 (0：表示しない、1：表示する)

string

Allowed values: 0 1

displaySequence

表示順

string format: int

<= 99999

Example

{
  "customerGroupSectionId": "12345",
  "label": "string",
  "displayFlag": "0",
  "displaySequence": "12345"
}

Responses

200

更新成功

application/json

object

customerGroupId

客層ID

string

customerGroupSectionId

客層セクションID

string

label

ラベル：

string

displayFlag

表示フラグ：端末で表示するか判定 (0：表示しない、1：表示する)

string

Allowed values: 0 1

displaySequence

表示順

string

insDateTime

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

string

updDateTime

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

string

Example

{
  "customerGroupId": "string",
  "customerGroupSectionId": "string",
  "label": "string",
  "displayFlag": "0",
  "displaySequence": "string",
  "insDateTime": "string",
  "updDateTime": "string"
}

400

指定された客層セクションIDのリソースが見つからない場合

application/json

object

type

required

string

title

required

string

detail

string

status

integer

Examples

指定された客層セクションIDのリソースが見つからない場合

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "[customerGroupSectionId] 客層セクションIDは存在しません",
  "status": 400
}

404

指定された客層IDのリソースが見つからない場合

application/json

object

type

required

string

title

required

string

detail

string

status

integer

Examples

指定された客層IDのリソースが見つからない場合

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