API

Procurement APIs

GET procurement/suppliers/{supplierId}/addresses

Supplier addresses (including shipping-, invoice-, etc. ) for the provided identifier

HTTP method GET
URI https://api.rambase.net/procurement/suppliers/{supplierId}/addresses
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {supplierId} RamBase supplier identifier
Integer, minimum 100
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 1846, version 10

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
1

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"
$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 supplier.
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 supplier 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 supplier.
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 supplier 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.

Format:
1
<Addresses>
2
     <Address>
3
          <AddressId
AddressId

Address identifier

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

Type of supplier address.

Possible domain values can be found here

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

Status of address

>{Integer}</Status>
6
          <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
7
          <IsDefault
IsDefault

True if this is the default address of this type of address

>{Boolean}</IsDefault>
8
          <ExternalReference
ExternalReference

External address identifier. Normally defined by the supplier.

>{String}</ExternalReference>
9
          <ContactInformation>
10
               <Phone
Phone

Contact phone for address

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

Contact fax for address

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

Contact email for address

>{String}</Email>
13
          </ContactInformation>
14
          <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>
15
          <Firstname
Firstname

Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.

>{String}</Firstname>
16
          <Attention
Attention

Attention note.

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

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

>{String}</City>
21
          <Region
Region

Region/province/state

>{String}</Region>
22
          <CountryCode
CountryCode

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

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

English name of country.

>{String}</Country>
24
          <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>
25
          <AddressLink
AddressLink

Supplier address reference

>{String}</AddressLink>
26
     </Address>
27
     <Paging
Paging

Detailed paging information for this list.

>
28
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
29
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
30
          <Page
Page

Page index

>{Integer}</Page>
31
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
32
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
33
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
34
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
35
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
36
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
37
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
38
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
39
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
40
     </Paging>
41
</Addresses>
1
{
2
     "addresses": [
3
          {
4
               "addressId
AddressId

Address identifier

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

Type of supplier address.

Possible domain values can be found here

": "{String}",
6
               "status
Status

Status of address

": "{Integer}",
7
               "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
8
               "isDefault
IsDefault

True if this is the default address of this type of address

": "{Boolean}",
9
               "externalReference
ExternalReference

External address identifier. Normally defined by the supplier.

": "{String}",
10
               "contactInformation": {
11
                    "phone
Phone

Contact phone for address

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

Contact fax for address

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

Contact email for address

": "{String}"
14
               },
15
               "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}",
16
               "firstname
Firstname

Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.

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

Attention note.

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

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

": "{String}",
22
               "region
Region

Region/province/state

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

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

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

English name of country.

": "{String}",
25
               "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}",
26
               "addressLink
AddressLink

Supplier address reference

": "{String}"
27
          }
28
     ],
29
     "paging
Paging

Detailed paging information for this list.

": {
30
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
31
          "position
Position

Position of the first element in the list

": "{Integer}",
32
          "page
Page

Page index

": "{Integer}",
33
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
34
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
35
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
36
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
37
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
38
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
39
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
40
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
41
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
42
     }
43
}

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 100050 HTTP 403 No admittance as customer {0}
Error 100053 HTTP 403 You have only admittance to your own suppliers