Files
medusa-store/www/utils/generated/oas-output/schemas/AdminCreatePromotionRule.ts
github-actions[bot] 21badd069d chore(docs): Updated API Reference (v2) (#9437)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-10-03 07:48:54 +00:00

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:
* - gte
* - lte
* - gt
* - lt
* - eq
* - ne
* - in
* 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: items.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
*
*/