Skip to main content
Skip table of contents

API – Overview

Knowledge Base Home

Customer Lookup

The following APIs allow you to lookup various types of customer data on your database.

Behavior Attribute Lookup by Customer Id — The behavior attribute lookup API call returns all behavior attributes (regular and olytics) information for a specified customer, behavior, and date range.
Behavior Lookup By Customer Id — The behavior lookup API call returns behavior information for a specified customer. Behavior information can be requested for a specific behavior OR for behaviors associated with a specific product OR all behaviors
Customer Change Lookup — This service returns a list of Customer Ids for Customers that were changed within a given date range. The date range cannot exceed 90 days.
Customer Comprehensive Lookup By Customer Id — This API provides capabilities to retrieve the comprehensive information about a single customer using the Customer Id.
Customer Lookup By Customer Id — This API provides the ability look up a Customer by the Customer id. The response will include basic Customer information and various links to look up additional Customer information such as Demographics, Addresses, etc for a single Customer record.
Customer Lookup By Email Address — This API provides the ability look up customers using Email Address and an optional Product Id. The response will include a list of customer records including the Customer Id(s) and the Customer Lookup URL(s).
Customer Lookup By EncryptedCustomerId — This API provides the ability look up a Customer by the Encrypted Customer id. The response will include basic Customer information and various links to look up additional Customer information such as Demographics, Addresses, etc for a single Customer record.
Customer Lookup By External ID — 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.
Customer Lookup by Hashed Email Address — This API provides the ability look up customers using their Hashed Email Address. The response will include a list of customer records including the Customer Id(s) and the Customer Lookup URL(s).
Customer Lookup By Name and Country — This API provides the ability look up customers using First Name (or initial), Last Name, Country and an Optional Postal Code. The response will include a list of customer records including the Customer Id(s) and the Customer Lookup URL(s).
Customer Lookup By PostalAddressId — This API provides the ability look up customers using their Postal Address Id (this is the ID on the magazine mailing labels). 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.
Customer Merge History Lookup — This API provides capabilities to retrieve the merge history for the requested Customer Id.
Demographic Lookup By Customer Id — This service returns all available customer demographics stored for a given customer by using the Customer ID.
Email Address Lookup By Customer Id — This API provides the ability look up a Customer’s Email Addresses by the Customer Id. This service returns all active email address information stored for the given customer.
Email Validity Lookup API — This API provides the ability look up the validity of an email address using Email Address. The response will include the information regarding the email validity provided by the email validity vendor for a given email address.
External ID Lookup By Customer Id — This API provides the ability look up a Customer’s External Ids by the Customer Id.
Gift Lookup by Donor ID — This service returns all available gift information where a given Customer Id is the Donor ID and it can be filtered with optional Product Id.
Order History Lookup by Customer Id — This API provides the ability look up all available Order History information for a customer by the Customer id or for a specific product if the Product Id is included. The response will include the http reference to the owning customer resource and Order History details with all purchase information.
Phone Lookup By Customer Id — This API provides the ability look up a Customer’s Phone Numbers by the Customer id.
Postal Address Lookup By Customer Id — 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.
Subscription Lookup By Customer Id — This service returns all available subscription information stored for a given Customer Id and optional Product Id. Note, this includes both current subscription and deactivated subscriptions (see below to determine the differences).
Subscription Lookup By Email — This service returns all subscription information stored for all customers with the given Email Address and optional Product Id. Note, this includes both current subscription and deactivated subscriptions (see below to determine the differences).
Order Issue History Lookup by Customer Id — This API allows retrieval of Order History information by Customer id or Product Id, providing details like purchase history and issue details.

Store Customer Info

These services allow you to store customer and orders in your database.

Assign Behavior — The Assign Behavior API provides the ability to add or update behavior information for an existing customer.
Assign Behavior Bulk — This API provides capabilities to create many Behaviors defined for a given brand to multiple customers.
Save Customer and Order — This API provides the ability to post a complete set of customer identity, contact, and demographic information along with order information for data processing (insert/update).
Save Customer and Order Paid — This API provides the ability to post a complete set of customer identity, contact, and demographic information along with order (paid or controlled) information for data processing (insert/update).
Transaction Lookup — The Transaction Lookup service is used to check on the submission status of a particular POST submission from DataQueue.
Update Billing Info — This API provides the ability to update the Billing Information for a Single Customer and a Single Paid Product. This service will look up all the active, pending, and graced Paid Subscription records for the given customer and product. For each one, it will update the Billing Info associated.

