会員自由項目削除

DELETE

/customers/{customer_id}/custom_fields/{no}

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/customers/example/custom_fields/1';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

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

curl --request DELETE \
  --url https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/customers/example/custom_fields/1 \
  --header 'Authorization: Bearer <token>'

会員自由項目情報を削除します。

指定した会員の会員自由項目の値のみ削除します。会員自由項目ラベルは削除しません。

対象プラン

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

Authorizations

AppAccessToken
pos.customers:write
UserAccessToken
pos.customers:write

Parameters

Path Parameters

customer_id

required

string

会員ID

required

integer

>= 1

会員自由項目番号

Responses

200

削除成功

400

削除対象の会員自由項目が会員必須項目設定で必須項目に設定されている場合
入力チェックエラーの場合

application/json

object

type

required

string

title

required

string

detail

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "[no] 会員必須項目設定で必須項目に設定されているため削除できません。(no-{no})",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "[no] 半角数字（整数）で入力して下さい",
  "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
}