Main docs page Auth API Ordering API Menu API Venue API Inventory API Payment API Loyalty API Wallet API
Documentation Powered by ReDoc

Menu API (1.0)

Download OpenAPI specification:Download

OrderingStack menu API

Authentication

oauth2

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

    cache

    resetCache

    Reset cache.

    Authorizations:
    oauth2

    Responses

    locks

    getLock

    Get lock definition by id

    Authorizations:
    oauth2
    path Parameters
    lock
    required
    string[a-zA-Z0-9_.-]+

    Responses

    deleteLock

    Remove lock with provided ID.

    Authorizations:
    oauth2
    path Parameters
    lock
    required
    string[a-zA-Z0-9_.-]+

    Responses

    getLocks

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

    Authorizations:
    oauth2
    query Parameters
    required
    object (LocksFilter)

    Responses

    postLock

    Create new lock. Its ID must be new end unique. Overriding existing locks is not allowed. To alter a lock simply delete old one and create new.

    Authorizations:
    oauth2
    Request Body schema: application/json

    default response

    id
    required
    string[a-zA-Z0-9_.-]+

    ID of this lock.

    products
    Array of strings [ 1 .. 2147483647 ] items

    IDs of locked products.

    instances
    Array of strings

    Instances (venues) where this lock is applied.

    object

    Channels (like DINE_IN, DELIVERY, etc).

    Responses

    Request samples

    Content type
    application/json

    basic

    {
    • "id": "product_lock_1",
    • "products": [
      ],
    • "instances": [
      ],
    • "lockedInChannel": [
      ]
    }

    locks

    Get currently set locks for instance (i.e. venue). Returns all locks with matching instance and global locks (without any instance assigned)

    Authorizations:
    oauth2
    path Parameters
    instance
    required
    string[a-zA-Z0-9_.-]+
    Example: venue-1

    Responses

    menu definition

    getMenu

    Get menu definition by ID.

    Authorizations:
    oauth2
    path Parameters
    menu
    required
    string[a-zA-Z0-9_.-]+
    Example: MENU_default

    Responses

    putMenu

    Update menu definition. ID in input document is overridden by the one from path. This method does upsert in database.

    Authorizations:
    oauth2
    path Parameters
    menu
    required
    string[a-zA-Z0-9_.-]+
    Example: MENU_default
    Request Body schema: application/json

    default response

    id
    required
    string[a-zA-Z0-9_.-]+
    object

    Map key refers to possible order types, like 'DELIVERY', 'TAKE_AWAY', 'DINE_IN', etc.

    Responses

    Request samples

    Content type
    application/json

    basic

    {
    • "id": "MENU_default",
    • "specific": {
      }
    }

    deleteMenu

    Delete menu definition by ID.

    Authorizations:
    oauth2
    path Parameters
    menu
    required
    string[a-zA-Z0-9_.-]+
    Example: MENU_default

    Responses

    getDefinitions

    Get paginated list of Menu definitions (menu sets assigned to venues). This endpoint is compatible with React AdminOnRest framework to provide DataSource.

    Authorizations:
    oauth2
    query Parameters
    required
    object (DefinitionsFilter)

    Responses

    postMenu

    Create new menu definition. If ID is not provided it will be generated. Otherwise this method is similar to PUT method and does upsert in database.

    Authorizations:
    oauth2
    Request Body schema: application/json

    default response

    id
    required
    string[a-zA-Z0-9_.-]+
    object

    Map key refers to possible order types, like 'DELIVERY', 'TAKE_AWAY', 'DINE_IN', etc.

    Responses

    Request samples

    Content type
    application/json

    basic

    {
    • "id": "MENU_default",
    • "specific": {
      }
    }

    items

    getItem

    Retrieve menu item by ID from database.

    Authorizations:
    oauth2
    path Parameters
    item
    required
    string[a-zA-Z0-9_.-]+
    Example: espresso

    Responses

    putItem

    Update menu item. ID from path overrides the one provided in input object. Method does upsert in database.

    Authorizations:
    oauth2
    path Parameters
    item
    required
    string[a-zA-Z0-9_.-]+
    Example: product-id
    query Parameters
    optimistic-lock
    string <date-time>
    Request Body schema: application/json

    default response

    id
    required
    string[a-zA-Z0-9_.-]+
    object
    kind
    required
    string
    MenuGroupCategory
    MenuGroupCategory
    MenuGroupConfig
    MenuGroupOptions
    Product
    QueryItems
    Reference
    Static