Skip to main content
PUT
Check discount code validity

Body

application/json

Request containing customer ID and discount code to validate

customerId
integer<int64>
required

Shopify customer ID (numeric). Identifies which customer is attempting to use the discount code. Used to verify the discount code belongs to this customer. Example: 67890

Example:

67890

discountCode
string
required

The discount code to validate. Case-insensitive. This is the code the customer enters at checkout. System will check if:

  • Code exists in loyalty system
  • Code belongs to this customer
  • Code status is UNUSED or ACTIVE
  • Code has not expired Examples: "LOYALTY15OFF", "VIP20", "WELCOME10"
Maximum string length: 100
Example:

"LOYALTY15OFF"

Response

Discount code is valid and reward details returned

createAt
string<date-time>
required
customerId
integer<int64>
required
discountCode
string
required
shop
string
required
status
enum<string>
required
Available options:
USED,
UNUSED,
REFUNDED,
EXPIRED,
SUBSCRIPTION_ACTIVE,
CANCELED
amount
number<double>
description
string
discountCodeId
string
expireDate
string<date-time>
id
integer<int64>
lastExpiryReminderSentDate
string<date-time>
orderId
integer<int64>
orderName
string
pointRedeemRuleId
integer<int64>
pointTransactionId
integer<int64>
productData
string
rewardType
enum<string>
Available options:
STORE_CREDIT,
DISCOUNT_CODE,
POINTS
usageCount
integer<int64>
usedAt
string<date-time>
variantId
integer<int64>