REST Warehouse

Get warehouse locations structure.

Create a warehouse location layout

Creates a warehouse location layout

/rest/warehouses/layouts

Parameters

Field Type Description
parentId Int The parent ID of the warehouse location dimension
warehouseId Int The warehouse ID of the warehouse location dimension
level Int The level of the warehouse location dimension
name String The name of the warehouse location dimension
shortcut String The shortcut of the warehouse location dimension
separator String The separator of the warehouse location dimension
isActiveForPickupPath Int Active flag for pickup path of the warehouse location dimension
parentId Int The parent ID of the warehouse location level
dimensionId Int The warehouse location dimension ID of the warehouse location level
position Int The position of the warehouse location level
name String The name of the warehouse location level
levelId Int The warehouse location level ID of the warehouse location
label String The label of the warehouse location
purposeKey String The location type key of the warehouse location
statusKey String The location status key of the warehouse location
position Int The position of the warehouse location

Success 200

Field Type Description
id Int The ID of the warehouse location dimension
parentId Int The parent ID of the warehouse location dimension
warehouseId Int The warehouse ID of the warehouse location dimension
level Int The level of the warehouse location dimension
name String The name of the warehouse location dimension
shortcut String The shortcut of the warehouse location dimension
separator String The separator of the warehouse location dimension
displayInName Int If true, the dimension prefix will be shown in the storage location name
isActiveForPickupPath Int Active flag for pickup path of the warehouse location dimension

Errors 4xx

This call does not have an error output.

Get a warehouse location

Gets a warehouse location by ID. The warehouse location ID is required.

/rest/warehouses/locations/{warehouseLocationId}

Parameters

Field Type Description
warehouseLocationId Int The ID of the warehouse location

Success 200

Field Type Description
id Int The ID of the warehouse location
levelId Int The level ID of the warehouse location
label String The label of the warehouse location
purposeKey String The purpose key of the warehouse location
statusKey String The status key of the warehouse location
position Int The position of the warehouse location
fullLabel String The label with level path name
type String The type of the warehouse location (array values: 'small','medium','large','europallet')
notes String The notes of the warehouse location

Errors 4xx

This call does not have an error output.

List warehouse locations

Lists all warehouse locations.

/rest/warehouses/{warehouseId}/locations

Parameters

Field Type Description
warehouseId Int The ID of the warehouse

Success 200

Field Type Description
page Int Current page of the response
totalsCount Int The total number of entries in the response
isLastPage Bool Flag that indicates if the page shown is the last page of the response
lastPageNumber Int The last page number
firstOnPage Int The index of the first item of the current page result
lastOnPage Int The index of the last item of the current page result
itemsPerPage Int The requested amount of items per result page
entries WarehouseLocation[] List of WarehouseLocation
 id Int The ID of the warehouse location
 levelId Int The level ID of the warehouse location
 label String The label of the warehouse location
 purposeKey String The purpose key of the warehouse location
 statusKey String The status key of the warehouse location
 position Int The position of the warehouse location
 fullLabel String The label with level path name
 type String The type of the warehouse location (array values: 'small','medium','large','europallet')
 notes String The notes of the warehouse location

Errors 4xx

This call does not have an error output.

Create a warehouse location

Creates a warehouse location.

/rest/warehouses/locations

Parameters

Field Type Description
levelId Int The warehouse location level ID of the warehouse location
label String The label of the warehouse location
purposeKey String The location type key of the warehouse location
statusKey String The location status key of the warehouse location
position Int The position of the warehouse location

Success 200

Field Type Description
id Int The ID of the warehouse location
levelId Int The level ID of the warehouse location
label String The label of the warehouse location
purposeKey String The purpose key of the warehouse location
statusKey String The status key of the warehouse location
position Int The position of the warehouse location
fullLabel String The label with level path name
type String The type of the warehouse location (array values: 'small','medium','large','europallet')
notes String The notes of the warehouse location

Errors 4xx

This call does not have an error output.

Update a warehouse location

Updates a warehouse location

/rest/warehouses/locations/{warehouseLocationId}

Parameters

Field Type Description
warehouseLocationId Int The ID of the warehouse location

Success 200

Field Type Description
id Int The ID of the warehouse location
levelId Int The level ID of the warehouse location
label String The label of the warehouse location
purposeKey String The purpose key of the warehouse location
statusKey String The status key of the warehouse location
position Int The position of the warehouse location
fullLabel String The label with level path name
type String The type of the warehouse location (array values: 'small','medium','large','europallet')
notes String The notes of the warehouse location

Errors 4xx

This call does not have an error output.

Delete a warehouse location

Deletes a warehouse location

/rest/warehouses/locations/{warehouseLocationId}

Parameters

