Deprecated Coupons API (v0)
Download OpenAPI specification:Download
Important: This API is now deprecated and will not be available anymore from June 15th, 2023 onwards.
To create coupons, use the Manage coupons resource instead or use Omnichannel Manager to create coupons.
Represents a coupon definition from which coupons are generated. A coupon definition, is based on a discount.
To learn how to create them, refer to the Coupons tutorial.
Create coupon definition Deprecated
Creates a coupon definition, which is used to create coupons using the Create coupon method.
Authorizations:
Request Body schema: application/json
label required | string non-empty Label to identify the coupon definition by. Must be unique, second call with the same label will fail. |
pattern required | string non-empty RegEx pattern to generate the coupon code with. |
Array of Valid from validation rule object (object) or Valid to validation rule object (object) or Restricted to consumer id validation rule object (object) A list of validation rules applied by default to the coupons created with this coupon definition. | |
discount_rule_id required | string non-empty Unique identifier of the discount rule applied by default to the coupons. |
channel_types | Array of strings <= 5 items Items Enum: "web" "mobile" "mobile_ios" "mobile_android" "store" |
max_redemptions | integer >= 1 The maximum number of times a coupon based on this definition can be redeemed. |
Responses
Request samples
- Payload
{- "pattern": "coupondef-[A-Z]{3}[0-9]{3}",
- "validation_rules": [
- {
- "label": "valid_from",
- "values": {
- "valid_from": "2017-10-23T06:00:00.000Z"
}
}, - {
- "label": "valid_to",
- "values": {
- "valid_to": "2019-11-30T23:59:59.000Z"
}
}
], - "label": "cybermon678",
- "discount_rule_id": "f32f4cf6-f65d-4ed9-be4c-26a2b0552a51",
- "max_redemptions": 10000000
}
Response samples
- 200
{- "id": "c4c429fc-9744-41ea-87a0-e081092d63f9",
- "label": "cybermon679"
}
Get coupon definition Deprecated
Returns the coupon definition for the coupon with the specified ID.
Authorizations:
path Parameters
id required | string |
Responses
Response samples
- 200
{- "id": "c4c429fc-9744-41ea-87a0-e081092d63f9",
- "label": "cybermon678",
- "pattern": "coupondef-[A-Z]{3}[0-9]{3}",
- "validation_rules": [
- {
- "label": "valid_from",
- "values": {
- "valid_from": "2017-10-23T06:00:00.000Z"
}
}, - {
- "label": "valid_to",
- "values": {
- "valid_to": "2019-11-30T23:59:59.000Z"
}
}
], - "discount_rule_id": "f32f4cf6-f65d-4ed9-be4c-26a2b0552a51",
- "max_redemptions": 10000000
}
Update coupon definition Deprecated
Overwrites the coupon definition with the specified ID, using the updated coupon definition specified in the payload.
Authorizations:
path Parameters
id required | string |
Request Body schema: application/json
label required | string non-empty Label to identify the coupon definition by. Must be unique, second call with the same label will fail. |
pattern required | string non-empty RegEx pattern to generate the coupon code with. |
Array of Valid from validation rule object (object) or Valid to validation rule object (object) or Restricted to consumer id validation rule object (object) A list of validation rules applied by default to the coupons created with this coupon definition. | |
discount_rule_id required | string non-empty Unique identifier of the discount rule applied by default to the coupons. |
channel_types | Array of strings <= 5 items Items Enum: "web" "mobile" "mobile_ios" "mobile_android" "store" |
max_redemptions | integer >= 1 The maximum number of times a coupon based on this definition can be redeemed. |
Responses
Request samples
- Payload
{- "pattern": "coupondef-[A-Z]{3}[0-9]{3}",
- "validation_rules": [
- {
- "label": "valid_from",
- "values": {
- "valid_from": "2017-10-23T06:00:00.000Z"
}
}, - {
- "label": "valid_to",
- "values": {
- "valid_to": "2019-11-30T23:59:59.000Z"
}
}
], - "label": "cybermon678",
- "discount_rule_id": "f32f4cf6-f65d-4ed9-be4c-26a2b0552a51",
- "max_redemptions": 10000000
}
Response samples
- 200
{- "id": "c4c429fc-9744-41ea-87a0-e081092d63f9",
- "label": "cybermon678",
- "pattern": "coupondef-[A-Z]{3}[0-9]{3}",
- "validation_rules": [
- {
- "label": "valid_from",
- "values": {
- "valid_from": "2017-10-23T06:00:00.000Z"
}
}, - {
- "label": "valid_to",
- "values": {
- "valid_to": "2019-11-30T23:59:59.000Z"
}
}
], - "discount_rule_id": "f32f4cf6-f65d-4ed9-be4c-26a2b0552a51",
- "max_redemptions": 10000000
}
Represents a coupon that can be used by the customer during checkout. It is created from a coupon definition.
To learn how to create them, refer to this guide.
Create coupon Deprecated
Creates a coupon from an existing definition. This method links the existing coupon definition to the coupon.
Authorizations:
Request Body schema: application/json
label | string Optional label to apply to the coupon. |
template_label required | string non-empty Coupon definition (template) label to create coupon by. Multiple coupons can be created using the same label. |
Array of Valid from validation rule object (object) or Valid to validation rule object (object) or Restricted to consumer id validation rule object (object) or Minimal order total before discount validation rule object (object) A list of validation rules to be applied to the coupon. The list provided here is intersected with the one coupon definition (template) provides, and validation rules from this list either override the ones of the coupon definition or produce a conflict, depending on the rule. | |
object (Monetary amount object) DEPRECATED. Amount is taken from the discount rule. In the deprecated case of no discount rule, amount must be provided either here or on the corresponding definition (template). Amount provided here can not override the one provided by coupon definition. | |
discount_rule_id | string non-empty DEPRECATED. Use coupon definitions (templates) with attached discount_rule_id. Unique identifier of the discount rule which is attached to the coupon. |
Responses
Request samples
- Payload
{- "label": "loyaltyfeb",
- "template_label": "loyalty",
- "validation_rules": [
- {
- "values": {
- "consumer_id": "8de1d881-2572-4848-b3f7-e8cb9a45b4f5"
}, - "label": "restricted_to_consumer_id"
}
]
}
Response samples
- 200
{- "label": "loyalty_feb",
- "code": "COUPON_bf3sK",
- "id": "5d3e00b3-20c1-4268-832c-e299527e3d33",
- "is_enabled": true
}
[DEPRECATED] Update coupon Deprecated
This endpoint is deprecated. Use Update coupon partially instead.
Updates the is_enabled
parameter of a coupon. When set to false
the coupon is not redeemable and cannot be used during checkout.
Authorizations:
path Parameters
id required | string coupon ID |
Request Body schema: application/json
is_enabled | boolean Is true when the coupon is enabled |
Array of Valid from validation rule object (object) or Valid to validation rule object (object) or Restricted to consumer id validation rule object (object) or Minimal order total before discount validation rule object (object) A list of validation rules to be applied to the coupon. The list provided here is intersected with the one coupon definition (template) provides, and validation rules from this list either override the ones of the coupon definition or produce a conflict, depending on the rule. |
Responses
Request samples
- Payload
{- "is_enabled": false,
- "validation_rules": [
- {
- "values": {
- "consumer_id": "8de1d881-2572-4848-b3f7-e8cb9a45b4f5"
}, - "label": "restricted_to_consumer_id"
}
]
}
Response samples
- 200
null
Update coupon partially Deprecated
Updates several parameters of a coupon. When is_enabled
is set to false
,
the coupon is not redeemable and cannot be used during checkout.
Authorizations:
path Parameters
id required | string coupon ID |
Request Body schema: application/json
is_enabled | boolean Is true when the coupon is enabled |
Array of Valid from validation rule object (object) or Valid to validation rule object (object) or Restricted to consumer id validation rule object (object) or Minimal order total before discount validation rule object (object) A list of validation rules to be applied to the coupon. The list provided here is intersected with the one coupon definition (template) provides, and validation rules from this list either override the ones of the coupon definition or produce a conflict, depending on the rule. |
Responses
Request samples
- Payload
{- "is_enabled": false,
- "validation_rules": [
- {
- "values": {
- "consumer_id": "8de1d881-2572-4848-b3f7-e8cb9a45b4f5"
}, - "label": "restricted_to_consumer_id"
}
]
}
Response samples
- 200
{- "label": "loyalty_feb",
- "code": "COUPON_bf3sK",
- "id": "5d3e00b3-20c1-4268-832c-e299527e3d33",
- "is_enabled": false
}
Create coupon template Deprecated
Creates a coupon template which is later used to create a coupon itself.
Authorizations:
Request Body schema: application/json
label required | string non-empty Label to identify the coupon template by. Must be unique, second call with the same label will fail. |
pattern required | string non-empty RegEx pattern to generate the coupon code with. |
Array of Valid from validation rule object (object) or Valid to validation rule object (object) or Restricted to consumer id validation rule object (object) or Minimal order total before discount validation rule object (object) A list of validation rules that are going to be applied by default to the coupons, created with this coupon template. | |
object (Monetary amount object) Amount to be applied to the coupons created with this coupon template. |
Responses
Request samples
- Payload
{- "label": "string",
- "pattern": "string",
- "validation_rules": [
- {
- "label": "valid_from",
- "values": {
- "valid_from": "2019-08-24T14:15:22Z"
}
}
], - "amount": {
- "value": 0,
- "currency": "string"
}
}
Response samples
- 200
{- "id": "string",
- "label": "string"
}