Logistics APIs

GET logistics/stock-locations

List of all stock locations. To get root stock locations, filter for stock locations with ParentStockLocationId equal to blank ('')

HTTP method	GET
URI	https://api.rambase.net/logistics/stock-locations
Supported formats	Xml, Html, Json (ex. $format=json)
Maximum page size ($top)	80
Successful HTTP status code	200
API resource identifier	1992, version 23

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional	Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional	Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional	After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional	Set the database/company for the request
$expand String, optional	Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$select String, optional	Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$useMinimumVersion Integer, optional	Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$format String, optional	Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional	Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional	Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional	Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional	Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional	Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

DefaultPartChanged() Named filter	This is the suggested stock location for a part that is replaced in a product unit (LCM) during production or repair process.
ContainingContentType String	Type of content.
ContainsSecondHandProducts Boolean	True if location contains second hand products. Location will be blocked for stock assignments.
ContainsSparepartsUsedForRepair Boolean	True if location contains spareparts used for repair.
Description String	Description of stock location.
IsBlockedForPicking Boolean	True if picking from this stock location is not allowed.
IsBlockedForStockAssignments Boolean	True if block linking.
Label String	Name of current- and parent stock locations, including seperator for location.
LocationId Integer	Location identifier.
Name String	Name of stock location.
ParentStockLocationId Integer	Identifier to the parent stock location identifier..
Status Integer	Status of the stock location.
StockLocationId Integer	Stock location identifier.

Read more about filters and sorting on how to use sortable parameters

ContainingContentType String	Type of content
ContainsSecondHandProducts Boolean	True if location contains second hand products. Location will be blocked for stock assignments.
ContainsSparepartsUsedForRepair Boolean	True if location contains spareparts used for repair.
Description String	Description of stock location
IsBlockedForPicking Boolean	True if picking from this stock location is not allowed
IsBlockedForStockAssignments Boolean	True if block linking
Label String	Name of current- and parent stock locations, including seperator for location
LocationId Integer	Location identifier
Name String	Name of stock location
ParentStockLocationId Integer	Identifier to the parent stock location identifier.
Status Integer	Status of the stock location
StockLocationId Integer	Stock location identifier

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:

                                        <StockLocations>
                                    

                                             <StockLocation>
                                    

<StockLocationId

StockLocationId

Stock location identifier

>{Integer}</StockLocationId>

<Status

Status

Status of the stock location

Possible domain values can be found here

>{Integer}</Status>

<Name

Name

Name of stock location

>{String}</Name>

<Label

Label

Name of current- and parent stock locations, including seperator for location

>{String}</Label>

<Description

Description

Description of stock location

>{String}</Description>

<TreeLevel

TreeLevel

Level in the stock location tree. 0 is the root.

>{Integer}</TreeLevel>

<IsBlockedForPicking

IsBlockedForPicking

True if picking from this stock location is not allowed

>{Boolean}</IsBlockedForPicking>

<IsBlockedForStockAssignments

IsBlockedForStockAssignments

True if block linking

>{Boolean}</IsBlockedForStockAssignments>

<IsBlockedForStock

IsBlockedForStock

Determines whether or not this stock location is blocked for stock

>{Boolean}</IsBlockedForStock>

<HasStock

HasStock

Determines whether or not there is a stock available for this stock location

>{Boolean}</HasStock>

<HasReplenishmentConfigurations

HasReplenishmentConfigurations

This stock location contains replenishment configurations which contains a products replenishment point and can contain a replenishment quantity

This field is greyed out because it is an expandable field. You have to add $expand=StockLocation.HasReplenishmentConfigurations in your request URI to get this field

>{Boolean}</HasReplenishmentConfigurations>

<HasChildren

HasChildren

True if stock location has any child stock locations

This field is greyed out because it is an expandable field. You have to add $expand=StockLocation.HasChildren in your request URI to get this field

>{Boolean}</HasChildren>

<NumberOfChildren

NumberOfChildren

Number of stock locations with current stock location as parent

This field is greyed out because it is an expandable field. You have to add $expand=StockLocation.NumberOfChildren in your request URI to get this field

>{Integer}</NumberOfChildren>

                                                  <Location>
                                    

<LocationId

LocationId

Location identifier

>{Integer}</LocationId>

<ShortName

ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>

<LocationLink

LocationLink

Location reference

>{String}</LocationLink>

                                                  </Location>
                                    

<StockLocationLink

StockLocationLink

Stock location reference

>{String}</StockLocationLink>

                                             </StockLocation>
                                    

<Paging

Paging

Detailed paging information for this list.

<PageSize

PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>

<Position

Position

Position of the first element in the list

>{Integer}</Position>

<Page

Page

Page index

>{Integer}</Page>

<FirstPageKey

FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>

<FirstPage

FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>

<PreviousPageKey

PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>

<PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>

<NextPageKey

NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>

<NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>

<LastPageKey

LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>

<LastPage

LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>

<Size

Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>

                                             </Paging>
                                    

                                        </StockLocations>
                                    

{

                                             "stockLocations": [
                                    

{

"stockLocationId

StockLocationId

Stock location identifier

": "{Integer}",

"status

Status

Status of the stock location

Possible domain values can be found here

": "{Integer}",

"name

Name

Name of stock location

": "{String}",

"label

Label

Name of current- and parent stock locations, including seperator for location

": "{String}",

"description

Description

Description of stock location

": "{String}",

"treeLevel

TreeLevel

Level in the stock location tree. 0 is the root.

": "{Integer}",

"isBlockedForPicking

IsBlockedForPicking

True if picking from this stock location is not allowed

": "{Boolean}",

"isBlockedForStockAssignments

IsBlockedForStockAssignments

True if block linking

": "{Boolean}",

"isBlockedForStock

IsBlockedForStock

Determines whether or not this stock location is blocked for stock

": "{Boolean}",

"hasStock

HasStock

Determines whether or not there is a stock available for this stock location

": "{Boolean}",

"hasReplenishmentConfigurations

HasReplenishmentConfigurations

This stock location contains replenishment configurations which contains a products replenishment point and can contain a replenishment quantity

This field is greyed out because it is an expandable field. You have to add $expand=StockLocation.HasReplenishmentConfigurations in your request URI to get this field

": "{Boolean}",

"hasChildren

HasChildren

True if stock location has any child stock locations

This field is greyed out because it is an expandable field. You have to add $expand=StockLocation.HasChildren in your request URI to get this field

": "{Boolean}",

"numberOfChildren

NumberOfChildren

Number of stock locations with current stock location as parent

This field is greyed out because it is an expandable field. You have to add $expand=StockLocation.NumberOfChildren in your request URI to get this field

": "{Integer}",

                                                       "location": {
                                    

"locationId

LocationId

Location identifier

": "{Integer}",

"shortName

ShortName

Unique abbreviation/short name of the location

": "{String}",

"locationLink

LocationLink

Location reference

": "{String}"

},

"stockLocationLink

StockLocationLink

Stock location reference

": "{String}"

}

],

"paging

Paging

Detailed paging information for this list.

": {

"pageSize

PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",

"position

Position

Position of the first element in the list

": "{Integer}",

"page

Page

Page index

": "{Integer}",

"firstPageKey

FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",

"firstPage

FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",

"previousPageKey

PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",

"previousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",

"nextPageKey

NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",

"nextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",

"lastPageKey

LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",

"lastPage

LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",

"size

Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"

}

}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

POST

Print stock labels

AOP/100694

Possible error codes the response might return:

Error 100036 HTTP 400

Missing required input parameter: {0}