Get promo code details.

The source of whether records are updated by HMAC or a USER. This will be automatically generated during the authentication process. For customers accessing the service the source will be set to CUSTOMER.

200

Success

Response body

object

promoCode

string

required

The promo code

purchaseDate

date-time

required

The date and time of purchase, in ISO8601 date/time format in UTC time zone

salesItemName

string

required

Sales item name

availableForUse

boolean

Flag indicating if promo code can be used

numberOfRedemptions

int32

Number of previous redemptions of the code

redemptionsPerCustomer

int32

Number of total available redemptions of the code

codeAvailability

object

If the item is only available from/to/between certain dates and times, indicates that time period. May be open at either end.

from

date-time

Date and time from which the item becomes available.

date-time

Date and time after which the item is no longer available.

promotionName

string

The name of the promotion the code belongs to

promotionDescription

string

The description of the promotion the code belongs to

promotionCampaign

string

The name of the campaign the promotion belongs to

promotionSource

string

The name of the source associated with the promotion

promotionAvailability

object

If the item is only available from/to/between certain dates and times, indicates that time period. May be open at either end.

from

date-time

Date and time from which the item becomes available.

date-time

Date and time after which the item is no longer available.

promotionActive

boolean

Flag indicating if promotion is active

batchAvailability

object

If the item is only available from/to/between certain dates and times, indicates that time period. May be open at either end.

from

date-time

Date and time from which the item becomes available.

date-time

Date and time after which the item is no longer available.

batchActive

boolean

Flag indicating if batch containg promo code is active

discounts

array of objects

discounts

object

int64

The unique identifier of the discount

name

string

The name of the discount

description

string

The description of the discount

friendReferred

boolean

Flag indicating if discount is avaiable with refer a friend code

discountedItems

array of objects

List of items to which a discount applies

discountedItems

object

string

the ID of the sales item

name

string

The name of the sales item

discountedItem

object

Details of a sales item to which a discount applies

string

the ID of the sales item

name

string

The name of the sales item

400

Bad request

404

Not found

200Success

400Bad request

404Not found