Procurement APIs
Creates a new address for provided supplier. If IsDefault is omitted it will be set to "True" if no address of same type exists, otherwise "False".
| HTTP method | POST |
| 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 |
| Successful HTTP status code | 201 |
| API resource identifier | 1847, 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.
Type
Required/mandatory field
Type of supplier address.
Applicable domain values can be found here
>{String}</Type>IsDefault
True if this is the default address of this type of address
Default value: False
This field is optional.
>{Boolean}</IsDefault>ExternalReference
External address identifier. Normally defined by the supplier.
This field is optional.
>{String}</ExternalReference>ContactInformation
This field is optional.
>Phone
Contact phone for address
This field is optional.
>{String}</Phone>Contact email for address
Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$
This field is optional.
>{String}</Email>Fax
Contact fax for address
This field is optional.
>{String}</Fax>Name
Required/mandatory field
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.
This field is optional.
>{String}</Firstname>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
City/town/village
This field is optional.
>{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.
Input must match the following regular expression pattern: ^[0-9]{13}$
This field is optional.
>{String}</GlobalLocationNumber>Type
Required/mandatory field
Type of supplier address.
Applicable domain values can be found here
": "{String}",IsDefault
True if this is the default address of this type of address
Default value: False
This field is optional.
": "{Boolean}",ExternalReference
External address identifier. Normally defined by the supplier.
This field is optional.
": "{String}",ContactInformation
This field is optional.
": {Phone
Contact phone for address
This field is optional.
": "{String}",Contact email for address
Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$
This field is optional.
": "{String}",Fax
Contact fax for address
This field is optional.
": "{String}"Name
Required/mandatory field
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.
This field is optional.
": "{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
City/town/village
This field is optional.
": "{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.
Input must match the following regular expression pattern: ^[0-9]{13}$
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>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 supplier.
>{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>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 supplier 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 supplier.
": "{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}",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 101015 HTTP 404 | Permission not found |
| Error 105991 HTTP 400 | Event is not of the same type as event set on the automated flow |
| Error 100012 HTTP 400 | {0} must exist in {1} |
| Error 101399 HTTP 400 | Customer account in shipping service mismatch with this customer account |
| Error 101385 HTTP 400 | The carrier that offers this shipping service is not activ (status 4) |
| Error 100943 HTTP 400 | Postcode is not valid |
| Error 100944 HTTP 400 | Mismatch between post code and city |