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

Wallet2 API (1.0)

Download OpenAPI specification:Download

OrderingStack wallet2 API

Authentication

oauth2

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

    batch

    expiredPaidBatches

    Expired paid batches in period.

    query Parameters
    year
    required
    integer <int32>
    month
    required
    integer <int32>
    header Parameters
    x-tenant
    string <uuid>

    Responses

    expiringPoints

    Points expiring in near future.

    header Parameters
    x-tenant
    string <uuid>

    Responses

    addBatch

    Create and add new batch of points. Batch can have expiration date and price for which points were bought..

    path Parameters
    wallet
    required
    string <uuid>
    header Parameters
    x-tenant
    string <uuid>
    Request Body schema: */*
    amount
    required
    number > 0
    price
    number > 0
    expires
    string <date-time>
    order
    string [ 0 .. 64 ] characters
    object

    Responses

    report

    expiredPaidBatches

    Expired paid batches in period.

    query Parameters
    year
    required
    integer <int32>
    month
    required
    integer <int32>
    header Parameters
    x-tenant
    string <uuid>

    Responses

    expiringPoints

    Points expiring in near future.

    header Parameters
    x-tenant
    string <uuid>

    Responses

    reward

    getRewardsList

    Get paginated list of rewards for administrative purposes. This endpoint is compatible with React AdminOnRest framework to provide DataSource.

    Authorizations:
    query Parameters
    required
    object (RewardsFilter)

    Responses

    createReward

    Create new reward

    Authorizations:
    Request Body schema: */*
    code
    string [ 1 .. 32 ] characters
    name
    required
    string [ 3 .. 128 ] characters [\p{L}\p{N}_. -]+
    visible
    boolean

    Visible in catalog and allowed to exchange for points by users themselves

    object (Details)
    availableFrom
    string <date-time>
    availableTo
    string <date-time>
    points
    required
    number > 0
    maxCount
    integer <int32> >= 1
    priority
    integer <int32> >= 0
    product
    required
    string
    productConfig
    object
    tags
    Array of strings [ 0 .. 16 ] items
    object

    Responses

    getReward

    Get single reward data

    Authorizations:
    path Parameters
    id
    required
    string <uuid>
    Example: 9cbe650a-1fb7-4b06-912b-cead8a013e8b

    Responses

    upsertReward

    Update reward data

    Authorizations:
    path Parameters
    id
    required
    string <uuid>
    Example: 9cbe650a-1fb7-4b06-912b-cead8a013e8b
    Request Body schema: */*
    code
    string [ 1 .. 32 ] characters
    name
    required
    string [ 3 .. 128 ] characters [\p{L}\p{N}_. -]+
    visible
    boolean

    Visible in catalog and allowed to exchange for points by users themselves

    object (Details)
    availableFrom
    string <date-time>
    availableTo
    string <date-time>
    points
    required
    number > 0
    maxCount
    integer <int32> >= 1
    priority
    integer <int32> >= 0
    product
    required
    string
    productConfig
    object
    tags
    Array of strings [ 0 .. 16 ] items
    object

    Responses

    deleteReward

    Delete reward. Be careful as this is not reversible.

    Authorizations:
    path Parameters
    id
    required
    string <uuid>
    Example: 9cbe650a-1fb7-4b06-912b-cead8a013e8b

    Responses

    getRewardsList_1

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

    Authorizations:
    query Parameters
    required
    object (RewardsFilter)

    Responses

    admin

    getRewardsList

    Get paginated list of rewards for administrative purposes. This endpoint is compatible with React AdminOnRest framework to provide DataSource.

    Authorizations:
    query Parameters
    required
    object (RewardsFilter)

    Responses

    createReward

    Create new reward

    Authorizations:
    Request Body schema: */*
    code
    string [ 1 .. 32 ] characters
    name
    required
    string [ 3 .. 128 ] characters [\p{L}\p{N}_. -]+
    visible
    boolean

    Visible in catalog and allowed to exchange for points by users themselves

    object (Details)
    availableFrom
    string <date-time>
    availableTo
    string <date-time>
    points
    required
    number > 0