API

Logistics APIs

POST logistics/locations

Resource for creating a new location

HTTP method POST
URI https://api.rambase.net/logistics/locations
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 6478, 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
<Location>
2
     <ShortName
ShortName

Required/mandatory field

Unique abbreviation/short name of the location

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

Name of warehouse location

This field is optional.

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

Phone number for the location

This field is optional.

>{String}</Phone>
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
     <Address>
7
          <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>
8
          <Attention
Attention

Attention note.

This field is optional.

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

First address line

This field is optional.

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

Second address line

This field is optional.

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

Postalcode/Postcode/ZIP

This field is optional.

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

City/town/village

This field is optional.

>{String}</City>
13
          <State
State

Region/province/state

This field is optional.

>{String}</State>
14
          <CountryCode
CountryCode

Required/mandatory field

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

>{String}</CountryCode>
15
     </Address>
16
</Location>
1
{
2
     "location": {
3
          "shortName
ShortName

Required/mandatory field

Unique abbreviation/short name of the location

": "{String}",
4
          "name
Name

Name of warehouse location

This field is optional.

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

Phone 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
          "address": {
8
               "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}",
9
               "attention
Attention

Attention note.

This field is optional.

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

First address line

This field is optional.

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

Second address line

This field is optional.

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

Postalcode/Postcode/ZIP

This field is optional.

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

City/town/village

This field is optional.

": "{String}",
14
               "state
State

Region/province/state

This field is optional.

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

Required/mandatory field

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

": "{String}"
16
          }
17
     }
18
}

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

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.

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

Format:
1
<Location>
2
     <LocationId
LocationId

Location identifier

>{Integer}</LocationId>
3
     <Status
Status

Status of warehouse location

Possible domain values can be found here

>{Integer}</Status>
4
     <Type
Type

Type of location

Possible domain values can be found here

>{String}</Type>
5
     <Name
Name

Name of warehouse location

>{String}</Name>
6
     <ShortName
ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>
7
     <Phone
Phone

Phone number for the location

>{String}</Phone>
8
     <Email
Email

Email address for the location

>{String}</Email>
9
     <AllowIncomingGoodsTransfer
AllowIncomingGoodsTransfer

True if a location has a corresponding SUP so that goods transfer can be performed.

>{Boolean}</AllowIncomingGoodsTransfer>
10
     <StockLocationLabelSeparator
StockLocationLabelSeparator

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

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

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

>{String}</ManufacturingMaterialLocationLabelSeparator>
12
     <IsRentalDepotCapable
IsRentalDepotCapable

Indicates if the location can be used as a rental depot

>{Boolean}</IsRentalDepotCapable>
13
     <Shipment>
14
          <RequirePackages
RequirePackages

Packages are required to ship

>{Boolean}</RequirePackages>
15
          <PickAutomatically
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.

>{Boolean}</PickAutomatically>
16
          <LengthUnit
LengthUnit

Default measurement unit for length to store on documents

>{String}</LengthUnit>
17
          <WeightUnit
WeightUnit

Default measurement unit for weight to store on documents

>{String}</WeightUnit>
18
     </Shipment>
19
     <Address>
20
          <AddressId
AddressId

Location address identifier

>{Integer}</AddressId>
21
          <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.

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

Attention note.

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

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

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

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

>{String}</CountryCode>
28
          <Country
Country

English name of country.

>{String}</Country>
29
          <State
State

Region/province/state

>{String}</State>
30
          <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.

>{String}</GlobalLocationNumber>
31
          <UseAsInvoiceAddressForCompany
UseAsInvoiceAddressForCompany

Used to indicate that this location is used for invoice address for the company

>{Boolean}</UseAsInvoiceAddressForCompany>
32
          <AddressLink
AddressLink

Reference to the location address.

>{String}</AddressLink>
33
     </Address>
34
</Location>
1
{
2
     "location": {
3
          "locationId
LocationId

Location identifier

": "{Integer}",
4
          "status
Status

Status of warehouse location

Possible domain values can be found here

": "{Integer}",
5
          "type
Type

Type of location

Possible domain values can be found here

": "{String}",
6
          "name
Name

Name of warehouse location

": "{String}",
7
          "shortName
ShortName

Unique abbreviation/short name of the location

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

Phone number for the location

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

Email address for the location

": "{String}",
10
          "allowIncomingGoodsTransfer
AllowIncomingGoodsTransfer

True if a location has a corresponding SUP so that goods transfer can be performed.

": "{Boolean}",
11
          "stockLocationLabelSeparator
StockLocationLabelSeparator

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

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

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

": "{String}",
13
          "isRentalDepotCapable
IsRentalDepotCapable

Indicates if the location can be used as a rental depot

": "{Boolean}",
14
          "shipment": {
15
               "requirePackages
RequirePackages

Packages are required to ship

": "{Boolean}",
16
               "pickAutomatically
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.

": "{Boolean}",
17
               "lengthUnit
LengthUnit

Default measurement unit for length to store on documents

": "{String}",
18
               "weightUnit
WeightUnit

Default measurement unit for weight to store on documents

": "{String}"
19
          },
20
          "address": {
21
               "addressId
AddressId

Location address identifier

": "{Integer}",
22
               "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.

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

Attention note.

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

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

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

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

": "{String}",
29
               "country
Country

English name of country.

": "{String}",
30
               "state
State

Region/province/state

": "{String}",
31
               "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.

": "{String}",
32
               "useAsInvoiceAddressForCompany
UseAsInvoiceAddressForCompany

Used to indicate that this location is used for invoice address for the company

": "{Boolean}",
33
               "addressLink
AddressLink

Reference to the location address.

": "{String}"
34
          }
35
     }
36
}

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.