Search the Omeda Knowledge Base

Customer Lookup By External ID

Summary

This API provides the ability look up a Customer by the External Customer Id.   The response will include Customer Id and various links to look up additional Customer information such as Demographics, Addresses, etc for a single Customer record.

General Technical Requirements

The following technical requirements apply to all requests for this API.

Base Resource URI

Production: https://ows.omeda.com/webservices/rest/brand/{brandAbbreviation}/customer/{externalCustomerIdNamespace}/externalcustomeridnamespace/{externalCustomerId}/externalcustomerid/* 
 
Testing:    https://ows.omedastaging.com/webservices/rest/brand/{brandAbbreviation}/customer/{externalCustomerIdNamespace}/externalcustomeridnamespace/{externalCustomerId}/externalcustomerid/*
brandAbbreviation
is the abbreviation for the brand
externalCustomerId
is the client’s customer ID
externalCustomerIdNamespace
is the type of ID you would like to lookup. Please contact your Omeda Account Representative for what code to use here.

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.

Supported HTTP Methods

There is one HTTP method supported:

  1. GET : See W3C’s GET specs for details.

Lookup Customer By External ID

Retrieves a single active customer record containing all available name, contact, and demographic information about the customer.

Field Definition

The following table describes the data elements present on the response from the API.

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.

Customer Elements

Element Name Always Returned… Data Type Description
Id Yes Integer internal id (for use on certain databases)
EncryptedCustomerId No String The Encrypted Customer Id for the customer
Customer Yes Link a link reference to the customer data as a resource.
Addresses Yes Link a link reference to the address data as a resource.
Phones Yes Link a link reference to the phone data as a resource.
EmailAddresses Yes Link a link reference to the email data as a resource.
CustomerDemographics Yes Link a link reference to the customer demographic data as a resource.
Subscriptions Yes Link a link reference to the subscription data as a resource.

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.

Success

{
   "Id" : 12345,
   "Customer" :             "https://ows.omedastaging.com/webservices/rest/brand/FOO/customer/12345/*",  
   "Addresses" :            "https://ows.omedastaging.com/webservices/rest/brand/FOO/customer/12345/address/*",  
   "Phones" :               "https://ows.omedastaging.com/webservices/rest/brand/FOO/customer/12345/phone/*",
   "EmailAddresses" :       "https://ows.omedastaging.com/webservices/rest/brand/FOO/customer/12345/email/*",
   "CustomerDemographics" : "https://ows.omedastaging.com/webservices/rest/brand/FOO/customer/12345/demographic/*",
   "Subscriptions" :        "https://ows.omedastaging.com/webservices/rest/brand/FOO/customer/12345/subscription/*",
   "SubmissionId" : "24B9BF6F-0677-462B-942A-D87EEBD10F77"
}

Failure

{
   "SubmissionId":"ec0c2ba6-13f4-4934-8efa-74c2ccb33f1d",
   "Errors":[
      {
         "Error":"External Customer Id 12345 Not Found for the External Customer Id Namespace RDRNUM"
      }
   ]
}
Possible Error Messages

In the event of an error, an error response will be returned. Here are some of the possible responses you might receive.

External Customer Id {externalCustomerId} not found for the External Customer Id Namespace {externalCustomerIdNamespace}.
Last Updated On November 30, 2018
Tags:
Knowledge Base Feedback