Brand Lookup

The following APIs allow you to lookup various types of brand level data on your database.

Behavior Actions Lookup — This API provides capabilities to retrieve Behavior “Actions” defined for a given brand.
Behavior Categories Lookup — This API provides capabilities to retrieve the Behavior Categories defined for a given brand.
Behavior Lookup — This API provides capabilities to retrieve the Behaviors defined for a given brand. For example, you might use it to keep your marketing database at Omeda in sync with your content taxonomy category.
Behavior Lookup By Id — This API provides capabilities to retrieve a single Behavior. You would use this service to look up a behavior using the Behavior Id.
Behavior Lookup Grouped By Product — This API provides capabilities to retrieve the Behaviors for the associated Brand grouped by Product. For example, you might use it to keep your marketing database at Omeda in sync with your content taxonomy category.
Brand Comprehensive Lookup Service — This API provides capabilities to retrieve information about a single brand, including its defined products, demographics, deployment types, and other cross referencing information. This service is useful for building your own data mapping service when reading or writing from/to other Omeda services. Results from this API should be cached and then refreshed at an interval by the user. This API is not intended to be hit real time by web traffic or otherwise hit with a great frequency.
Brand Group Lookup — This API provides capabilities to retrieve the Information defined for a given GroupId.
Brand Promotions By Promo Code — This API provides capabilities to retrieve information about a single Brand’s Promotions. Including the Promotion Products, Price Group and Price Code Information.
Brand Promotions Content By Promo Code — This API provides capabilities to retrieve information about a Brands Single Promotion Content by Promo Code .
Brand Promotions Quantity — This API provides capabilities to retrieve information about a specified quantity of Brand’s Promotions. Including the Promotion Products, Price Group and Price Code Information.
Demographic Lookup by Brand API — This API provides capabilities to retrieve the defined demographics of a single brand. This service is useful for building your own data mapping service when reading or writing from/to other Omeda services.
Deployment Type Lookup by Brand API — This API provides capabilities to retrieve the defined deployment types of a single brand. This service is useful for building your own data mapping service when reading or writing from/to other Omeda services.
Product Lookup by Brand API — This API provides capabilities to retrieve the defined products of a single brand. This service is useful for building your own data mapping service when reading or writing from/to other Omeda services.

Store Brand Info

These services allow you to store brand level data in your database.

Assign Behavior To Category — This API provides the ability to assign a Behavior to a Behavior Category.
Store Behavior — This API provides capabilities to add and update Behaviors defined for a given brand.
Store Behavior Action — This API provides capabilities to retrieve and add Behavior “Actions” defined for a given brand.
Store Behavior Attribute — This API provides capabilities to create Behavior Attributes as well as add Defined values for existing Behaviors Attributives.
Store Behavior Category — This API provides capabilities to retrieve and add the Behavior Categories defined for a given brand.

Authentication

Activate Authentication — This API provides the ability to activate a user’s status code for the customer id and namespace.
Add Authentication — This API provides the ability to post a username and password to an existing customer for authentication. This can be used to capture the log in credentials to be used for logging into a gated site.
Reset Authentication — This API provides the ability to reset the password for an existing customer for authentication. This will update the current password for the user and update it to a temporary random password that should be changed upon log in.
Update Authentication — This API provides the ability to post an update to username and/or password for an existing customer for authentication.
Validate Authentication — This API provides the ability to validate a username and password for authentication. This can be used to authenticate a user and get the Omeda Customer Id for the authenticated user. It will only validate usernames of active customers.

Email

If you are using Email Builder, or are using your database to store opt-in and opt-out information by email addresses, these APIs are available for your use.

