This API provides the ability look up a Customer’s Address by the Customer Id. The response will return all active addresses stored for a given customer.
General Technical Requirements
The following technical requirements apply to all requests for this API.
brandAbbreviation is the abbreviation for the brand customerId is the internal customer id (encrypted customer id may also be used)
HTTP Headers
The HTTP header must contain the following element: x-omeda-appid a unique id provided to you by Omeda to access your data. The request will fail without a valid id.
Content Type
The content type is application/json. JSON application/json
JSON is the preferred data exchange format, because it is lightweight and, in most cases, faster to process and utilizes less bandwidth. There are many available open-source JSON libraries available. See json.org for details.
Retrieves a record containing all available addresses information about a customer.
Field Definition
The following tables describe the hierarchical data elements.
In addition to the below elements, a SubmissionId element will also be returned with all responses. This is a unique identifier for the web services response. It can be used to cross-reference the response in Omeda’s database.
Addresses Elements
Element Name
Description
Customer
Element containing an HTTP reference to the owning customer resource.
Addresses
each Address element contains all address information.
any additional mailing address information pertinent to delivery that isn’t included in the Company, Street, or ApartmentMailStop elements
City
No
String
city name
RegionCode
No
String
the state, province or region code
Region
No
String
when the RegionCode is not available, the descriptive state, province or regional information
PostalCode
No
String
ZIP (USA) or postal code. For USA addresses, this will contain the full ZIP+4 code, if it is available
CountryCode
No
String
the ISO 3166-1 alpha-3 country code
Country
No
String
the full country description
ChangedDate
Yes
DateTime
Date & time record last changed. yyyy-MM-dd HH:mm:ss format. Example: 2010-03-08 21:23:34.
StatusCode
Yes
Byte
Status of the postal address: 1 is the primary address, 2 is an active address.
Response
HTTP Response Codes
Status
Description
200 OK
The request has succeeded. See Example Response below.
403 Forbidden
Typically, this error occurs when the credentials are erroneous. Potentially, an incorrect x-omeda-appid.
404 Not Found
Typically, this error occurs with a malformed URL or the resource that is searched for is not found.
500 Internal Server Error
In the rare case that there is a server-side problem, this response will be returned. This generally indicates a problem of a more serious nature, and submitting additional requests may not be advisable. Please contact your Omeda Account Representative if the issue continues.