Warehouse

Warehouse schema

id long? Warehouse ID - cannot be null in PUT/PATCH methods πŸ“Ά EQUALS,ENUM πŸ”½ NONE

_cloudId integer Cloud ID πŸ”½ NONE

barcode string?(180) Bar code πŸ“Ά EQUALS,ENUM πŸ”½ NONE

deleted boolean Category deleted - cannot be true in POST/PUT/PATCH methods πŸ“Ά EQUALS, ENUM πŸ”½ BOTH

enabled boolean Warehouse enabled πŸ“Ά EQUALS, ENUM

hexColor string?(7) Warehouse color πŸ”½ NONE

name string(180) Warehouse name πŸ“Ά EQUALS,STRING πŸ”½ BOTH

versionDate timestamp? Last modification date and time πŸ“Ά EQUALS,ENUM,NUMBER πŸ”½ BOTH

Warehouse response

{
"_cloudId": <integer>,
"barcode": <string>,
"deleted": <boolean>,
"enabled": <boolean>,
"hexColor": <string>,
"id": <long>,
"name": <string>,
"versionDate": <timestamp>
}

get
Get warehouses

https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses
Request
Response
Request
Path Parameters
cloudId
required
integer
​
Headers
If-None-Match
optional
string
ETag to return results only if changed.
Authorization
required
string
Bearer accessToken
Query Parameters
sort
optional
string
​
filter
optional
string
​
page
optional
integer
​
limit
optional
integer
​
Response
200: OK
[{
// Werehouses schema
}]
400: Bad Request
​
404: Not Found
​

get
Get warehouse

https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses/:warehouseId
Request
Response
Request
Path Parameters
warehouseId
required
integer
​
cloudId
required
integer
​
Headers
If-None-Match
optional
string
ETag to return results only if changed.
Authorization
required
string
Bearer accessToken
Response
200: OK
{
//Warehouse scheme
}
400: Bad Request
​
404: Not Found
​

get
Products on warehouse

https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses/:warehouseId/products
Request
Response
Request
Path Parameters
warehouseId
required
integer
​
cloudId
required
integer
​
Headers
Authorization
required
string
Bearer accessToken
Response
200: OK
Return array of extended product. More detail find in product schema.
[
{
// extended Product schema
"_warehouseId": <long>,
"purchasePriceWithoutVat": <double>,
"stockQuantityStatus": <double>,
}
...
]
400: Bad Request
​
404: Not Found
​

get
Product on warehouse

https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses/:warehouseId/products/:productId
Request
Response
Request
Path Parameters
productId
required
string
​
warehouseId
required
integer
​
cloudId
required
integer
​
Headers
Authorization
required
string
Bearer accessToken
Response
200: OK
{
// extended Product schema
"_warehouseId": <long>,
"purchasePriceWithoutVat": <double>,
"stockQuantityStatus": <double>,
}
...
400: Bad Request
​
404: Not Found
​

post
Create new warehouse

https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses
Create a list of new warehouses.
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
Headers
Authorization
required
string
Bearer accessToken
Response
200: OK
​

put
Replace a single warehouse

https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses/:warehouseId
Replace a single warehouse identified by its ID.
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
warehouseId
required
integer
ID of the warehouse to replace.
Headers
Authorization
required
string
Bearer accessToken
If-Match
required
string
ETag to update only if not changed.
Response
200: OK
​

put
Replace many warehouses

https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses
Replace a list of warehouses.
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
Headers
Authorization
required
string
Bearer accessToken
If-Match
required
string
ETag to update only if not changed.
Response
200: OK
​

patch
Update a single warehouse

https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses/:warehouseId
Update a single warehouse identified by its ID.
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
warehouseId
required
integer
ID of the warehouse to patch.
Headers
Authorization
required
string
Bearer accessToken
If-Match
required
string
ETag to update only if not changed.
Response
200: OK
​

delete
Delete a single warehouse

https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses/:warehouseId
Delete a single warehouse identified by its ID.
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
warehouseId
required
integer
ID of the warehouse to delete.
Headers
Authorization
required
string
Bearer accessToken
If-Match
optional
string
ETag ignored (temporarily) when deleting an entity.
Response
200: OK
​

StockUp schema

_supplierId long? Supplier ID​

invoiceNumber string Invoice number - must not be empty

note string? Custom note

updatePurchasePrice boolean Update product purchase prices

items array[1,100] Array of items to stock up (see below)

Nested array of items

_productId long? [1] Product ID​

externalId string? [1] External ID

purchasePrice double? Purchase price

quantity double Items quantity

sellPrice double? Product sell price

[1] One of _productId or externalId must not be null.

StockUp request

{
​
"_supplierId": <long>,
"invoiceNumber": <string>,
"note": <string>,
"updatePurchasePrice": <boolean>,
"items":[
{
"_productId": <long>,
"externalId": <string>,
"purchasePrice": <double>,
"quantity": <double>, // negative for corrections
"sellPrice": <double>
}
]
}

post
Stockup to warehouse

https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses/:warehouseId/stockups
Request
Response
Request
Path Parameters
warehouseId
required
string
​
cloudId
required
integer
​
Headers
Authorization
required
string
Bearer accessToken
Body Parameters
required
object
Stockup Schema
Response
200: OK
​

Transfer schema

_originWarehouseId long Warehouse ID​

invoiceNumber string Invoice number - must not be empty

note string? Custom note

updatePurchasePrice boolean Update product purchase prices

items array[1,100] Array of items to transfer (see below)

Nested array of items

_productId long? [1] Product ID​

externalId string? [1] External ID

purchasePrice double? Purchase price

quantity double Items quantity

[1] One of _productId or externalId must not be null.

Transfer request

{
"_originWarehouseId": <long>,
"invoiceNumber": <string>,
"note": <string>,
"updatePurchasePrice": <boolean>,
"items":[
{
"_productId": <long>,
"externalId": <string>,
"purchasePrice": <double>,
"quantity": <double>
}
]
}

post
Transfer to warehouse

https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses/:warehouseId/transfers
Request
Response
Request
Path Parameters
warehouseId
required
integer
​
cloudId
required
integer
​
Headers
Authorization
required
string
Bearer accessToken
Body Parameters
required
object
Transfare Schema
Response
200: OK
​

Sale schema

items array[1,100] Array of items to sell (see below)

Nested array of items

_productId long? [1] Product ID​

externalId string? [1] External ID

note string? Custom note

quantity double Items quantity

[1] One of _productId or externalId must not be null.

Sale request

{
"items": [
{
"_productId": <long>,
"externalId": <string>,
"note": <string>,
"quantity": <double>
}
]
}

post
Sale product on warehouse

https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses/:warehouseId/sales
Request
Response
Request
Path Parameters
warehouseId
required
integer
​
cloudId
required
integer
​
Headers
Authorization
required
string
Bearer accessToken
Body Parameters
required
object
Warehouse Sale Schema
Response
200: OK
​