Logistics APIs
Resource for creating a new location address
| HTTP method | POST |
| URI | https://api.rambase.net/logistics/locations/{locationId}/addresses |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {locationId} |
Location identifier
Integer, minimum 10000 |
| Successful HTTP status code | 201 |
| API resource identifier | 6507, version 2 |
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.
ContactInformation
This field is optional.
>Phone
Contact phone for address
This field is optional.
>{String}</Phone>Contact email for address
This field is optional.
>{String}</Email>Name
Required/mandatory field
Name of address
>{String}</Name>Attention
Attention note.
This field is optional.
>{String}</Attention>AddressLine1
First address line
This field is optional.
>{String}</AddressLine1>AddressLine2
Second address line
This field is optional.
>{String}</AddressLine2>PostalCode
Required/mandatory field
Postalcode/Postcode/ZIP
>{String}</PostalCode>City
Required/mandatory field
City/town/village
>{String}</City>Region
Region/province/state
This field is optional.
>{String}</Region>CountryCode
Required/mandatory field
Two-character code (ISO 3166) identifying the country.
>{String}</CountryCode>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.
This field is optional.
>{String}</GlobalLocationNumber>ContactInformation
This field is optional.
": {Phone
Contact phone for address
This field is optional.
": "{String}",Contact email for address
This field is optional.
": "{String}"Name
Required/mandatory field
Name of address
": "{String}",Attention
Attention note.
This field is optional.
": "{String}",AddressLine1
First address line
This field is optional.
": "{String}",AddressLine2
Second address line
This field is optional.
": "{String}",PostalCode
Required/mandatory field
Postalcode/Postcode/ZIP
": "{String}",City
Required/mandatory field
City/town/village
": "{String}",Region
Region/province/state
This field is optional.
": "{String}",CountryCode
Required/mandatory field
Two-character code (ISO 3166) identifying the country.
": "{String}",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.
This field is optional.
": "{String}"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.
AddressId
Address identifier
>{Integer}</AddressId>Type
Type of address. M: Main, S: Shipping address
Possible domain values can be found here
>{String}</Type>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>IsDefault
True if this is the default address of the location
>{Boolean}</IsDefault>Phone
Contact phone for address
>{String}</Phone>Contact email for address
>{String}</Email>Name
Name of address
>{String}</Name>Attention
Attention note.
>{String}</Attention>AddressLine1
First address line
>{String}</AddressLine1>AddressLine2
Second address line
>{String}</AddressLine2>PostalCode
Postalcode/Postcode/ZIP
>{String}</PostalCode>City
City/town/village
>{String}</City>Region
Region/province/state
>{String}</Region>CountryCode
Two-character code (ISO 3166) identifying the country.
>{String}</CountryCode>Country
English name of country.
>{String}</Country>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>AddressId
Address identifier
": "{Integer}",Type
Type of address. M: Main, S: Shipping address
Possible domain values can be found here
": "{String}",Status
Status of address
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",IsDefault
True if this is the default address of the location
": "{Boolean}",Phone
Contact phone for address
": "{String}",Contact email for address
": "{String}"Name
Name of address
": "{String}",Attention
Attention note.
": "{String}",AddressLine1
First address line
": "{String}",AddressLine2
Second address line
": "{String}",PostalCode
Postalcode/Postcode/ZIP
": "{String}",City
City/town/village
": "{String}",Region
Region/province/state
": "{String}",CountryCode
Two-character code (ISO 3166) identifying the country.
": "{String}",Country
English name of country.
": "{String}",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}"
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 100036 HTTP 400 | Missing required input parameter: {0} |
| Error 100946 HTTP 400 | Country code is not valid |
| Error 100945 HTTP 400 | Mismatch between country code and country |
| Error 100947 HTTP 400 | Region/State is required for provided country |
| Error 100952 HTTP 400 | Country does not have region/state |
| Error 100943 HTTP 400 | Postcode is not valid |
| Error 100944 HTTP 400 | Mismatch between post code and city |