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

Ordering API (1.0)

Download OpenAPI specification:Download

OrderingStack ordering API

Authentication

oauth2

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

    order

    getList

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

    query Parameters
    required
    object (OrdersFilter)
    header Parameters
    x-tenant
    string <uuid>

    Responses

    commentOrder

    Add comment to order.

    path Parameters
    uid
    required
    string <uuid>

    Order id

    Request Body schema: */*
    string

    Responses

    commentOrderLine

    Add comment to order line.

    path Parameters
    uid
    required
    string <uuid>

    Order id

    lid
    required
    string <uuid>

    Line id

    Request Body schema: */*
    string

    Responses

    addFiscalize

    Add fiscal information to order. This should reflect printed fiscal strip.

    path Parameters
    uid
    required
    string <uuid>

    Order id

    Request Body schema: */*
    timestamp
    required
    string <date-time>
    user
    string <uuid>
    venue
    string[\p{L}\p{N}_.-]+
    amount
    required
    number
    printer
    required
    string [ 3 .. 64 ] characters
    slip
    required
    string [ 3 .. 64 ] characters
    Array of objects (SlipEntry)
    taxId
    string [ 0 .. 32 ] characters
    message
    string [ 0 .. 64 ] characters
    object

    Responses

    requestFiscal

    Request fiscal data for order. Data is returnet through websocket.

    path Parameters
    uid
    required
    string <uuid>

    Order id

    Responses

    setQueuePos

    Manually set queue pos for order. Tenant configuration must allow it.

    path Parameters
    uid
    required
    string <uuid>

    Order id

    Request Body schema: */*
    venue
    required
    string [ 1 .. 128 ] characters [\p{L}\p{N}_.-]+
    queuePos
    required
    string [ 1 .. 32 ] characters [a-zA-Z0-9_.-]+

    Responses

    kdsTraceView

    Track order visibility on KDS.

    path Parameters
    uid
    required
    string <uuid>

    Order id

    query Parameters
    config
    string

    KDS config

    Responses

    setDue

    Set due timestamp for order.

    path Parameters
    uid
    required
    string <uuid>

    Order id

    Request Body schema: */*
    due
    string <date-time>

    Due timestamp of order. Allows to place future orders. Some conditions depending on tenant configuration must be met on how soon or late this timestamp can be.

    Responses

    newOrder

    Create new order.

    Request Body schema: */*
    orderType
    required
    string
    Enum: "DELIVERY" "TAKE_AWAY" "DINE_IN_OPEN" "DINE_IN"
    due
    string <date-time>
    object (Address)

    Delivery address

    Array of objects (AppendedBucket) [ 0 .. 5 ] items
    discardInvalidLines
    boolean
    Default: false

    Whether lines referencing invalid products should be discarded and order containing rest of lines should be created (when true) or whole order should be rejected if some lines do not validate (false). Can be used to post historical order again and have all still valid products added.

    object (ContactRequest)
    object
    loyaltyCard
    string [ 0 .. 255 ] characters

    Responses

    abandonOrder

    Abandon order. Only not completed orders can be abandoned this way.

    path Parameters
    uid
    required
    string <uuid>

    Order id

    Responses

    cancelOrder

    Cancel order. Cancelling is available for restaurant staff. Involves e-payments refund. If refund fails - cancelling does not take place.

    path Parameters
    uid
    required
    string <uuid>

    Order id

    Responses

    processedLineOrder

    Mark order line as processed/prepared.

    path Parameters
    uid
    required
    string <uuid>

    Order id

    Request Body schema: */*
    Array ()
    string <uuid>

    Responses