Warehouse Branch

The warehouse branch is an M:N relation entity between branches and warehouses. A branch can be configured to see many warehouses and a warehouse can be seen by many branches.

Warehouse-Branches schema

id long? Warehouse branch ID - cannot be null in PUT/PATCH methods 📶 EQUALS,ENUM

_branchId integer Branch ID 📶 EQUALS,ENUM

_cloudId integer Cloud ID

_warehouseId long Warehouse 📶 EQUALS,ENUM

flags integer Warehouse branch flags 📶 BITS

visible boolean [1] Whether the branch can see the warehouse 📶 EQUALS, ENUM

subscribed boolean [1] Whether the branch is subscribed for warehouse updates 📶 EQUALS, ENUM

version timestamp? Version date and time 📶 EQUALS, ENUM, NUMBER 🔽 BOTH

versionDate timestamp? Last modification date and time 📶 EQUALS, ENUM, NUMBER 🔽 BOTH

[1] In order to be allowed to set visible to true the subscribed must be true as well.

Warehouse-Branches response

{
    "_branchId": <integer>,
    "_cloudId": <integer>,
    "_warehouseId": <long>,
    "flags": <integer>,
    "id": <long>,
    "subscribed": <boolean>,
    "version": <timestamp>,
    "versionDate": <timestamp>,
    "visible": <boolean>
}

Get warehouse branches

GET https://api.dotykacka.cz/v2/clouds/:cloudId/warehouse-branches

Get a custom-sorted paginated list of warehouse branches matching the filter criteria.

Path Parameters

Name	Type	Description
cloudId*	integer	ID of the cloud.

Query Parameters

Name	Type	Description
sort	string	Sort parameter.
filter	string	Filter conditions.
page	integer	Page to start with.
limit	integer	Page size (100 records maximum)

Headers

Name	Type	Description
If-None-Match	string	ETag to return results only if changed.
Authorization*	string	Bearer accessToken

200

Get warehouse branch

GET https://api.dotykacka.cz/v2/clouds/:cloudId/warehouse-branches/:warehouseBranchId

Get a single warehouse branch identified by its ID.

Path Parameters

Name	Type	Description
cloudId*	integer	ID of the cloud.
warehouseBranchId*	integer	ID of the warehouse branch to get.

Headers

Name	Type	Description
If-None-Match	string	ETag to return results only if changed.
Authorization*	string	Bearer accessToken

200

{
    //Warehouse scheme
}

400

404

Create new warehouse branch

POST https://api.dotykacka.cz/v2/clouds/:cloudId/warehouse-branches

Create a list of new warehouse branches. An error is returned if the entity with the same _branchId and _warehouseId exists. Use PUT or PATCH for the entity with the required IDs in such cases.

Path Parameters

Name	Type	Description
cloudId*	integer	ID of the cloud.

Headers

Name	Type	Description
Authorization*	string	Bearer accessToken

200

Replace a single warehouse branch

PUT https://api.dotykacka.cz/v2/clouds/:cloudId/warehouse-branches/:warehouseBranchId

Replace a single warehouse branch identified by its ID. An error is returned if the sent entity changes _branchId or _warehouseId of an existing entity with same warehouseBranchId. Or if a new entity without warehouseBranchId has the same _branchId and _warehouseId as another existing entity. Please update directly the existing entity with the required new _branchId and _warehouseId instead.

Path Parameters

Name	Type	Description
cloudId*	integer	ID of the cloud.
warehouseBranchId*	integer	ID of the warehouse branch to replace.

Headers

Name	Type	Description
Authorization*	string	Bearer accessToken
If-Match	string	ETag to update only if not changed.

200

Replace many warehouse branches

PUT https://api.dotykacka.cz/v2/clouds/:cloudId/warehouse-branches

Replace a list of warehouse branches. An error is returned if the sent entity changes _branchId or _warehouseId of an existing entity with same warehouseBranchId. Or if a new entity without warehouseBranchId has the same _branchId and _warehouseId as another existing entity. Please update directly the existing entity with the required new _branchId and _warehouseId instead.

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.

200

Update a single warehouse branch

PATCH https://api.dotykacka.cz/v2/clouds/:cloudId/warehouse-branches/:warehouseBranchId

Update a single warehouse branch identified by its ID. An error is returned if the sent entity changes _branchId or _warehouseId of an existing entity with same warehouseBranchId. Or if a new entity without warehouseBranchId has the same _branchId and _warehouseId as another existing entity. Please update directly the existing entity with the required new _branchId and _warehouseId instead.

Path Parameters

Name	Type	Description
cloudId*	integer	ID of the cloud.
warehouseBranchId*	integer	ID of the warehouse branch to patch.

Headers

Name	Type	Description
Authorization*	string	Bearer accessToken
If-Match*	string	ETag to update only if not changed.

200