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

Warehouse API (1.0)

Download OpenAPI specification:Download

OrderingStack warehouse API

Authentication

oauth2

Security Scheme Type OAuth2

oauth2-client

Security Scheme Type OAuth2

warehouses-controller

getWarehouse

Get warehouse by Id

Authorizations:
oauth2-clientoauth2 (ROLE_SUROLE_MANAGERROLE_WHROLE_STOCK)
path Parameters
id
required
string <uuid>
header Parameters
x-tenant
string <uuid>

Responses

warehouses-admin-controller

updateWarehouse

Update warehouse

Authorizations:
oauth2-clientoauth2 (ROLE_SUROLE_MANAGERROLE_WH)
path Parameters
id
required
string <uuid>
header Parameters
x-tenant
string <uuid>
Request Body schema: application/json
id
string <uuid>
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}

newWarehouse

Create new warehouse

Authorizations:
oauth2-clientoauth2 (ROLE_SUROLE_MANAGERROLE_WH)
header Parameters
x-tenant
string <uuid>
Request Body schema: application/json
id
string <uuid>
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}

react-admin-list-controller

warehouses

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

Authorizations:
oauth2-clientoauth2 (ROLE_SUROLE_MANAGERROLE_WH)
query Parameters
required
object (WarehouseFilter)
header Parameters
x-tenant
string <uuid>

Responses

getStates

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

Authorizations:
oauth2-clientoauth2 (ROLE_SUROLE_MANAGERROLE_WHROLE_STOCK)
query Parameters
required
object (StatesFilter)
header Parameters
x-tenant
string <uuid>

Responses

getDocuments

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

Authorizations:
oauth2-clientoauth2 (ROLE_SUROLE_MANAGERROLE_WH)
query Parameters
required
object (DocumentFilter)
header Parameters
x-tenant
string <uuid>

Responses

document-controller

createWZDoc

Create new WZ (Goods Received) document

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

Whether to unlock all referenced items.

object

Responses

Request samples

Content type
application/json
{
  • "number": "string",
  • "items": [
    ],
  • "unlockItems": true,
  • "extra": {
    }
}

createRWDoc

Create new RW (Internal Goods Issued) document

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

Whether to unlock all referenced items.

object

Responses

Request samples

Content type
application/json
{
  • "number": "string",
  • "items": [
    ],
  • "unlockItems": true,
  • "extra": {
    }
}

createPZDoc

Create new PZ (Goods Received) document

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

Whether to unlock all referenced items.

object

Responses

Request samples

Content type
application/json
{
  • "number": "string",
  • "items": [
    ],
  • "unlockItems": true,
  • "extra": {
    }
}

createMMDoc

Create new MM (Goods Transfer) document

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

Whether to unlock all referenced items.

object
targetWarehouse
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "number": "string",
  • "items": [
    ],
  • "unlockItems": true,
  • "extra": {
    },
  • "targetWarehouse": "ab6a203d-2362-48e5-84dd-80e203f3e679"
}

createInvDoc

Create new Inventory document

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

Whether to unlock all referenced items.

object

Responses

Request samples

Content type
application/json
{
  • "number": "string",
  • "items": [
    ],
  • "unlockItems": true,
  • "extra": {
    }
}

getDocument

Get single document

Authorizations:
oauth2-clientoauth2 (ROLE_SUROLE_MANAGERROLE_WH)
path Parameters
id
required
string <uuid>
header Parameters
x-tenant
string <uuid>
x-user
string <uuid>

Responses

stock-controller

currentStock

Get current stock

Authorizations:
oauth2-clientoauth2
path Parameters
warehouse
required
string <uuid>
header Parameters
x-tenant
string <uuid>
Request Body schema: application/json
items
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

lowStock

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

Authorizations:
oauth2-clientoauth2
path Parameters
warehouse
required
string <uuid>
header Parameters
x-tenant
string <uuid>

Responses

lock-controller

lock

Lock as much as possible of items

Authorizations:
oauth2-clientoauth2 (ROLE_SUROLE_MANAGERROLE_WH)
path Parameters
warehouse
required
string <uuid>
header Parameters
x-tenant
string <uuid>
x-user
string <uuid>
Request Body schema: application/json
qty
required
integer <int32>

Requested number of packets.

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

Packet definition.

Responses

Request samples

Content type
application/json
{
  • "qty": 0,
  • "items": [
    ]
}

lockPackets

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

Authorizations:
oauth2-clientoauth2 (ROLE_SUROLE_MANAGERROLE_WH)
path Parameters
warehouse
required
string <uuid>
header Parameters
x-tenant
string <uuid>
x-user
string <uuid>
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "packets": {
    }
}