Create Loyalty Program

post

https://api.ewitypos.com/apps-v1/customers/loyalty-programs

Creates a loyalty program. Requires the p/manage-loyalty permission and a paid subscription. The only supported type is point (Simple Point Based). Only one program may be is_default at a time; the default program auto-enrolls any customer not yet in a loyalty program when a sale is recorded for them.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

length ≤ 100

type

string

enum

required

Allowed:

is_default

boolean | null

config

object

required

Point-program configuration. conversion — points per 1 unit of currency (points = amount x conversion when paying with points and when converting a money value to points). accrual_basis — bill-percentage (of bill total, default) or bill-subtotal-percentage (of total before tax and fees). accrual_value — the percentage earned. decimal_digits — points precision (default 0). rounding_strategy — round (default), ceil or floor. accrual — booleans if_discount, if_loyalty_payment, if_gift_card; each allows point accrual on bills with a discount / loyalty payment / gift-card payment (all default false, i.e. such bills earn no points).

Headers

X-Ewity-Store

string

required

The merchant install this request acts on (install.store_id from the app.installed webhook).

Response

Language

Credentials

Bearer

Loading…

Response

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

application/json

200Program created. The response body is an empty object.