API
Ask or search…
K
Links

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