API
Search
K
Links

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
https://api.dotykacka.cz
/v2/clouds/:cloudId/warehouses
Get warehouses
get
https://api.dotykacka.cz
/v2/clouds/:cloudId/warehouses/:warehouseId
Get warehouse
post
https://api.dotykacka.cz/v2
/clouds/:cloudId/warehouses
Create new warehouse
put
https://api.dotykacka.cz/v2
/clouds/:cloudId/warehouses/:warehouseId
Replace a single warehouse
put
https://api.dotykacka.cz/v2
/clouds/:cloudId/warehouses
Replace many warehouses
patch
https://api.dotykacka.cz/v2
/clouds/:cloudId/warehouses/:warehouseId
Update a single warehouse
delete
https://api.dotykacka.cz/v2
/clouds/:cloudId/warehouses/:warehouseId
Delete a single warehouse

Product with stock status schema

Response product with stock status is an extension for the Product response entity. That means all fields from the Product can also be found in the Product with stock status.
_warehouseId long Warehouse ID 📶 EQUALS,ENUM
stockQuantityStatus double Quantity on warehouse 📶 NUMBER
stockStatusVersiondate timestamp? Last modification on warehouse 📶 EQUALS,ENUM,NUMBER 🔽 BOTH

Product with stock status response

{
// all filelds from the Product plus the following:
"_warehouseId": <long>,
"stockQuantityStatus": <double>,
"stockStatusVersiondate": <timestamp>,
}
get
https://api.dotykacka.cz
/v2/clouds/:cloudId/warehouses/:warehouseId/products
List of products with stock status
get
https://api.dotykacka.cz
/v2/clouds/:cloudId/warehouses/:warehouseId/products/:productId
Product with stock status

StockUp schema

_supplierId long? Supplier ID
_closeDeliveryNoteIds array<long>? Array of Delivery Note IDs to be marked as closed when the stock-up completes successfully.
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>,
"_closeDeliveryNoteIds": <array of long>,
"invoiceNumber": <string>,
"note": <string>,
"updatePurchasePrice": <boolean>,
"items":[
{
"_productId": <long>,
"externalId": <string>,
"purchasePrice": <double>,
"quantity": <double>, // negative for corrections
"sellPrice": <double>
}
]
}
post
https://api.dotykacka.cz
/v2/clouds/:cloudId/warehouses/:warehouseId/stockups
Stockup to warehouse

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
https://api.dotykacka.cz
/v2/clouds/:cloudId/warehouses/:warehouseId/transfers
Transfer to warehouse

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
https://api.dotykacka.cz
/v2/clouds/:cloudId/warehouses/:warehouseId/sales
Sale product on warehouse