Mark coupon as used

POST

/cms/customer/coupon/set_used

const url = 'https://api.example.com/cms/customer/coupon/set_used';
const options = {
  method: 'POST',
  headers: {'API-Key': '<API-Key>', 'Content-Type': 'application/json'},
  body: '{"coupon_id":1,"code":"example"}'
};

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

curl --request POST \
  --url https://api.example.com/cms/customer/coupon/set_used \
  --header 'API-Key: <API-Key>' \
  --header 'Content-Type: application/json' \
  --data '{ "coupon_id": 1, "code": "example" }'

POST /customer/coupon/set_used

Authorizations

ApiKeyAuth

Request Body^required

application/json

object

coupon_id

Coupon ID

integer

code

Coupon code

string

Example ^generated

{
  "coupon_id": 1,
  "code": "example"
}

Responses

200

Coupon marked as used

application/json

object

success

boolean

Example ^generated

{
  "success": true
}

400

Bad Request

Mark coupon as used

Authorizations

Request Bodyrequired

Example generated

Responses

200

Example generated

400

Request Body^required

Example ^generated

Example ^generated