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 📶 EQUALS,ENUM

_cloudId integer Cloud

_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
Get warehouse branches

https://api.dotykacka.cz/v2/clouds/:cloudId/warehouse-branches
Get a custom-sorted paginated list of warehouse branches matching the filter criteria.
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
Headers
If-None-Match
optional
string
ETag to return results only if changed.
Authorization
required
string
Bearer accessToken
Query Parameters
sort
optional
string
Sort parameter.
filter
optional
string
Filter conditions.
page
optional
integer
Page to start with.
limit
optional
integer
Page size (100 records maximum)
Response
200: OK

get
Get warehouse branch

https://api.dotykacka.cz/v2/clouds/:cloudId/warehouse-branches/:warehouseBranchId
Get a single warehouse branch identified by its ID.
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
warehouseBranchId
required
integer
ID of the warehouse branch to get.
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

post
Create new warehouse branch

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.
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 branch

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.
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
warehouseBranchId
required
integer
ID of the warehouse branch 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 warehouse branches

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.
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 branch

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.
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
warehouseBranchId
required
integer
ID of the warehouse branch to patch.
Headers
Authorization
required
string
Bearer accessToken
If-Match
required
string
ETag to update only if not changed.
Response
200: OK