96 lines
2.6 KiB
YAML
96 lines
2.6 KiB
YAML
title: Discount Condition
|
|
description: Holds rule conditions for when a discount is applicable
|
|
type: object
|
|
required:
|
|
- created_at
|
|
- deleted_at
|
|
- discount_rule_id
|
|
- id
|
|
- metadata
|
|
- operator
|
|
- type
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
description: The discount condition's ID
|
|
type: string
|
|
example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
|
|
type:
|
|
description: The type of the Condition
|
|
type: string
|
|
enum:
|
|
- products
|
|
- product_types
|
|
- product_collections
|
|
- product_tags
|
|
- customer_groups
|
|
operator:
|
|
description: The operator of the Condition
|
|
type: string
|
|
enum:
|
|
- in
|
|
- not_in
|
|
discount_rule_id:
|
|
description: The ID of the discount rule associated with the condition
|
|
type: string
|
|
example: dru_01F0YESMVK96HVX7N419E3CJ7C
|
|
discount_rule:
|
|
description: Available if the relation `discount_rule` is expanded.
|
|
nullable: true
|
|
$ref: ./DiscountRule.yaml
|
|
products:
|
|
description: >-
|
|
products associated with this condition if type = products. Available if
|
|
the relation `products` is expanded.
|
|
type: array
|
|
items:
|
|
$ref: ./Product.yaml
|
|
product_types:
|
|
description: >-
|
|
Product types associated with this condition if type = product_types.
|
|
Available if the relation `product_types` is expanded.
|
|
type: array
|
|
items:
|
|
$ref: ./ProductType.yaml
|
|
product_tags:
|
|
description: >-
|
|
Product tags associated with this condition if type = product_tags.
|
|
Available if the relation `product_tags` is expanded.
|
|
type: array
|
|
items:
|
|
$ref: ./ProductTag.yaml
|
|
product_collections:
|
|
description: >-
|
|
Product collections associated with this condition if type =
|
|
product_collections. Available if the relation `product_collections` is
|
|
expanded.
|
|
type: array
|
|
items:
|
|
$ref: ./ProductCollection.yaml
|
|
customer_groups:
|
|
description: >-
|
|
Customer groups associated with this condition if type = customer_groups.
|
|
Available if the relation `customer_groups` is expanded.
|
|
type: array
|
|
items:
|
|
$ref: ./CustomerGroup.yaml
|
|
created_at:
|
|
description: The date with timezone at which the resource was created.
|
|
type: string
|
|
format: date-time
|
|
updated_at:
|
|
description: The date with timezone at which the resource was updated.
|
|
type: string
|
|
format: date-time
|
|
deleted_at:
|
|
description: The date with timezone at which the resource was deleted.
|
|
nullable: true
|
|
type: string
|
|
format: date-time
|
|
metadata:
|
|
description: An optional key-value map with additional details
|
|
nullable: true
|
|
type: object
|
|
example:
|
|
car: white
|