Create a promotion

post

https://api.smoothpos.net/promotion.json

Creates a new promotion.

Required permission:

Group	Permission
Sales	Create, edit and delete promotions (includes view)

Body Params

code

string

customer_loyalty_tier

integer

required

customer_required

boolean

required

discount

number

discount_reason

string

required

discount_type

string

from_date

date-time

integer

Unique ID. Set by Smooth POS.

limit_customer_usage

integer

required

limit_customer_usage_months

integer

required

limit_usage

integer

required

maximum_item_quantity_requirement

integer

maximum_item_total_requirement

number

maximum_order_quantity_requirement

integer

maximum_order_total_tequirement

number

minimum_item_quantity_requirement

integer

minimum_item_total_requirement

number

minimum_order_quantity_requirement

integer

minimum_order_total_requirement

number

name

string

option1

object

option2

object

option3

object

product_filter

object

product_ids

object

product_marked_down

boolean

product_tags

object

product_types

object

product_vendors

object

products

array of objects

products

show_on_pos

boolean

required

store_filter

object

store_ids

object

store_tags

object

store_type

string

stores

array of objects

stores

to_date

date-time

used_times

integer

required

Responses

Language

Credentials

Header

Loading…

Response

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

application/json

200Success.

400The request couldn't be processed. Possible error messages: failed to create promotion incorrect data format

404Not found. Smooth POS also answers with a 404 when your token is missing or invalid, so check the error message. Possible error messages: not authorised