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

Security Scheme Type OAuth2
password OAuth Flow
Token URL: https://ordering.3e.pl/auth-oauth2/{tenant}/oauth/token
Scopes:

    account

    getAccount

    Get account

    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

    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

    Responses

    segmentNew

    List new accounts (no sale, but recorder activity with order)

    query Parameters
    required
    object (SegmentNewRequest)

    Responses

    segmentLapsing

    List accounts that had orders in past, but no recent orders

    query Parameters
    required
    object (SegmentLapsingRequest)

    Responses

    segmentActiveCount

    List active accounts that had orders (by count)

    query Parameters
    required
    object (SegmentActiveCountRequest)

    Responses

    segmentActiveAmount

    List active accounts that had orders (by amount)

    query Parameters
    required
    object (SegmentActiveAmountRequest)

    Responses

    event

    postEvent

    Post new event(s)

    header Parameters
    x-tenant
    string [ 3 .. 64 ] characters [a-zA-Z0-9._-]+
    Request Body schema: */*
    Array ()

    Responses

    export

    segmentNew

    List new accounts (no sale, but recorder activity with order)

    query Parameters
    required
    object (SegmentNewRequest)

    Responses

    segmentLapsing

    List accounts that had orders in past, but no recent orders

    query Parameters
    required
    object (SegmentLapsingRequest)

    Responses

    segmentActiveCount

    List active accounts that had orders (by count)

    query Parameters
    required
    object (SegmentActiveCountRequest)

    Responses

    segmentActiveAmount

    List active accounts that had orders (by amount)

    query Parameters
    required
    object (SegmentActiveAmountRequest)

    Responses