Create Discount Rule

View as Markdown

Headers

{{tenant_key_name}}stringOptional

Request

This endpoint expects a multipart form.
codestringRequired

Optional: Coupon code - max 100 chars - “SUMMER10”

namestringRequired

Required: Discount rule name - max 255 chars - “Summer Sale 10%”

scopestringRequired

Optional: Discount scope - all_items|specific_items|specific_categories|specific_item_types

statusstringRequired

Optional: Rule status - active|inactive|expired - default active

prioritystringRequired

Optional: Priority when multiple apply - integer, min 0 - higher first

valid_tostringRequired

Optional: Valid to date - YYYY-MM-DD, must be after valid_from

valid_fromstringRequired

Required: Valid from date - YYYY-MM-DD

descriptionstringRequired

Optional: Rule description

is_stackablestringRequired

Optional: Can stack with other discounts - 0|1 - default false

members_onlystringRequired

Optional: Members only - 0|1 - default false

min_quantitystringRequired

Optional: Minimum quantity - numeric, min 0

discount_typestringRequired

Required: Discount type - percentage|fixed_amount|free_item

discount_valuestringRequired

Required: Discount value - numeric, min 0 - “10” (10% or $10)

max_total_usesstringRequired

Optional: Maximum total uses - integer, min 1 - “100”

first_time_onlystringRequired

Optional: First-time customer only - 0|1 - default false

max_discount_amountstringRequired

Optional: Max discount cap - numeric, min 0 - “50”

min_purchase_amountstringRequired

Optional: Minimum purchase amount - numeric, min 0

max_uses_per_customerstringRequired

Optional: Max uses per customer - integer, min 1 - “1”

Response

Successful response