API

Logistics APIs

PUT logistics/stock-locations/{stockLocationId}

Save details for provided stock location

HTTP method PUT
URI https://api.rambase.net/logistics/stock-locations/{stockLocationId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {stockLocationId} Stock location identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 1991, version 6

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:
1
<StockLocation
StockLocation

This field is optional.

>
2
     <Name
Name

Name of stock location

This field is optional.

>
{String}</Name>
3
     <Description
Description

Description of stock location

This field is optional.

>
{String}</Description>
4
     <IsBlockedForPicking
IsBlockedForPicking

True if picking from this stock location is not allowed

This field is optional.

>
{Boolean}</IsBlockedForPicking>
5
     <IsBlockedForStockAssignments
IsBlockedForStockAssignments

True if block linking

This field is optional.

>
{Boolean}</IsBlockedForStockAssignments>
6
     <IsBlockedForStock
IsBlockedForStock

Determines whether or not this stock location is blocked for stock

This field is optional.

>
{Boolean}</IsBlockedForStock>
7
     <ContainsSecondHandProducts
ContainsSecondHandProducts

True if location contains second hand products. Location will be blocked for stock assignments.

This field is optional.

>
{Boolean}</ContainsSecondHandProducts>
8
     <ContainsSparepartsUsedForRepair
ContainsSparepartsUsedForRepair

True if location contains spareparts used for repair.

This field is optional.

>
{Boolean}</ContainsSparepartsUsedForRepair>
9
</StockLocation>
1
{
2
     "stockLocation
StockLocation

This field is optional.

":
{
3
          "name
Name

Name of stock location

This field is optional.

":
"{String}",
4
          "description
Description

Description of stock location

This field is optional.

":
"{String}",
5
          "isBlockedForPicking
IsBlockedForPicking

True if picking from this stock location is not allowed

This field is optional.

":
"{Boolean}",
6
          "isBlockedForStockAssignments
IsBlockedForStockAssignments

True if block linking

This field is optional.

":
"{Boolean}",
7
          "isBlockedForStock
IsBlockedForStock

Determines whether or not this stock location is blocked for stock

This field is optional.

":
"{Boolean}",
8
          "containsSecondHandProducts
ContainsSecondHandProducts

True if location contains second hand products. Location will be blocked for stock assignments.

This field is optional.

":
"{Boolean}",
9
          "containsSparepartsUsedForRepair
ContainsSparepartsUsedForRepair

True if location contains spareparts used for repair.

This field is optional.

":
"{Boolean}"
10
     }
11
}

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.

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

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

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

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:
1
1

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

Possible error codes the response might return:

Error 101079 HTTP 400 Mismatch in size of revision parameters
Error 101276 HTTP 400 Name of stock location is required
Error 101293 HTTP 400 Location id is required
Error 100199 HTTP 404 Location not found
Error 101294 HTTP 400 Warehouse location is not activated
Error 101277 HTTP 400 The name of the stock location does not match the name of the location
Error 101335 HTTP 400 Cannot change name of the stock location when it has children
Error 101296 HTTP 400 Location id can only be filled at top level
Error 103332 HTTP 400 Illegal combination of blocking properties
Error 107377 HTTP 400 Unassigned stock location cannot be blocked for stock
Error 107304 HTTP 400 Stock location cannot be blocked for stock if some goods already exist there