47 lines
1.2 KiB
TypeScript
47 lines
1.2 KiB
TypeScript
/**
|
|
* @schema AdminCreatePromotionRule
|
|
* type: object
|
|
* description: The promotion rule's details.
|
|
* x-schemaName: AdminCreatePromotionRule
|
|
* required:
|
|
* - operator
|
|
* - attribute
|
|
* - values
|
|
* properties:
|
|
* operator:
|
|
* type: string
|
|
* description: The operator used to check whether the buy rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value.
|
|
* enum:
|
|
* - gt
|
|
* - lt
|
|
* - eq
|
|
* - ne
|
|
* - in
|
|
* - lte
|
|
* - gte
|
|
* description:
|
|
* type: string
|
|
* title: description
|
|
* description: The rule's description.
|
|
* attribute:
|
|
* type: string
|
|
* title: attribute
|
|
* description: The attribute to compare against when checking whether a promotion can be applied on a cart.
|
|
* example: item.product.id
|
|
* values:
|
|
* oneOf:
|
|
* - type: string
|
|
* title: values
|
|
* description: The attribute's value.
|
|
* example: prod_123
|
|
* - type: array
|
|
* description: The allowed attribute values.
|
|
* items:
|
|
* type: string
|
|
* title: values
|
|
* description: An attribute value.
|
|
* example: prod_123
|
|
*
|
|
*/
|
|
|