21badd069d
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>
84 lines
2.2 KiB
TypeScript
84 lines
2.2 KiB
TypeScript
/**
|
|
* @schema AdminCreatePriceList
|
|
* type: object
|
|
* description: The price list's details.
|
|
* x-schemaName: AdminCreatePriceList
|
|
* required:
|
|
* - title
|
|
* - description
|
|
* properties:
|
|
* title:
|
|
* type: string
|
|
* title: title
|
|
* description: The price list's title.
|
|
* description:
|
|
* type: string
|
|
* title: description
|
|
* description: The price list's description.
|
|
* starts_at:
|
|
* type: string
|
|
* title: starts_at
|
|
* description: The date and time the price list starts at.
|
|
* format: date-time
|
|
* ends_at:
|
|
* type: string
|
|
* title: ends_at
|
|
* description: The date and time the price list ends at.
|
|
* format: date-time
|
|
* status:
|
|
* type: string
|
|
* description: The price list's status.
|
|
* enum:
|
|
* - active
|
|
* - draft
|
|
* type:
|
|
* type: string
|
|
* description: The price list's type.
|
|
* enum:
|
|
* - sale
|
|
* - override
|
|
* rules:
|
|
* type: object
|
|
* description: The price list's rules.
|
|
* example:
|
|
* product_category_id: pcat_123
|
|
* prices:
|
|
* type: array
|
|
* description: The price list's prices.
|
|
* items:
|
|
* type: object
|
|
* description: A price's details.
|
|
* required:
|
|
* - currency_code
|
|
* - variant_id
|
|
* - amount
|
|
* properties:
|
|
* currency_code:
|
|
* type: string
|
|
* title: currency_code
|
|
* description: The price's currency code.
|
|
* amount:
|
|
* type: number
|
|
* title: amount
|
|
* description: The price's amount.
|
|
* variant_id:
|
|
* type: string
|
|
* title: variant_id
|
|
* description: The ID of the product variant this price is for.
|
|
* min_quantity:
|
|
* type: number
|
|
* title: min_quantity
|
|
* description: The minimum quantity required in the cart for this price to be applied.
|
|
* max_quantity:
|
|
* type: number
|
|
* title: max_quantity
|
|
* description: The maximum quantity in the cart that shouldn't be crossed for this price to be applied.
|
|
* rules:
|
|
* type: object
|
|
* description: The price's rules.
|
|
* example:
|
|
* region_id: reg_123
|
|
*
|
|
*/
|
|
|