112 lines
3.4 KiB
YAML
112 lines
3.4 KiB
YAML
type: object
|
|
properties:
|
|
code:
|
|
type: string
|
|
description: A unique code that will be used to redeem the Discount
|
|
rule:
|
|
description: The Discount Rule that defines how Discounts are calculated
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The ID of the Rule
|
|
description:
|
|
type: string
|
|
description: A short description of the discount
|
|
value:
|
|
type: number
|
|
description: >-
|
|
The value that the discount represents; this will depend on the type
|
|
of the discount
|
|
allocation:
|
|
type: string
|
|
description: The scope that the discount should apply to.
|
|
enum:
|
|
- total
|
|
- item
|
|
conditions:
|
|
type: array
|
|
description: >-
|
|
A set of conditions that can be used to limit when the discount can be
|
|
used. Only one of `products`, `product_types`, `product_collections`,
|
|
`product_tags`, and `customer_groups` should be provided.
|
|
items:
|
|
type: object
|
|
required:
|
|
- operator
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The ID of the Rule
|
|
operator:
|
|
type: string
|
|
description: Operator of the condition
|
|
enum:
|
|
- in
|
|
- not_in
|
|
products:
|
|
type: array
|
|
description: list of product IDs if the condition is applied on products.
|
|
items:
|
|
type: string
|
|
product_types:
|
|
type: array
|
|
description: >-
|
|
list of product type IDs if the condition is applied on product
|
|
types.
|
|
items:
|
|
type: string
|
|
product_collections:
|
|
type: array
|
|
description: >-
|
|
list of product collection IDs if the condition is applied on
|
|
product collections.
|
|
items:
|
|
type: string
|
|
product_tags:
|
|
type: array
|
|
description: >-
|
|
list of product tag IDs if the condition is applied on product
|
|
tags.
|
|
items:
|
|
type: string
|
|
customer_groups:
|
|
type: array
|
|
description: >-
|
|
list of customer group IDs if the condition is applied on
|
|
customer groups.
|
|
items:
|
|
type: string
|
|
is_disabled:
|
|
type: boolean
|
|
description: >-
|
|
Whether the Discount code is disabled on creation. You will have to enable
|
|
it later to make it available to Customers.
|
|
starts_at:
|
|
type: string
|
|
format: date-time
|
|
description: The time at which the Discount should be available.
|
|
ends_at:
|
|
type: string
|
|
format: date-time
|
|
description: The time at which the Discount should no longer be available.
|
|
valid_duration:
|
|
type: string
|
|
description: Duration the discount runs between
|
|
example: P3Y6M4DT12H30M5S
|
|
usage_limit:
|
|
type: number
|
|
description: Maximum times the discount can be used
|
|
regions:
|
|
description: >-
|
|
A list of Region ids representing the Regions in which the Discount can be
|
|
used.
|
|
type: array
|
|
items:
|
|
type: string
|
|
metadata:
|
|
description: An object containing metadata of the discount
|
|
type: object
|