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

Warehouse API (1.0)

Download OpenAPI specification:Download

OrderingStack warehouse API

Authentication

oauth2

Security Scheme Type OAuth2

oauth2-client

Security Scheme Type OAuth2

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

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

newWarehouse

Create new warehouse

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

Responses

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

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: */*
id
string <uuid>
name
string

Responses

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

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: */*
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

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: */*
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

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: */*
number
string
Array of objects (Item) [ 0 .. 2048 ] items
unlockItems
boolean

Whether to unlock all referenced items.

object

Responses

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: */*
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

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: */*
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

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: */*
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.

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: */*