API

Procurement APIs

PUT procurement/suppliers/{supplierId}/addresses/{addressId}

Updates an existing address for a specific supplier

HTTP method PUT
URI https://api.rambase.net/procurement/suppliers/{supplierId}/addresses/{addressId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {supplierId} RamBase supplier identifier
Integer, minimum 100
- URI parameter {addressId} Address identifier
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 1849, version 11

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
<Address
Address

This field is optional.

>
2
     <IsDefault
IsDefault

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

This field is optional.

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

External address identifier. Normally defined by the supplier.

This field is optional.

>{String}</ExternalReference>
4
     <ContactInformation
ContactInformation

This field is optional.

>
5
          <Phone
Phone

Contact phone for address

This field is optional.

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

Contact fax for address

This field is optional.

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

Contact email for address

Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$

This field is optional.

>{String}</Email>
8
     </ContactInformation>
9
     <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>
10
     <Firstname
Firstname

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

This field is optional.

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

Attention note.

This field is optional.

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

First address line

This field is optional.

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

Second address line

This field is optional.

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

Postalcode/Postcode/ZIP

This field is optional.

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

City/town/village

This field is optional.

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

Region/province/state

This field is optional.

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

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

This field is optional.

>{String}</CountryCode>
18
     <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.

Input must match the following regular expression pattern: ^[0-9]{13}$

This field is optional.

>{String}</GlobalLocationNumber>
19
</Address>
1
{
2
     "address
Address

This field is optional.

": {
3
          "isDefault
IsDefault

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

This field is optional.

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

External address identifier. Normally defined by the supplier.

This field is optional.

": "{String}",
5
          "contactInformation
ContactInformation

This field is optional.

": {
6
               "phone
Phone

Contact phone for address

This field is optional.

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

Contact fax for address

This field is optional.

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

Contact email for address

Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$

This field is optional.

": "{String}"
9
          },
10
          "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}",
11
          "firstname
Firstname

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

This field is optional.

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

Attention note.

This field is optional.

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

First address line

This field is optional.

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

Second address line

This field is optional.

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

Postalcode/Postcode/ZIP

This field is optional.

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

City/town/village

This field is optional.

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

Region/province/state

This field is optional.

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

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

This field is optional.

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

Input must match the following regular expression pattern: ^[0-9]{13}$

This field is optional.

": "{String}"
20
     }
21
}

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.

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.

Format:
1
1

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 102667 HTTP 404 Customer group not found
Error 100865 HTTP 404 Customer not found
Error 100950 HTTP 400 Cannot change Classification to "Z", or from "Z" when the customer is registered
Error 105470 HTTP 400 Can not deactivate customers with active SUB's
Error 100948 HTTP 400 Can not deactivate customers with open transaction documents
Error 100949 HTTP 400 Can not delete customers with open transaction documents
Error 100944 HTTP 400 Mismatch between post code and city