chore(docs): Generated API Reference (#3211)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
9997485c55
commit
14b2de94e2
@@ -2,13 +2,18 @@ title: Discount Condition
|
||||
description: Holds rule conditions for when a discount is applicable
|
||||
type: object
|
||||
required:
|
||||
- type
|
||||
- operator
|
||||
- created_at
|
||||
- deleted_at
|
||||
- discount_rule_id
|
||||
- id
|
||||
- metadata
|
||||
- operator
|
||||
- type
|
||||
- updated_at
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The discount condition's ID
|
||||
type: string
|
||||
example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
|
||||
type:
|
||||
description: The type of the Condition
|
||||
@@ -26,11 +31,12 @@ properties:
|
||||
- in
|
||||
- not_in
|
||||
discount_rule_id:
|
||||
type: string
|
||||
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: >-
|
||||
@@ -38,55 +44,52 @@ properties:
|
||||
the relation `products` is expanded.
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
description: A product object.
|
||||
$ref: ./Product.yaml
|
||||
product_types:
|
||||
description: >-
|
||||
product types associated with this condition if type = product_types.
|
||||
Product types associated with this condition if type = product_types.
|
||||
Available if the relation `product_types` is expanded.
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
description: A product type object.
|
||||
$ref: ./ProductType.yaml
|
||||
product_tags:
|
||||
description: >-
|
||||
product tags associated with this condition if type = product_tags.
|
||||
Product tags associated with this condition if type = product_tags.
|
||||
Available if the relation `product_tags` is expanded.
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
description: A product tag object.
|
||||
$ref: ./ProductTag.yaml
|
||||
product_collections:
|
||||
description: >-
|
||||
product collections associated with this condition if type =
|
||||
Product collections associated with this condition if type =
|
||||
product_collections. Available if the relation `product_collections` is
|
||||
expanded.
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
description: A product collection object.
|
||||
$ref: ./ProductCollection.yaml
|
||||
customer_groups:
|
||||
description: >-
|
||||
customer groups associated with this condition if type = customer_groups.
|
||||
Customer groups associated with this condition if type = customer_groups.
|
||||
Available if the relation `customer_groups` is expanded.
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
description: A customer group object.
|
||||
$ref: ./CustomerGroup.yaml
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was updated.
|
||||
type: string
|
||||
format: date-time
|
||||
deleted_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was deleted.
|
||||
nullable: true
|
||||
type: string
|
||||
format: date-time
|
||||
metadata:
|
||||
type: object
|
||||
description: An optional key-value map with additional details
|
||||
nullable: true
|
||||
type: object
|
||||
example:
|
||||
car: white
|
||||
|
||||
Reference in New Issue
Block a user