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 warehouses

GET https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses

Path Parameters

NameTypeDescription

cloudId*

integer

Query Parameters

NameTypeDescription

sort

string

filter

string

page

integer

limit

integer

Headers

NameTypeDescription

If-None-Match

string

ETag to return results only if changed.

Authorization*

string

Bearer accessToken

[{
    // Werehouses schema
}]

Get warehouse

GET https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses/:warehouseId

Path Parameters

NameTypeDescription

warehouseId*

integer

cloudId*

integer

Headers

NameTypeDescription

If-None-Match

string

ETag to return results only if changed.

Authorization*

string

Bearer accessToken

{
    //Warehouse scheme
}

Create new warehouse

POST https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses

Create a list of new warehouses.

Path Parameters

NameTypeDescription

cloudId*

integer

ID of the cloud.

Headers

NameTypeDescription

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

NameTypeDescription

cloudId*

integer

ID of the cloud.

warehouseId*

integer

ID of the warehouse to replace.

Headers

NameTypeDescription

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

NameTypeDescription

cloudId*

integer

ID of the cloud.

Headers

NameTypeDescription

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

NameTypeDescription

cloudId*

integer

ID of the cloud.

warehouseId*

integer

ID of the warehouse to patch.

Headers

NameTypeDescription

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

NameTypeDescription

cloudId*

integer

ID of the cloud.

warehouseId*

integer

ID of the warehouse to delete.

Headers

NameTypeDescription

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

{
    // all filelds from the Product plus the following:
    "_warehouseId": <long>,
    "stockQuantityStatus": <double>,
    "stockStatusVersiondate": <timestamp>,
}

List of products with stock status

GET https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses/:warehouseId/products

Path Parameters

NameTypeDescription

warehouseId*

integer

cloudId*

integer

Query Parameters

NameTypeDescription

sort

string

filter

string

page

string

limit

string

Headers

NameTypeDescription

Authorization*

string

Bearer accessToken

If-None-Match

string

ETag to return results only if changed.

[
 {
  // extended Product schema
  "_warehouseId": <long>,
  "purchasePriceWithoutVat": <double>,
  "stockQuantityStatus": <double>,
 }
 ...
]

Product with stock status

GET https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses/:warehouseId/products/:productId

Path Parameters

NameTypeDescription

productId*

string

warehouseId*

integer

cloudId*

integer

Headers

NameTypeDescription

Authorization*

string

Bearer accessToken

If-None-Match

string

ETag to return results only if changed.

{
    // extended Product schema
    "_warehouseId": <long>,
    "purchasePriceWithoutVat": <double>,
    "stockQuantityStatus": <double>,
}
...

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

{

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

Stockup to warehouse

POST https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses/:warehouseId/stockups

Path Parameters

NameTypeDescription

warehouseId*

string

cloudId*

integer

Headers

NameTypeDescription

Authorization*

string

Bearer accessToken

Request Body

NameTypeDescription

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

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

Transfer to warehouse

POST https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses/:warehouseId/transfers

Path Parameters

NameTypeDescription

warehouseId*

integer

cloudId*

integer

Headers

NameTypeDescription

Authorization*

string

Bearer accessToken

Request Body

NameTypeDescription

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

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

Sale product on warehouse

POST https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses/:warehouseId/sales

Path Parameters

NameTypeDescription

warehouseId*

integer

cloudId*

integer

Headers

NameTypeDescription

Authorization*

string

Bearer accessToken

Request Body

NameTypeDescription

object

Warehouse Sale Schema

Last updated