クーポン削除

DELETE

/coupons/{coupon_id}

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/coupons/example';
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/coupons/example \
  --header 'Authorization: Bearer <token>'

指定されたクーポンを削除します。

対象プラン

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

Authorizations

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

Parameters

Path Parameters

coupon_id

required

string

クーポンID
※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で販売している商品のみをクーポン商品として持つクーポンのIDを指定してください。

Responses

200

削除成功

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
}