Logistics APIs
Saves location details for provided identifier
| HTTP method | PUT |
| URI | https://api.rambase.net/logistics/locations/{locationId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {locationId} |
Location identifier
Integer, minimum 10000 |
| Successful HTTP status code | 200 |
| API resource identifier | 2006, version 19 |
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.
Location
This field is optional.
>Type
Type of location
Applicable domain values can be found here
This field is optional.
>{String}</Type>Name
Name of warehouse location
This field is optional.
>{String}</Name>ShortName
Unique abbreviation/short name of the location
This field is optional.
>{String}</ShortName>StockLocationLabelSeparator
Optional character used for separating stock location names in stock location label.
Maximum value: 1
This field is optional.
>{String}</StockLocationLabelSeparator>ManufacturingMaterialLocationLabelSeparator
Optional character used for separating manufacturing material location names in manufacturing material location label.
Maximum value: 1
This field is optional.
>{String}</ManufacturingMaterialLocationLabelSeparator>IsRentalDepotCapable
Indicates if the location can be used as a rental depot
This field is optional.
>{Boolean}</IsRentalDepotCapable>Shipment
This field is optional.
>RequirePackages
Packages are required to ship
This field is optional.
>{Boolean}</RequirePackages>PickAutomatically
If the value is true, the system will automatically confirm pick of all transaction items for this location. Hence will also pick be automatically unpicked if the process that triggered confirmation of pick is reverted.
This field is optional.
>{Boolean}</PickAutomatically>LengthUnit
Default measurement unit for length to store on documents
This field is optional.
>{String}</LengthUnit>WeightUnit
Default measurement unit for weight to store on documents
This field is optional.
>{String}</WeightUnit>Address
This field is optional.
>UseAsInvoiceAddressForCompany
Used to indicate that this location is used for invoice address for the company
This field is optional.
>{Boolean}</UseAsInvoiceAddressForCompany>Location
This field is optional.
": {Type
Type of location
Applicable domain values can be found here
This field is optional.
": "{String}",Name
Name of warehouse location
This field is optional.
": "{String}",ShortName
Unique abbreviation/short name of the location
This field is optional.
": "{String}",StockLocationLabelSeparator
Optional character used for separating stock location names in stock location label.
Maximum value: 1
This field is optional.
": "{String}",ManufacturingMaterialLocationLabelSeparator
Optional character used for separating manufacturing material location names in manufacturing material location label.
Maximum value: 1
This field is optional.
": "{String}",IsRentalDepotCapable
Indicates if the location can be used as a rental depot
This field is optional.
": "{Boolean}",Shipment
This field is optional.
": {RequirePackages
Packages are required to ship
This field is optional.
": "{Boolean}",PickAutomatically
If the value is true, the system will automatically confirm pick of all transaction items for this location. Hence will also pick be automatically unpicked if the process that triggered confirmation of pick is reverted.
This field is optional.
": "{Boolean}",LengthUnit
Default measurement unit for length to store on documents
This field is optional.
": "{String}",WeightUnit
Default measurement unit for weight to store on documents
This field is optional.
": "{String}"Address
This field is optional.
": {UseAsInvoiceAddressForCompany
Used to indicate that this location is used for invoice address for the company
This field is optional.
": "{Boolean}"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.
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 101015 HTTP 404 | Permission not found |
| Error 100865 HTTP 404 | Customer not found |
| Error 101375 HTTP 400 | Direction of the Shipping Service mismatch with type of transaction document |
| Error 101399 HTTP 400 | Customer account in shipping service mismatch with this customer account |
| Error 101385 HTTP 400 | The carrier that offers this shipping service is not activ (status 4) |
| Error 100942 HTTP 400 | External reference should be unique |
| Error 108670 HTTP 400 | Discount percentage must be a number between 0 and 100 |
| Error 105264 HTTP 400 | Cannot update separator if at least one manufacturing material location exists. |