Skip to main content
Skip to main content

AdminPostDiscountsDiscountReq

admin/discounts.internal.AdminPostDiscountsDiscountReq

Schema

The ID of the Ruletotal indicates that the discount should be applied on the cart total, and item indicates that the discount should be applied to each discountable item in the cart." enum: [total, item] conditions: type: array description: "A set of conditions that can be used to limit when the discount can be used. Only one of products, product_types, product_collections, product_tags, and customer_groupsThe ID of the conditionin indicates that discountable resources are within the specified resources. not_in indicates that discountable resources are everything but the specified resources." enum: [in, not_in] products: type: array description: list of product IDs if the condition's type is products. items: type: string product_types: type: array description: list of product type IDs if the condition's type is product_types. items: type: string product_collections: type: array description: list of product collection IDs if the condition's type is product_collections. items: type: string product_tags: type: array description: list of product tag IDs if the condition's type is product_tags. items: type: string customer_groups: type: array description: list of customer group IDs if the condition's type is customer_groups. items: type: string is_disabled: type: boolean description: Whether the discount code is disabled on creation. If set to trueLearn about the metadata attribute, and how to delete and update it.

Properties

codestring
ends_atnull | Date
is_disabledboolean
metadataRecord<string, unknown>
regionsstring[]
starts_atDate
usage_limitnull | number
valid_durationnull | string
Was this section helpful?