v1

latestOpenAPI 3.0.12026-07-24210349345.4 KB
PromoCodeQuery

Customer Validation

Validates each customer against the promotion's conditions and returns the results. The response includes the promocodeId and a list of customers with reward allocations for each customer. The effect will indicate which promotion tier was chosen for the customer, and what reward should be given.

post/v1/promocodes/{promocodeId}/validateCustomers

Path parameters

promocodeIdstring required

Query parameters

includeCustomerPropertiesboolean
includeRejectedEffectsboolean
dryRunboolean
idempotencyKeystring

Request body

Response

A successful response.

promocodeIdstring
promotionIdstring
validateNotification'NO_JOB_NOTIFICATION' | 'PROMOTION_NOT_ASSIGNED' | 'PROMOTION_PAUSED'
validateStatus'SUCCESS' | 'FAILURE'