fa7c94b4cc
* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
106 lines
3.2 KiB
YAML
106 lines
3.2 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. The type affects the available resources
|
|
associated with the condition. For example, if the type is `products`,
|
|
that means the `products` relation will hold the products associated with
|
|
this condition and other relations will be empty.
|
|
type: string
|
|
enum:
|
|
- products
|
|
- product_types
|
|
- product_collections
|
|
- product_tags
|
|
- customer_groups
|
|
operator:
|
|
description: >-
|
|
The operator of the condition. `in` indicates that discountable resources
|
|
are within the specified resources. `not_in` indicates that discountable
|
|
resources are everything but the specified resources.
|
|
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: The details of the discount rule associated with the condition.
|
|
x-expandable: discount_rule
|
|
nullable: true
|
|
$ref: ./DiscountRule.yaml
|
|
products:
|
|
description: products associated with this condition if `type` is `products`.
|
|
type: array
|
|
x-expandable: products
|
|
items:
|
|
$ref: ./Product.yaml
|
|
product_types:
|
|
description: Product types associated with this condition if `type` is `product_types`.
|
|
type: array
|
|
x-expandable: product_types
|
|
items:
|
|
$ref: ./ProductType.yaml
|
|
product_tags:
|
|
description: Product tags associated with this condition if `type` is `product_tags`.
|
|
type: array
|
|
x-expandable: product_tags
|
|
items:
|
|
$ref: ./ProductTag.yaml
|
|
product_collections:
|
|
description: >-
|
|
Product collections associated with this condition if `type` is
|
|
`product_collections`.
|
|
type: array
|
|
x-expandable: product_collections
|
|
items:
|
|
$ref: ./ProductCollection.yaml
|
|
customer_groups:
|
|
description: >-
|
|
Customer groups associated with this condition if `type` is
|
|
`customer_groups`.
|
|
type: array
|
|
x-expandable: customer_groups
|
|
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
|
|
externalDocs:
|
|
description: Learn about the metadata attribute, and how to delete and update it.
|
|
url: >-
|
|
https://docs.medusajs.com/development/entities/overview#metadata-attribute
|