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
Get warehouses
GET
https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses
Path Parameters
Name | Type | Description |
---|---|---|
cloudId* | integer |
Query Parameters
Name | Type | Description |
---|---|---|
sort | string | |
filter | string | |
page | integer | |
limit | integer |
Headers
Name | Type | Description |
---|---|---|
If-None-Match | string | ETag to return results only if changed. |
Authorization* | string | Bearer accessToken |
Get warehouse
GET
https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses/:warehouseId
Path Parameters
Name | Type | Description |
---|---|---|
warehouseId* | integer | |
cloudId* | integer |
Headers
Name | Type | Description |
---|---|---|
If-None-Match | string | ETag to return results only if changed. |
Authorization* | string | Bearer accessToken |
Create new warehouse
POST
https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses
Create a list of new warehouses.
Path Parameters
Name | Type | Description |
---|---|---|
cloudId* | integer | ID of the cloud. |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Bearer accessToken |
Replace a single warehouse
PUT
https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses/:warehouseId
Replace a single warehouse identified by its ID.
Path Parameters
Name | Type | Description |
---|---|---|
cloudId* | integer | ID of the cloud. |
warehouseId* | integer | ID of the warehouse to replace. |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Bearer accessToken |
If-Match | string | ETag to update only if not changed. |
Replace many warehouses
PUT
https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses
Replace a list of warehouses.
Path Parameters
Name | Type | Description |
---|---|---|
cloudId* | integer | ID of the cloud. |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Bearer accessToken |
If-Match | string | ETag to update only if not changed. |
Update a single warehouse
PATCH
https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses/:warehouseId
Update a single warehouse identified by its ID.
Path Parameters
Name | Type | Description |
---|---|---|
cloudId* | integer | ID of the cloud. |
warehouseId* | integer | ID of the warehouse to patch. |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Bearer accessToken |
If-Match* | string | ETag to update only if not changed. |
Delete a single warehouse
DELETE
https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses/:warehouseId
Delete a single warehouse identified by its ID.
Path Parameters
Name | Type | Description |
---|---|---|
cloudId* | integer | ID of the cloud. |
warehouseId* | integer | ID of the warehouse to delete. |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Bearer accessToken |
If-Match | string | ETag ignored (temporarily) when deleting an entity. |
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
List of products with stock status
GET
https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses/:warehouseId/products
Path Parameters
Name | Type | Description |
---|---|---|
warehouseId* | integer | |
cloudId* | integer |
Query Parameters
Name | Type | Description |
---|---|---|
sort | string | |
filter | string | |
page | string | |
limit | string |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Bearer accessToken |
If-None-Match | string | ETag to return results only if changed. |
Product with stock status
GET
https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses/:warehouseId/products/:productId
Path Parameters
Name | Type | Description |
---|---|---|
productId* | string | |
warehouseId* | integer | |
cloudId* | integer |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Bearer accessToken |
If-None-Match | string | ETag to return results only if changed. |
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.
currency
string?
Currency to be set for the operation (default if not specified: CZK)
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
Stockup to warehouse
POST
https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses/:warehouseId/stockups
Path Parameters
Name | Type | Description |
---|---|---|
warehouseId* | string | |
cloudId* | integer |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Bearer accessToken |
Request Body
Name | Type | Description |
---|---|---|
object | Stockup Schema |
Transfer schema
_originWarehouseId
long
Warehouse ID
currency
string?
Currency to be set for the operation (default if not specified: CZK)
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
Transfer to warehouse
POST
https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses/:warehouseId/transfers
Path Parameters
Name | Type | Description |
---|---|---|
warehouseId* | integer | |
cloudId* | integer |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Bearer accessToken |
Request Body
Name | Type | Description |
---|---|---|
object | Transfare Schema |
Sale schema
currency
string?
Currency to be set for the operation (default if not specified: CZK)
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
Sale product on warehouse
POST
https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses/:warehouseId/sales
Path Parameters
Name | Type | Description |
---|---|---|
warehouseId* | integer | |
cloudId* | integer |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Bearer accessToken |
Request Body
Name | Type | Description |
---|---|---|
object | Warehouse Sale Schema |
Last updated