Field Type Description
warehouseLocationId Int The ID of the warehouse location

Success 200

This call does not have a response output.

Errors 4xx

This call does not have an error output.

Delete multiple warehouse locations

Deletes multiple warehouse locations

/rest/warehouses/locations

Success 200

This call does not have a response output.

Errors 4xx

This call does not have an error output.

Move a warehouse location position

Moves a warehouse location position

/rest/warehouses/locations/positions

Success 200

This call does not have a response output.

Errors 4xx

This call does not have an error output.

Get warehouse location details

Gets warehouse location details

/rest/warehouses/locations/details

Success 200

["type" => "...", "purpose" => "..."]

Errors 4xx

This call does not have an error output.

Generate warehouse location preview and saves it

Generates warehouse location preview and saves it

/rest/warehouses/locations/previews

Success 200

This call does not have a response output.

Errors 4xx

This call does not have an error output.

Edit the purpose and status for a group of storage locations

Edits the purpose and status for a group of storage locations by passing the group storage location ID (can be sent as mass assignment)

/rest/warehouses/locations/group

Success 200

Field Type Description
id Int The ID of the warehouse location
levelId Int The level ID of the warehouse location
label String The label of the warehouse location
purposeKey String The purpose key of the warehouse location
statusKey String The status key of the warehouse location
position Int The position of the warehouse location
fullLabel String The label with level path name
type String The type of the warehouse location (array values: 'small','medium','large','europallet')
notes String The notes of the warehouse location

Errors 4xx

This call does not have an error output.

Generate the warehouse location label

Generates the warehouse location label

/rest/warehouses/locations/{warehouseId}/label

Success 200

This call does not have a response output.

Errors 4xx

This call does not have an error output.

Get a warehouse location dimension

Gets a warehouse location dimension by ID. The warehouse location ID is required.

/rest/warehouses/locations/dimensions/{warehouseLocationDimensionId}

Parameters

Field Type Description
warehouseLocationDimensionId Int The ID of the warehouse location dimension

Success 200

Field Type Description
id Int The ID of the warehouse location dimension
parentId Int The parent ID of the warehouse location dimension
warehouseId Int The warehouse ID of the warehouse location dimension
level Int The level of the warehouse location dimension
name String The name of the warehouse location dimension
shortcut String The shortcut of the warehouse location dimension
separator String The separator of the warehouse location dimension
displayInName Int If true, the dimension prefix will be shown in the storage location name
isActiveForPickupPath Int Active flag for pickup path of the warehouse location dimension

Errors 4xx

This call does not have an error output.

List warehouse location dimensions

Lists all warehouse location dimensions.

/rest/warehouses/{warehouseId}/locations/dimensions

Parameters

Field Type Description
warehouseId Int The ID of the warehouse

Success 200

Field Type Description
id Int The ID of the warehouse location dimension
parentId Int The parent ID of the warehouse location dimension
warehouseId Int The warehouse ID of the warehouse location dimension
level Int The level of the warehouse location dimension
name String The name of the warehouse location dimension
shortcut String The shortcut of the warehouse location dimension
separator String The separator of the warehouse location dimension
displayInName Int If true, the dimension prefix will be shown in the storage location name
isActiveForPickupPath Int Active flag for pickup path of the warehouse location dimension

Errors 4xx

This call does not have an error output.

Create a warehouse location dimension

Creates a warehouse location dimension.

/rest/warehouses/locations/dimensions

Parameters

Field Type Description
parentId Int The parent ID of the warehouse location dimension
warehouseId Int The warehouse ID of the warehouse location dimension
level Int The level of the warehouse location dimension
name String The name of the warehouse location dimension
shortcut String The shortcut of the warehouse location dimension
separator String The separator of the warehouse location dimension
isActiveForPickupPath Int Active flag for pickup path of the warehouse location dimension

Success 200

Field Type Description
id Int The ID of the warehouse location dimension
parentId Int The parent ID of the warehouse location dimension
warehouseId Int The warehouse ID of the warehouse location dimension
level Int The level of the warehouse location dimension
name String The name of the warehouse location dimension
shortcut String The shortcut of the warehouse location dimension
separator String The separator of the warehouse location dimension
displayInName Int If true, the dimension prefix will be shown in the storage location name
isActiveForPickupPath Int Active flag for pickup path of the warehouse location dimension

Errors 4xx

This call does not have an error output.

Create multiple warehouse location dimensions

Creates multiple warehouse location dimension.

/rest/warehouses/locations/multiple_dimensions

Success 200

