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

Warehouse API (1.0)

Download OpenAPI specification:Download

OrderingStack warehouse API

Authentication

oauth2

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

    getStates

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

    query Parameters
    required
    object (StatesFilter)

    Responses

    getDocuments

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

    query Parameters
    required
    object (DocumentFilter)

    Responses

    warehouses

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

    query Parameters
    required
    object (WarehouseFilter)

    Responses

    newWarehouse

    Create new warehouse

    header Parameters
    x-tenant
    string <uuid>
    Request Body schema: */*
    id
    string <uuid>
    name
    string

    Responses

    getWarehouse

    Get warehouse by Id

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

    Responses

    updateWarehouse

    Update warehouse

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

    Responses

    getDocument

    Get single document

    path Parameters
    id
    required
    string <uuid>
    header Parameters
    x-tenant
    string <uuid>
    x-user
    string <uuid>

    Responses

    createWZDoc

    Create new WZ (Goods Received) document

    path Parameters
    warehouse
    required
    string <uuid>
    header Parameters
    x-tenant
    string <uuid>
    x-user
    string <uuid>
    Request Body schema: */*
    number
    string
    Array of objects (Item) [ 0 .. 2048 ] items
    unlockItems
    boolean

    Whether to unlock all referenced items.

    object

    Responses

    createRWDoc

    Create new RW (Internal Goods Issued) document

    path Parameters
    warehouse
    required
    string <uuid>
    header Parameters
    x-tenant
    string <uuid>
    x-user
    string <uuid>
    Request Body schema: */*
    number
    string
    Array of objects (Item) [ 0 .. 2048 ] items
    unlockItems
    boolean

    Whether to unlock all referenced items.

    object

    Responses

    createPZDoc

    Create new PZ (Goods Received) document

    path Parameters
    warehouse
    required
    string <uuid>
    header Parameters
    x-tenant
    string <uuid>
    x-user
    string <uuid>
    Request Body schema: */*
    number
    string
    Array of objects (Item) [ 0 .. 2048 ] items
    unlockItems
    boolean

    Whether to unlock all referenced items.

    object

    Responses

    createInvDoc

    Create new Inventory document

    path Parameters
    warehouse
    required
    string <uuid>
    header Parameters
    x-tenant
    string <uuid>
    x-user
    string <uuid>
    Request Body schema: */*
    number
    string
    Array of objects (Item) [ 0 .. 2048 ] items
    unlockItems
    boolean

    Whether to unlock all referenced items.

    object

    Responses

    createMMDoc

    Create new MM (Goods Transfer) document

    path Parameters
    warehouse
    required
    string <uuid>
    header Parameters
    x-tenant
    string <uuid>
    x-user
    string <uuid>
    Request Body schema: */*
    number
    string
    Array of objects (Item) [ 0 .. 2048 ] items
    unlockItems
    boolean

    Whether to unlock all referenced items.

    object
    targetWarehouse
    string <uuid>

    Responses

    lock

    Lock as much as possible of items

    path Parameters
    warehouse
    required
    string <uuid>
    header Parameters
    x-tenant
    string <uuid>
    x-user
    string <uuid>
    Request Body schema: */*
    qty
    required
    integer <int32>

    Requested number of packets.

    Array of objects (ItemLock) [ 0 .. 2048 ] items

    Packet definition.

    Responses

    lockPackets

    Lock as many packets as possible. Packets are defined as named lists of products.

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

    Responses

    currentStock

    Get current stock

    path Parameters
    warehouse
    required
    string <uuid>
    header Parameters
    x-tenant
    string <uuid>
    Request Body schema: */*
    items
    required
    Array of strings

    Responses

    lowStock

    Get low stock (stock with quantities less or equal 3)

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

    Responses