The Locations resource allows locations to be listed and viewed. Here are some examples URIs:


· /Locations - returns all locations;

· /Locations?AllowReorder=true - returns locations with allowReorder flag set to true;

· /Locations?name=ABC - returns locations with description starting with ABC

 

The full range of URIs and HTTP Verbs supported are:

Operation

HTTP Action

List of paginated locations

GET /Locations

Get location

GET /Locations/{id}


These filters can be used with the GET Locations endpoint:

Filter
Description
name
Only return locations with name starts with the specific name
allowReorder
Only return locations having same allowReorder flag value

Filters are used by adding the filter and value to the URI: /Locations?name=ABC

 

Available Fields for Location:

Property
Type
Length
Required
Notes
Id
Guid
 
 
Required for PUT, Ignored for POST operations
Name
String
256
Yes
Location description
IsDefault
Boolean
 
 
Indicate if location is default
AllowReorder
Boolean
 
 
Indicate if this location supports reordering products
Bins
Array of Bin
 
 
List of bins (may be boxes or shelf) inside location. See description below
FixedAssetsLocation
Boolean

True if this location is used for Fixed assets only
PickZones
String 512
Comma-delimited list if Pick zones in the warehouse
IsDeprecated
Boolean

True if location is not active (deprecated)

 

Available Fields for Bin:

Property
Type
Length
Required
Notes
Id
Guid
 
 
Required for PUT, Ignored for POST operations
Name
String
256
Yes
Bin description