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

Wallet API (1.0)

Download OpenAPI specification:Download

OrderingStack wallet API

Authentication

oauth2

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

    report

    getAggregatedReport

    Get aggregated report. This endpoint is compatible with React AdminOnRest framework to provide DataSource.

    Authorizations:
    query Parameters
    required
    object (AggregateFilter)

    Responses

    expiredPaidBatches

    Expired paid batches in period.

    query Parameters
    from
    required
    string <date-time>
    to
    required
    string <date-time>
    header Parameters
    x-tenant
    string <uuid>

    Responses

    walletsReport

    Wallets.

    header Parameters
    x-tenant
    string <uuid>

    Responses

    vouchers

    Vouchers in period.

    query Parameters
    from
    required
    string <date-time>
    to
    required
    string <date-time>
    header Parameters
    x-tenant
    string <uuid>

    Responses

    batch

    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

    expiredPaidBatches

    Expired paid batches in period.

    query Parameters
    from
    required
    string <date-time>
    to
    required
    string <date-time>
    header Parameters
    x-tenant
    string <uuid>

    Responses

    user

    getMyBatches

    Get active batches for my wallet. This endpoint is compatible with React AdminOnRest framework to provide DataSource.

    Authorizations:
    query Parameters
    required
    object (MyBatchesFilter)

    Responses

    getMyOperations

    Get operations for my wallet. This endpoint is compatible with React AdminOnRest framework to provide DataSource.

    Authorizations:
    query Parameters
    required
    object (MyOperationsFilter)

    Responses

    operation

    addOperation

    New operation (usage of collected points)

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

    Responses

    rollbackOperation

    Operation rollback (points are returned to batches they were collected from).

    path Parameters
    wallet
    required
    string <uuid>
    header Parameters
    x-tenant
    string <uuid>
    Request Body schema: */*
    string <uuid>

    Responses

    wallet

    walletsReport

    Wallets.

    header Parameters
    x-tenant
    string <uuid>

    Responses

    getMyWallet

    Get wallet for logged user. If it is not created - get 404.

    Responses

    createMyWallet

    Create wallet for logged user. If wallet is already there - nothing happens.

    Responses

    getWallet

    Get wallet for specific user. If it is not created - get 404.

    path Parameters
    wallet
    required
    string <uuid>
    header Parameters
    x-tenant
    string <uuid>

    Responses

    putWallet

    Update wallet for logged user. If wallet was not there - it is created.

    path Parameters
    wallet
    required
    string <uuid>
    header Parameters
    x-tenant
    string <uuid>
    Request Body schema: */*
    property name*
    string

    Responses

    postWallet

    Create wallet for specific user. If wallet is already there - attributes are overwritten if they are provided and not empty.

    path Parameters
    wallet
    required
    string <uuid>
    header Parameters
    x-tenant
    string <uuid>
    Request Body schema: */*
    property name*
    string

    Responses

    voucher

    vouchers

    Vouchers in period.

    query Parameters
    from
    required
    string <date-time>
    to
    required
    string <date-time>
    header Parameters
    x-tenant
    string <uuid>

    Responses

    createVoucher

    Create new voucher. Expiration date for voucher can be provided (it also applies to batch of points from that voucher). Additionaly points can last for specified number of days after voucher usage.

    header Parameters
    x-tenant
    string <uuid>
    Request Body schema: */*
    amount
    required
    number > 0
    price
    number > 0
    expires
    string <date-time>
    pointsExpireInDays
    integer <int32> >= 1
    forWallet
    string <uuid>
    object

    Responses

    useVoucherOnMyWallet

    Use voucher on logged user wallet

    Request Body schema: */*
    voucher
    required
    string <uuid>

    Responses

    useVoucher

    Use voucher on specific wallet

    path Parameters
    wallet
    required