CRM APIs
Information about a single address for a given customer
| HTTP method | GET |
| URI | https://api.rambase.net/sales/customers/{customerId}/addresses/{addressId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {customerId} |
Customer identifier
Integer, minimum 10000 |
| - URI parameter {addressId} |
Address identifier
Integer, minimum 1 |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 200 |
| API resource identifier | 180, version 33 |
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.
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.
| $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] |
| $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 |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $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. |
| $select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information. |
| $showCustomFields Boolean, optional | Set to "true" to include custom fields. Default value is false. |
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.
AddressId
Address identifier
>{Integer}</AddressId>Type
Type of address. I: Invoice address, S: Shipping address
Possible domain values can be found here
>{String}</Type>Status
Status of address
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>IsDefault
True if this is the default address of this type of address
>{Boolean}</IsDefault>ExternalReference
External address identifier. Normally defined by the customer.
>{String}</ExternalReference>Phone
Contact phone for address
>{String}</Phone>Fax
Contact fax for address
>{String}</Fax>Contact email for address
>{String}</Email>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>Firstname
Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.
>{String}</Firstname>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>DeliveryTerms
Delivery terms that apply for the shipping address. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce).
Possible domain values can be found here
>{String}</DeliveryTerms>DeliveryTermPlace
Named place related to delivery terms (Incoterms)
>{String}</DeliveryTermPlace>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. I: Invoice address, S: Shipping address
Possible domain values can be found here
": "{String}",Status
Status of address
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",IsDefault
True if this is the default address of this type of address
": "{Boolean}",ExternalReference
External address identifier. Normally defined by the customer.
": "{String}",Phone
Contact phone for address
": "{String}",Fax
Contact fax for address
": "{String}",Contact email for address
": "{String}"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}",Firstname
Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.
": "{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}",DeliveryTerms
Delivery terms that apply for the shipping address. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce).
Possible domain values can be found here
": "{String}",DeliveryTermPlace
Named place related to delivery terms (Incoterms)
": "{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 102738 HTTP 404 | Price list not found |
| Error 100055 HTTP 403 | You have only admittance to your own objects |