Discount Codes

Discount codes can be added to a cart to enable certain cart discounts.

With discount codes it is possible to give specific cart discounts to an eligible amount of users. They are defined by a string value which can be added to a cart so that specific cart discounts can be applied to the cart.

• Representations
  • DiscountCode
  • DiscountCodeDraft
• Get DiscountCode by ID
• Query DiscountCodes
• Create a DiscountCode
• Update DiscountCode
  • Set Name
  • Set Description
  • Set Cart Predicate
  • Set Max Applications
  • Set Max Applications Per Customer
  • Change CartDiscounts
  • Change IsActive
• Delete DiscountCode

Representations

DiscountCode

• id - String
  The unique ID of the discount code.
• version - Number
• createdAt - DateTime
• lastModifiedAt - DateTime
• name - LocalizedString - Optional
• description - LocalizedString - Optional
• code - String
  Unique identifier of this discount code. This value is added to the cart to enable the related cart discounts in the cart.
• cartDiscounts - Array of Reference to a CartDiscount
  The referenced matching cart discounts can be applied to the cart once the DiscountCode is added.
• cartPredicate - CartDiscountPredicate - Optional
  The discount code can only be applied to carts that match this predicate.
• isActive - Boolean
• references - Array of Reference
  The platform will generate this array from the cartPredicate. It contains the references of all the resources that are addressed in the predicate.
• maxApplications - Number - Optional
  The discount code can only be applied maxApplications times.
• maxApplicationsPerCustomer - Number - Optional
  The discount code can only be applied maxApplicationsPerCustomer times per customer.

DiscountCodeDraft

• name - LocalizedString - Optional
• description - LocalizedString - Optional
• code - String
  Unique identifier of this discount code. This value is added to the cart to enable the related cart discounts in the cart.
• cartDiscounts - Array of Reference to a CartDiscount
  The referenced matching cart discounts can be applied to the cart once the discount code is added.
• cartPredicate - CartPredicate - Optional
  The discount code can only be applied to carts that match this predicate.
• isActive - Boolean
• maxApplications - Number - Optional
• maxApplicationsPerCustomer - Number - Optional

Get DiscountCode by ID

Endpoint: /{projectKey}/discount-codes/{id}
Method: GET
OAuth2 Scopes: view_orders:{projectKey}
Response Representation: DiscountCode

Query DiscountCodes

Endpoint: /{projectKey}/discount-codes
Method: GET
OAuth2 Scopes: view_orders:{projectKey}
Response Representation: PagedQueryResult with the results array of DiscountCode
Query Parameters:

• where - Predicate - Optional
• sort - Sort - Optional
• expand - Expansion - Optional
• limit - Number - Optional
• offset - Number - Optional

Create a DiscountCode

Endpoint: /{projectKey}/discount-codes
Method: POST
OAuth2 Scopes: manage_orders:{projectKey}
Request Representation: DiscountCodeDraft
Response Representation: DiscountCode

Update DiscountCode

Endpoint: /{projectKey}/discount-codes/{id}
Method: POST
OAuth2 Scopes: manage_orders:{projectKey}
Response Representation: DiscountCode
Fields:

• version - Number - Required
  The expected version of the channel on which the changes should be applied. If the expected version does not match the actual version, a 409 Conflict will be returned.
• actions - Array of UpdateAction - Required
  The list of update actions to be performed on the discount code.

Update Actions
Please find below the individual update actions provided on this endpoint.

Set Name

• action - String - "setName"
• name - LocalizedString
  If the name parameter is not included, the field will be emptied.

Set Description

• action - String - "setDescription"
• description - LocalizedString - Optional
  If the description parameter is not included, the field will be emptied.

Set Cart Predicate

• action - String - "setCartPredicate"
• cartPredicate - CartPredicate - Optional
  If the cartPredicate parameter is not included, the field will be emptied.

Set Max Applications

• action - String - "setMaxApplications"
• maxApplications - Number - Optional
  If the maxApplications parameter is not included, the field will be emptied.

Set Max Applications Per Customer

• action - String - "setMaxApplicationsPerCustomer"
• maxApplicationsPerCustomer - Number - Optional
  If the maxApplicationsPerCustomer parameter is not included, the field will be emptied.

Change CartDiscounts

• action - String - "changeCartDiscounts"
• cartDiscounts - Array of Reference to a CartDiscount - Required

Change IsActive

• action - String - "changeIsActive"
• isActive - Boolean - Required

Delete DiscountCode

This request deletes discount codes only if it’s not referenced by carts.

Endpoint: /{projectKey}/discount-code/{id}
Method: DELETE
OAuth2 Scopes: manage_orders:{projectKey} Query Parameters:

• version - Number - Required