Email Audience Assignment Status — The List Assignment Status API provides the ability to get the status of a customer list that is currently being assigned from the Omail FTP Site to a deployment.
Email Clicks — This service retrieves Omail data related to clicks on links in emails using various parameters.
Email Deployment — The Deployment Service API provides the ability to post/put deployment information to Omail. This information is used to either create a new Omail deployment, or update an existing Omail deployment. Deployment information is validated for basic information.
Email Deployment Add Audience — The Deployment Add Audience API provides the ability add a previously uploaded list of customers to a deployment.
Email Deployment Approval Lookup — The Deployment Approval Lookup API provides the ability to retrieve the approval queue information such as tests, users and comments.
Email Deployment Audience List FTP — Deployment List FTP is the means by which deployment lists are made available in the Email Builder system.
Email Deployment Cancel — The Deployment Cancel API provides the ability to cancel a deployment.
Email Deployment Clone — The Clone Deployment Service API provides the ability to post deployment information to Omail. This information is used to clone existing Omail deployment. Deployment information is validated for basic information.
Email Deployment Content — The Deployment Content API provides the ability to post information to a deployment. These fields can include the ‘Subject’ line of the email, the ‘From Name’ of the email, the HTML content, the Text content, etc. Since we are passing in html data in this resource, xml is the default format for requests and responses.
Email Deployment Content Lookup — An api available to our Email Builder clients. For a given set of url parameters – the API will return the text or html content for a given Email Builder deployment and specified split.
Email Deployment Lookup — The Deployment Lookup API provides the ability to retrieve deployment information such as link tracking, delivery statistics, deployment status, history, etc. via an HTTP GET request.
Email Deployment Remove Audience — The Deployment Remove Audience API provides the ability to remove a list that is currently assigned to a deployment.
Email Deployment Schedule — The Deployment Schedule API provides the ability to schedule a deployment for sending.
Email Deployment Search — This service retrieves a list of most recent deployments for a given brand based on search parameters.
Email Deployment Test — The Deployment Test API provides the ability to send test copies of your deployment to the test recipients that were specified when the deployment was created.
Email Deployment Unschedule — The Deployment Unschedule API provides the ability to unschedule a deployment, perhaps to allow further editing.
Email Flag Email As Invalid — The Invalid Email API allows our client to mark a customer Email Address as invalid for a brand.
Email On Demand Send — The Deployment API allows our clients to send a single Omail email deployment.
Email Opt In/Out Lookup — This service returns Opt In/Out information stored for a given customer.
Email Optin Queue — The OptIn Queue API allows our client to OptIn their subscribers or customers to their email deployments at the client, brand, and deployment type level. All 3 OptIn levels can be submitted in one OptIn Queue API call.
Email Optout Queue — The OptOut Queue API allows our client to OptOut their subscribers or customers to their email deployments at the client, brand, and deployment type level. All 3 OptOut levels can be submitted in one OptOut Queue API call.
Email – Checklist for Sends Created via API Calls — Checklist for Sends Created via API Calls.

Utility

These “dictionary” APIs provide decode capabilities for your value ids/descriptions used for demographics, products, postal information, etc.

Form Submission API — The Form Submission API returns all transactions from a given form and specified date range. Data including billing info, authentication, and gift recipients will be excluded.
Postal Info Lookup — The Postal Information API returns postal information for a given postal code. The postal data is updated as available from the USPS, and field definitions can be found here:
Run Processor — The Run Processor API runs the Processor for an indivdual TransactionID that is pending processing.
Tax Rate Lookup — The Tax Rate Lookup API returns the tax rate that should be applied to an order based on their location and product id being ordered. The lookup will also take into consideration tax exempt customers if the Customer Id is passed in.
Client Empowerment API Keys

olytics

Customer Olytics Data — For a given omeda customer id and set of olytics/behavioral search parameters, this API will return olytics behavioral data matching those parameters.
Olytics Comprehensive Lookup — For a given global database, this API can be used to return all of the active olytics fields and their valid values on the database. These are the fields / values that the user has been passing to us in their olytics.fire() API calls.
Olytics Customer Search — For a given set of olytics/behavioral search parameters, this API will return a list of Omeda customer ids matching those parameters. This api can be used to help in building an external lead gen tool.
Olytics Customer Top Values — For a given customer, this service returns the top 3 olytics tag values for each field you are using as part of your olytics setup.

Table of Contents

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close