Create Discount

post

https://api.chowdeck.com/merchant/discount

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

reference

string

required

Defaults to DISCOUNT1234

A unique identifier for the discount.

title

string

required

Defaults to 25% Off

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

description

string

required

Defaults to Get 25% off your order

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

type

string

required

Defaults to percentage_off

The type of discount; flat_fee or percentage_off

value

string

required

Defaults to 25

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

category

string

enum

required

Defaults to price_slash_off_all_orders

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

Allowed:

expiry_date

string

required

Defaults to 2025-12-31

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

maximum_usage_times

integer

required

Defaults to 100

The maximum number of times this discount can be used.

vendor_references

array of strings

required

Defaults to ref_1234

An array of vendor references that this discount applies to

vendor_references*

minimum_order_amount

integer

required

Defaults to 2000

The minimum order amount required to use the discount

capped_amount

integer

Defaults to 50000

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

menu_references

array of strings

Defaults to testref121

An array of menu references that this discount applies to

menu_references

Response

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json