API

Logistics APIs

PUT logistics/locations/{locationId}

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 9

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
<Location
Location

This field is optional.

>
2
     <Name
Name

Name of warehouse location

This field is optional.

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

Phone number for the location

This field is optional.

>{String}</Phone>
4
     <Fax
Fax

Fax number for the location

This field is optional.

>{String}</Fax>
5
     <Email
Email

Email address for the location

Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$

This field is optional.

>{String}</Email>
6
     <StockLocationLabelSeparator
StockLocationLabelSeparator

Optional character used for separating stock location names in stock location label.

Maximum value: 1

This field is optional.

>{String}</StockLocationLabelSeparator>
7
     <ManufacturingMaterialLocationLabelSeparator
ManufacturingMaterialLocationLabelSeparator

Optional character used for separating manufacturing material location names in manufacturing material location label.

Maximum value: 1

This field is optional.

>{String}</ManufacturingMaterialLocationLabelSeparator>
8
     <Address
Address

This field is optional.

>
9
          <Name
Name

Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.

This field is optional.

>{String}</Name>
10
          <Attention
Attention

Attention note.

This field is optional.

>{String}</Attention>
11
          <AddressLine1
AddressLine1

First address line

This field is optional.

>{String}</AddressLine1>
12
          <AddressLine2
AddressLine2

Second address line

This field is optional.

>{String}</AddressLine2>
13
          <PostalCode
PostalCode

Postalcode/Postcode/ZIP

This field is optional.

>{String}</PostalCode>
14
          <City
City

City/town/village

This field is optional.

>{String}</City>
15
          <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

This field is optional.

>{String}</CountryCode>
16
          <GlobalLocationNumber
GlobalLocationNumber

Global location number (GLN) for the address. GLN is part of the GS1 systems of standards and is a 13-digit number used to uniquely identify any legal entity, functional entity, or physical location.

Input must match the following regular expression pattern: ^[0-9]{13}$

This field is optional.

>{String}</GlobalLocationNumber>
17
     </Address>
18
</Location>
1
{
2
     "location
Location

This field is optional.

": {
3
          "name
Name

Name of warehouse location

This field is optional.

": "{String}",
4
          "phone
Phone

Phone number for the location

This field is optional.

": "{String}",
5
          "fax
Fax

Fax number for the location

This field is optional.

": "{String}",
6
          "email
Email

Email address for the location

Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$

This field is optional.

": "{String}",
7
          "stockLocationLabelSeparator
StockLocationLabelSeparator

Optional character used for separating stock location names in stock location label.

Maximum value: 1

This field is optional.

": "{String}",
8
          "manufacturingMaterialLocationLabelSeparator
ManufacturingMaterialLocationLabelSeparator

Optional character used for separating manufacturing material location names in manufacturing material location label.

Maximum value: 1

This field is optional.

": "{String}",
9
          "address
Address

This field is optional.

": {
10
               "name
Name

Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.

This field is optional.

": "{String}",
11
               "attention
Attention

Attention note.

This field is optional.

": "{String}",
12
               "addressLine1
AddressLine1

First address line

This field is optional.

": "{String}",
13
               "addressLine2
AddressLine2

Second address line

This field is optional.

": "{String}",
14
               "postalCode
PostalCode

Postalcode/Postcode/ZIP

This field is optional.

": "{String}",
15
               "city
City

City/town/village

This field is optional.

": "{String}",
16
               "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

This field is optional.

": "{String}",
17
               "globalLocationNumber
GlobalLocationNumber

Global location number (GLN) for the address. GLN is part of the GS1 systems of standards and is a 13-digit number used to uniquely identify any legal entity, functional entity, or physical location.

Input must match the following regular expression pattern: ^[0-9]{13}$

This field is optional.

": "{String}"
18
          }
19
     }
20
}

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 101015 HTTP 404 Permission not found
Error 100865 HTTP 404 Customer not found
Error 105311 HTTP 400 Manufacturing material location's parent belongs to other location
Error 105318 HTTP 400 Parent manufacturing material location is not active
Error 105283 HTTP 400 Name of manufacturing material location cannot be empty
Error 105282 HTTP 400 Name of main manufacturing material location does not match the name of location
Error 105281 HTTP 400 Cannot change name of manufacturing material location when it has got children
Error 105339 HTTP 400 You cannot include separator in the name of manufacturing material location
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