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

客層登録

POST
/customer_groups
curl --request POST \
  --url https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/customer_groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "customerGroupSectionId": "12345", "label": "string", "displayFlag": "0", "displaySequence": "12345" }'

客層情報を登録します。

対象プラン

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

Authorizations

Section titled “Authorizations”

Request Body

Section titled “Request Body”
Media typeapplication/json
object
customerGroupSectionId
required
客層セクションID
string format: int
>= 1 <= 99999
label
required
ラベル
string
<= 85 characters
displayFlag
表示フラグ

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

string
default: 1
Allowed values: 0 1
displaySequence
required
表示順
string format: int
<= 99999
Example
{
  "customerGroupSectionId": "12345",
  "label": "string",
  "displayFlag": "0",
  "displaySequence": "12345"
}

Responses

Section titled “Responses”

200

Section titled “200”

更新成功

Media typeapplication/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

Section titled “400”
  • 入力チェックエラーの場合
  • 指定された客層セクションIDのリソースが見つからない場合
Media typeapplication/json
object
type
required
string
title
required
string
detail
string
status
integer
Examples
Example指定された客層セクションIDのリソースが見つからない場合
{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "[customerGroupSectionId] 客層セクションIDは存在しません",
  "status": 400
}