Sales APIs
Customer shipping- and invoice addresses for the provided identifier
| HTTP method | GET |
| URI | https://api.rambase.net/sales/customers/{customerId}/addresses |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {customerId} |
Customer identifier
Integer, minimum 10000 |
| Maximum page size ($top) | 80 |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 200 |
| API resource identifier | 157, version 37 |
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 |
| $expand String, optional | Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select 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. |
| $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. |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $showCustomFields Boolean, optional | Set to "true" to include custom fields. Default value is false. |
| $top String, optional | Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10. |
| $pageKey String, optional | Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response. |
| $filter String, optional | Use to filter the result list, see the Filtering and sorting page for more information. |
| $orderby String, optional | Use to order the result list, see the Filtering and sorting page for more information. |
| $inlinecount String, optional | Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none" |
Read more about filters and sorting on how to use filter parameters and named filters.
| AddressId Integer | Address identifier. |
| AddressLine1 String | First address line. |
| AddressLine2 String | Second address line. |
| Attention String | Attention note. |
| City String | City/town/village. |
| Country String | English name of country. |
| CountryCode String | Two-character code (ISO 3166) identifying the country. |
| ExternalReference String | External address identifier. Normally defined by the customer. |
| Fax String | Contact fax for address. |
| Firstname String | Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer. |
| GlobalLocationNumber String | 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. |
| IsDefault Boolean | True if this is the default address of this type of address. |
| Name String | 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. |
| Phone String | Contact phone for address. |
| PostalCode String | Postalcode/Postcode/ZIP. |
| Region String | Region/province/state. |
| Status Integer | Status of address. |
| Type String | Type of address. I: Invoice address, S: Shipping address. |
Read more about filters and sorting on how to use sortable parameters
| AddressId Integer | Address identifier |
| AddressLine1 String | First address line |
| AddressLine2 String | Second address line |
| Attention String | Attention note. |
| City String | City/town/village |
| Country String | English name of country. |
| CountryCode String | Two-character code (ISO 3166) identifying the country. |
| ExternalReference String | External address identifier. Normally defined by the customer. |
| Fax String | Contact fax for address |
| Firstname String | Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer. |
| GlobalLocationNumber String | 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. |
| IsDefault Boolean | True if this is the default address of this type of address |
| Name String | 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. |
| Phone String | Contact phone for address |
| PostalCode String | Postalcode/Postcode/ZIP |
| Region String | Region/province/state |
| Status Integer | Status of address |
| Type String | Type of address. I: Invoice address, S: Shipping address |
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>AddressLink
Address reference
>{String}</AddressLink>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>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}",AddressLink
Address reference
": "{String}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
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 100051 HTTP 400 | When logged in as supplier {0} you do not have access to this API resource |
| Error 100055 HTTP 403 | You have only admittance to your own objects |