v1

latestOpenAPI 3.0.02026-08-04380104.3 KB

Discount

Create Discount

Create a new discount. Configure type (percentage or fixed), value, applicable vendors or menu items, expiry date, usage limits, and minimum order amount.

post/merchant/discount

Request body

referencestring required

A unique identifier for the discount.

titlestring required

The title of the discount that will be displayed to users.

descriptionstring required

A brief description of the discount and how it can be used.

typestring required

The type of discount; flat_fee or percentage_off

valuestring required

The value of the discount, which corresponds to the percentage or amount off.

category'price_slash_off_all_orders' | 'price_slash_off_menu' required

The category under which the discount falls, such as "price_slash_off_all_orders"

expiry_datestring required

The date when the discount will expire, formatted as YYYY-MM-DD.

maximum_usage_timesinteger required

The maximum number of times this discount can be used.

vendor_referencesstring[] required

An array of vendor references that this discount applies to

minimum_order_amountinteger required

The minimum order amount required to use the discount

capped_amountinteger

The maximum discount amount that can be applied. Required when category is 'price_slash_off_all_orders'; forbidden for other categories.

menu_referencesstring[]

An array of menu references that this discount applies to