Validate coupon code - Way Docs

POST

/

v1

/

brands

/

{brandId}

/

coupon-codes

/

{couponCode}

/

validate

Validate coupon code

curl --request POST \
  --url https://api.letsway.com/v1/brands/{brandId}/coupon-codes/{couponCode}/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.letsway.com/v1/brands/{brandId}/coupon-codes/{couponCode}/validate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.letsway.com/v1/brands/{brandId}/coupon-codes/{couponCode}/validate"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "id": "coupon-123",
  "code": "DISCOUNT50",
  "type": "percentage",
  "discountType": "fixed_amount",
  "value": 50,
  "experienceIds": [
    "exp-1",
    "exp-2"
  ]
}

Authorizations

Authorization

string

header

required

Your brand's secret API key, e.g. Bearer way_sk_live_bhEqcn0i1fRoUEHBPjJkQA. The key names the brand, so a brandId in the path must be your own brand. Older Way-Brand-Id + Way-Secret-Key credentials still work: see Legacy authentication.

Path Parameters

brandId

string

required

The brand's ID. With a brand key this must be your own brand; with an organization key it can be any brand in the organization.

couponCode

string

required

The coupon code to validate, as entered by the guest.

Body

application/json

The body is of type object.

Response

201 - application/json

Validate coupon code.

id

string

required

The unique identifier of the coupon.

Example:

"coupon-123"

code

string

required

The coupon code.

Example:

"DISCOUNT50"

type

string

required

The type of the coupon.

Example:

"percentage"

discountType

string

required

The discount type.

Example:

"fixed_amount"

value

number

required

The value of the discount.

Example:

50

experienceIds

string[]

List of experience IDs associated with the coupon.

Example:

["exp-1", "exp-2"]

⌘I

Validate coupon code

curl --request POST \
  --url https://api.letsway.com/v1/brands/{brandId}/coupon-codes/{couponCode}/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.letsway.com/v1/brands/{brandId}/coupon-codes/{couponCode}/validate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.letsway.com/v1/brands/{brandId}/coupon-codes/{couponCode}/validate"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "id": "coupon-123",
  "code": "DISCOUNT50",
  "type": "percentage",
  "discountType": "fixed_amount",
  "value": 50,
  "experienceIds": [
    "exp-1",
    "exp-2"
  ]
}