Main docs page Auth API Ordering API Menu API Venue API Inventory API Payment API Loyalty API Wallet API

Loyalty API (1.0)

Download OpenAPI specification:Download

OrderingStack loyalty API

Authentication

oauth2

Standard token auth

Security Scheme Type OAuth2

oauth2-client

Internal authorization between microservices

Security Scheme Type OAuth2

getAccountsCount

Get count of accounts. This endpoint is compatible with React AdminOnRest framework to provide DataSource.

Authorizations:
oauth2 (ROLE_SUROLE_LOYALTY)
query Parameters
required
object (AccountFilter)

Responses

getAccounts

Get paginated list of accounts. This endpoint is compatible with React AdminOnRest framework to provide DataSource.

Authorizations:
oauth2 (ROLE_SUROLE_LOYALTY)
query Parameters
required
object (AccountFilter)

Responses

account

export

Export accounts matching criteria

Authorizations:
oauth2-clientoauth2 (ROLE_SUROLE_LOYALTY)
query Parameters
required
object (AccountFilter)
header Parameters
x-tenant
string [ 3 .. 64 ] characters [a-zA-Z0-9._-]+

Responses

getAccount

Get account

Authorizations:
oauth2-clientoauth2 (ROLE_SUROLE_LOYALTY)
path Parameters
account
required
string [ 3 .. 64 ] characters [a-zA-Z0-9._-]+
header Parameters
x-tenant
string [ 3 .. 64 ] characters [a-zA-Z0-9._-]+

Responses

getAccountByCard

Get account by card id

Authorizations:
oauth2-clientoauth2 (ROLE_SUROLE_LOYALTY)
path Parameters
account
required
string [ 3 .. 64 ] characters [a-zA-Z0-9._-]+
header Parameters
x-tenant
string [ 3 .. 64 ] characters [a-zA-Z0-9._-]+

Responses

getMyAccount

Get my account

Authorizations:

Responses

export

export

Export accounts matching criteria

Authorizations:
oauth2-clientoauth2 (ROLE_SUROLE_LOYALTY)
query Parameters
required
object (AccountFilter)
header Parameters
x-tenant
string [ 3 .. 64 ] characters [a-zA-Z0-9._-]+

Responses

event

segmentStats

Get stats for segments

Authorizations:
oauth2-clientoauth2 (ROLE_SUROLE_LOYALTYROLE_LOYALTY_STATS)
query Parameters
from
string <date>
to
string <date>
header Parameters
x-tenant
string [ 3 .. 64 ] characters [a-zA-Z0-9._-]+

Responses

globalCampaignStats

Get global stats for campaign

Authorizations:
oauth2-clientoauth2 (ROLE_SUROLE_LOYALTYROLE_LOYALTY_STATS)
query Parameters
name
required
string[a-zA-Z0-9_-]+
header Parameters
x-tenant
string [ 3 .. 64 ] characters [a-zA-Z0-9._-]+

Responses

campaignStats

Get stats for campaign

Authorizations:
oauth2-clientoauth2 (ROLE_SUROLE_LOYALTYROLE_LOYALTY_STATS)
query Parameters
name
required
string[a-zA-Z0-9_-]+
from
string <date>
to
string <date>
header Parameters
x-tenant
string [ 3 .. 64 ] characters [a-zA-Z0-9._-]+

Responses

postEvent

Post new event(s)

Authorizations:
oauth2-clientoauth2 (ROLE_SUROLE_LOYALTYROLE_LOYALTY_EVENT)
header Parameters
x-tenant
string [ 3 .. 64 ] characters [a-zA-Z0-9._-]+
Request Body schema: */*
Array ()
account
string [ 3 .. 64 ] characters [a-zA-Z0-9._-]+
card
string [ 3 .. 64 ] characters [a-zA-Z0-9._-]+
object (Consents)
ts
string <date-time>
type
required
string
id
required
string[a-zA-Z0-9_.-]+
doNotProcessSymmetry
boolean

Responses