Set discount code

Set codes on the cart which may enable a discount. The combination of all parts of the promo code must match a valid combination set up in the system. The combination may provide a discount, if a discount is set up for the combination of sales item and provided codes.

Response CodeFault CodeFaultSuggested User Message
40490040NoCartFoundFaultCart does not exist
50090061SystemFailureFaultSystem Failure, please try again later
40490022InvalidDiscountCodeFaultDiscount does not exist
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The ID of the customer who owns the cart

int64
required

The ID of the cart to set discount code on

Body Params

The discount code to be set on the cart

Details of a code to be applied to the cart which may trigger a discount

string

The campaign which the code is part of. If not supplied defaults to NONE.

string

The source of the code. If not supplied defaults to NONE.

string
required

The code which may provide a discount.

int64

If a specific discount is required, the ID of the discount. The criteria for the discount must match one of the items in the cart, and the codes provided here.

string

A refer a friend code which may provide a discount.

string

An individual (single-use) promocode.

Headers
string

The tenant ID for which the operation is being carried out. This will be automatically generated during the authentication process.

string

The ID of a user who is performing the operation. This will be automatically generated during the authentication process.

string
enum

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.

Allowed:
Responses

Language
LoadingLoading…
Response
Choose an example:
application/json