Create discount

Create a discount. Fields are interpreted per use_type (e.g. bogo_/collection_ apply only to those types). Manual discounts are POS-only: order-type/source/scheduling fields are ignored and apply_type is always cart. promo_code uniqueness is case-insensitive. image/tv_image accept a file id from POST /file/upload; the banner image is honored for collection discounts. Collection discounts require collection_name, display_name, and image.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
string
integer

2 = fixed amount, 3 = percent

float
boolean
string
enum

manual | auto_apply | promo_code | bogo | collection. The model also knows custom_discount, but it cannot be created or filtered through this API.

Allowed:
string

item | cart

string

active | inactive

string | null
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
string | null
string | null
boolean
happy_weekdays
array of strings
happy_weekdays
float | null
float | null
string | null
integer | null

Max quantity of one product the discount applies to. Item discounts (apply_type=item) only; rejected for manual/bogo discounts and for apply_type=cart.

integer | null

Potify display priority (1-100). Saved only for collection discounts or when is_show_promo_code_on_potify is true; rejected otherwise.

integer | null
integer | null
boolean
string | null
string | null

Collection discounts only — required on create together with display_name and image (file id from POST /file/upload). Stored as the discount name; responses return it in name.

boolean
boolean
boolean
string | null

Banner image URL (collection discounts).

string | null

Collection-tile image URL.

offices
array of integers
offices
products
array of integers
products
product_categories
array of integers
product_categories
brands
array of integers
brands
product_vendors
array of integers
product_vendors
product_tags
array of integers
product_tags
patient_groups
array of integers
patient_groups
patient_types
array of integers
patient_types
subscription_plans
array of integers
subscription_plans
collection_groups
array of integers
collection_groups
discount_hours
array of objects
discount_hours
product_filter
Responses

400

Validation error

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json