/coupons
GET
A GET
request can always be filtered by the get parameters defined in the introduction section of the api documentation.
Example GET request:
in order to see HIDDEN
objects you will need to send includeHidden=true
as a parameter to the GET
query
POST
Example POST object:
Name | Required | Restriction | Description |
---|---|---|---|
name | Yes | String | The name of the coupon. |
description | Yes | String | The description of the coupon. |
code | Yes | String | The promo code for the coupon. |
expiry | Yes | String | The expiry period of the coupon. |
type | Yes |
| The discount type of the coupon. |
discountMonetary | DiscountMonetary object (see below) | The monetary value of the coupon. This is required if discountType is | |
discountPercentage | Number | The percentage value of the coupon. This is required if discountType is | |
products | Array | An array of Products that are eligible for the coupon discount. If no products are selected then the coupon will apply to all products. | |
labels | Array | For searching purposes. | |
couponStatus | Yes |
| The status of the coupon. Once the coupon is |
validFrom | Yes | String | An ISO 8601 date and time of when coupon is valid from. |
validTo | Yes | String | An ISO 8601 date and time of when coupon is valid to. |
oneTimeValidity | Yes | Boolean | Specify whether the coupon is valid once. If true it is only valid once and cannot be reapplied. |
couponEndDateType | Yes |
| Specify when the coupon can be used until. For |
claimableAts | Yes |
| Specify where the coupon can be claimed. |
DiscountMonetary object
Name | Required | Restriction | Description |
---|---|---|---|
currency | Yes | String | The currency of the monetary value. |
amount | Yes | Number | The amount of the monetary value. |
Last updated