クーポン商品削除

DELETE

/coupons/{coupon_id}/type/{type}/division/{division}/products/{item_id}

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

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

対象プラン

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

Authorizations

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

Parameters

Path Parameters

coupon_id

required

string

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

type

required

string

Allowed values: 1 2

クーポンアイテムタイプ（1:適用条件、2:商品付与）

division

required

string

Allowed values: 1 2 3

クーポンアイテム区分：item_id の値が何を示すものかを指定します。（1:部門ID、2:商品ID、3:グループコード）
※クーポンアイテムタイプが 2.商品付与の場合、商品IDのみ指定できます。

item_id

required

string

<= 85 characters

アイテムID：クーポンに紐づくアイテムを特定するための、その区分におけるID。
※ ユーザーアクセストークンを利用する場合で商品IDを指定する場合、ユーザーの所属する店舗で販売している商品IDを指定してください。

Responses

200

削除成功

404

指定されたクーポンIDが存在しない場合
指定された部門IDが存在しない場合
指定された商品IDが存在しない場合
指定されたパスの組み合わせのクーポン商品が存在しない場合

application/json

object

type

required

string

title

required

string

detail

string

status

integer

Examples

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

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

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

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