Apply Basket Promocode

Applies a promotional code to a basket.

basket_idstring required

promocodestring required

currencystring

Currency to display event prices.

user_idstring

domainstring

Domain to validate promocode against. If not included then profile domains will be used

profile_namestring

Profile name

hostnamestring

Associated hostname

originstring

X-Correlation-IDstring

Optional transaction reference provided by the client. Used to correlate API requests and responses with client flow in logs, errors etc.

Response

Successful Response

_idstring required

external_referencestring

Distributor reference for this basket

checkout_status'not_checked_out' | 'checkout_pending' | 'payment_failed' | 'checked_out' | 'checked_out_with_errors'

not_checked_out: the basket has neither been, nor is being checked out
checkout_pending: the basket is currently in the process of checking out
payment_failed: the basket payment failed, and thus wasn't checked out
checked_out: the basket has already been checked out
checked_out_with_errors: the basket has been checked out but 1 or more items errored

created_onstring date-time

distributor_idstring

User ID of the event distributor which created this basket

profile_external_user_idstring

External user ID used in handle_profile_post_checkout

total_local_price_ttlstring date-time

Expiry datetime for the total_local_price_currency value/exchange rate, set by Stripe.

total_local_price_exchange_ratestring

    Exchange rate used to convert the total price to the local currency, set by Stripe. An average of exchange rates for all items in the basket.
    This only differs from total_local_price_base_exchange_rate when the basket contains items with their own exchange rate, such as vivid USD

total_local_price_base_exchange_ratestring

Exchange rate set by Stripe.

v3

Apply Basket Promocode

Query parameters

Headers

Response