Field Type Description
id Int The ID of the warehouse location dimension
parentId Int The parent ID of the warehouse location dimension
warehouseId Int The warehouse ID of the warehouse location dimension
level Int The level of the warehouse location dimension
name String The name of the warehouse location dimension
shortcut String The shortcut of the warehouse location dimension
separator String The separator of the warehouse location dimension
displayInName Int If true, the dimension prefix will be shown in the storage location name
isActiveForPickupPath Int Active flag for pickup path of the warehouse location dimension

Errors 4xx

This call does not have an error output.

Update a warehouse location dimension

Updates a warehouse location dimension

/rest/warehouses/locations/dimensions/{warehouseLocationDimensionId}

Parameters

Field Type Description
warehouseLocationDimensionId Int The ID of the warehouse location dimension

Success 200

Field Type Description
id Int The ID of the warehouse location dimension
parentId Int The parent ID of the warehouse location dimension
warehouseId Int The warehouse ID of the warehouse location dimension
level Int The level of the warehouse location dimension
name String The name of the warehouse location dimension
shortcut String The shortcut of the warehouse location dimension
separator String The separator of the warehouse location dimension
displayInName Int If true, the dimension prefix will be shown in the storage location name
isActiveForPickupPath Int Active flag for pickup path of the warehouse location dimension

Errors 4xx

This call does not have an error output.

Delete a warehouse location dimension

Deletes a warehouse location dimension

/rest/warehouses/locations/dimensions/{warehouseLocationDimensionId}

Parameters

Field Type Description
warehouseLocationDimensionId Int The ID of the warehouse location dimension

Success 200

This call does not have a response output.

Errors 4xx

This call does not have an error output.

Get a warehouse location level

Gets a warehouse location level by ID. The warehouse location ID is required.

/rest/warehouses/locations/levels/{warehouseLocationLevelId}

Parameters

Field Type Description
warehouseLocationLevelId Int The ID of the warehouse location level

Success 200

Field Type Description
id Int The ID of the warehouse location level
parentId Int The parent ID of the warehouse location level
dimensionId Int The warehouse location dimension id of the warehouse location level
position Int The position of the warehouse location level
name String The name of the warehouse location level
type String The type of the warehouse location ['small','medium','large','europallet']
pathName String The complete path name from the level

Errors 4xx

This call does not have an error output.

List warehouse location levels

Lists all warehouse location levels.

/rest/warehouses/{warehouseId}/locations/levels

Parameters

Field Type Description
warehouseId Int The ID of the warehouse

Success 200

Field Type Description
id Int The ID of the warehouse location level
parentId Int The parent ID of the warehouse location level
dimensionId Int The warehouse location dimension id of the warehouse location level
position Int The position of the warehouse location level
name String The name of the warehouse location level
type String The type of the warehouse location ['small','medium','large','europallet']
pathName String The complete path name from the level

Errors 4xx

This call does not have an error output.

Create a warehouse location level

Creates a warehouse location level.

/rest/warehouses/locations/levels

Parameters

Field Type Description
parentId Int The parent ID of the warehouse location level
dimensionId Int The warehouse location dimension ID of the warehouse location level
position Int The position of the warehouse location level
name String The name of the warehouse location level

Success 200

Field Type Description
id Int The ID of the warehouse location level
parentId Int The parent ID of the warehouse location level
dimensionId Int The warehouse location dimension id of the warehouse location level
position Int The position of the warehouse location level
name String The name of the warehouse location level
type String The type of the warehouse location ['small','medium','large','europallet']
pathName String The complete path name from the level

Errors 4xx

This call does not have an error output.

Move a warehouse location level position

Moves a warehouse location level position

/rest/warehouses/locations/levels/positions

Success 200

This call does not have a response output.

Errors 4xx

This call does not have an error output.

Update a warehouse location level

Updates a warehouse location level

/rest/warehouses/locations/levels/{warehouseLocationLevelId}

Parameters

Field Type Description
warehouseLocationLevelId Int The ID of the warehouse location level

Success 200

Field Type Description
id Int The ID of the warehouse location level
parentId Int The parent ID of the warehouse location level
dimensionId Int The warehouse location dimension id of the warehouse location level
position Int The position of the warehouse location level
name String The name of the warehouse location level
type String The type of the warehouse location ['small','medium','large','europallet']
pathName String The complete path name from the level

Errors 4xx

This call does not have an error output.

Delete a warehouse location level

Deletes a warehouse location level

/rest/warehouses/locations/levels/{warehouseLocationLevelId}

Parameters

Field Type Description
warehouseLocationLevelId Int The ID of the warehouse location level

Success 200

This call does not have a response output.

Errors 4xx

This call does not have an error output.

Get a warehouse location structure

Gets a warehouse location structure by warehouse ID. The warehouse ID is required.

/rest/warehouses/structure/{warehouseId}

Success 200

Errors 4xx

This call does not have an error output.

Is this article helpful?

 

Thank you for your Feedback

you can close this field now!