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

Venue API (1.0)

Download OpenAPI specification:Download

OrderingStack venue API

Authentication

oauth2

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

    list

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

    query Parameters
    required
    object (VenuesFilter)

    Responses

    postVenue

    Update venue by ID. Works as upsert

    header Parameters
    x-tenant
    string <uuid>
    Request Body schema: */*
    id
    string[a-zA-Z0-9_.-]+
    name
    required
    string [ 1 .. 255 ] characters
    menu
    string[\p{L}\p{N}_.-]+
    active
    boolean
    object (Address)
    timeZone
    required
    string
    object (GeoPosition)
    object
    warehouse
    string[\p{L}\p{N}_.-]+
    sync
    boolean
    syncId
    string^[a-z0-9A-Z]+$
    object
    object

    Responses

    getVenue

    Get venue by ID

    path Parameters
    venue
    required
    string[a-zA-Z0-9_.-]+
    header Parameters
    x-tenant
    string <uuid>

    Responses

    putVenue

    Update venue by ID. Works as upsert

    path Parameters
    venue
    required
    string[a-zA-Z0-9_.-]+
    header Parameters
    x-tenant
    string <uuid>
    Request Body schema: */*
    id
    string[a-zA-Z0-9_.-]+
    name
    required
    string [ 1 .. 255 ] characters
    menu
    string[\p{L}\p{N}_.-]+
    active
    boolean
    object (Address)
    timeZone
    required
    string
    object (GeoPosition)
    object
    warehouse
    string[\p{L}\p{N}_.-]+
    sync
    boolean
    syncId
    string^[a-z0-9A-Z]+$
    object
    object

    Responses

    deleteVenue

    Delete venue by ID. Be careful as this is irreversible operation.

    path Parameters
    venue
    required
    string[a-zA-Z0-9_.-]+
    header Parameters
    x-tenant
    string <uuid>

    Responses

    activateVenue

    Activate venue by ID. Active venues can receive orders.

    path Parameters
    venue
    required
    string[a-zA-Z0-9_.-]+
    header Parameters
    x-tenant
    string <uuid>

    Responses

    deactivateVenue

    Deactivate venue by ID. Inactive venues cannot receive orders.

    path Parameters
    venue
    required
    string[a-zA-Z0-9_.-]+
    header Parameters
    x-tenant
    string <uuid>

    Responses

    validateCluster

    Validate venue cluster (batch of venues). Returns information if order can be made to those venues simultaneously. Currently only single venue is allowed.

    header Parameters
    x-tenant
    string <uuid>
    Request Body schema: */*
    venues
    required
    Array of strings
    orderType
    string [ 0 .. 64 ] characters
    due
    string <date-time>
    object (GeoPosition)

    Responses

    getVenue_1

    Get venue by ID

    path Parameters
    venue
    required
    string[a-zA-Z0-9_.-]+
    header Parameters
    x-tenant
    string <uuid>

    Responses

    getNearest

    Locate venues near provided geo position. Currently mocked and returning all venues.

    query Parameters
    lat
    required
    number
    lng
    required
    number
    header Parameters
    x-tenant
    string <uuid>

    Responses