Search the Omeda Knowledge Base
API – Overview
Customer Lookup
The following APIs allow you to lookup various types of customer data on your database.
- Customer Lookup By Id : Lookup customer identity information with an id.
- Customer Lookup By PostalAddressId : Lookup customer identity information with a PostalAddressId.
- Customer Lookup Service By External ID : Lookup customer identity information with an External ID used by client or an Omeda legacy ID.
- Customer Lookup By Encrypted Id : Allows various approaches for querying the database and returning customer info that match particular values.
- Customer Lookup By Email : Allows various approaches for querying the database and returning customer info that match particular values.
- Comprehensive Customer Lookup: Provides complete identity, contact, and demographic information about a customer in one call.
- Customer Change Lookup : Find all customers changed within a specified date range.
- Postal Address Lookup : Find address information for a specified customer.
- Phone Number Lookup : Find phone information for a customer.
- Email Address Lookup : Finds email address information for a customer.
- Demographic Lookup : Finds customer demographic information for a customer.
- Subscription Lookup: Finds customer subscription information for a customer.
- Subscription Lookup By Product: Finds customer subscription information for a customer AND specific product.
- Subscription Lookup by Email: Finds subscription information for all customers with the given email address and product (if requested).
- Behavior Lookup : Finds behavior information for a customer.
- External ID Lookup : Finds External ID and Namespace for a customer.
- Customer Lookup By Name and Country : Allows various approaches for querying the database and returning customer info that match particular name and Country.
- Customer Merge History Service : Finds all “loser” customers associated with the requested Customer Id.
Store Customer Info
These services allow you to store customer and orders in your database.
- Save Customer and Order API : Save customer and product information in one transaction.
- Save Customer and Order API with PAID fields : Save customer and product information where there is a paid aspect to the order.
- Check Customer Processing Status : Check the status of a customer add or update.
- Check Order Processing Status : Check the status of a new order.
- Assign Behavior : Add customer behavior data.
- Assign Behavior Bulk : Assign an existing behavior to a customer.
Brand Lookup
The following APIs allow you to lookup various types of brand level data on your database.
- Brand Comprehensive Lookup (Cross Reference) : Retrieves information about a brand, including all its demographics, valid values, contact types, and other information useful for cross referencing data.
- Behavior Lookup : Retrieves information about brand Behaviors.
- Behavior Lookup By Id : Retrieves information about brand Behaviors by the Behavior ID.
- Behavior Lookup By Product : Retrieves information about brand Behaviors, grouped by Product.
- Behavior Actions Lookup : Retrieves information about brand Behavior Action.
- Behavior Categories Lookup : Retrieves information about brand Behavior Categories.
- Brand Promotions By Promo Code Lookup : Retrieves information about a specific brand Promotion.
- Brand Promotions Specified Quantity Lookup : Retrieves the most recent Brand Promotion information and returns the specified quantity.
- Brand Promotion Content By Promo Code Lookup : Retrieves the Brand Promotion Content for the specified Promo Code.
- Brand Group Lookup : Retrieves all information for the specified groupId.
Store Brand Info
These services allow you to store brand level data in your database.
- Store Behavior : Creates Behaviors.
- Store Behavior Action : Creates Behavior Actions.
- Store Behavior Category : Creates Behavior Category.
- Assign Behavior Category : Assign a Behavior to a Category.
- Store Behavior Attribute : Creates/update Behavior Attribute.
Authentication
- Add Authentication : Adds a username and password to an existing customer.
- Validate Authentication : Validates a username and password.
- Update Authentication : Update a customers existing username and/or password.
- Reset Password Authentication : Resets an existing username’s associated password.
- Activate Authentication : Activate a customer’s existing record (status code = 2).
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.
- Optin API : This service allows submission of optin data.
- Optout API : This service allows submission of optout data.
- Opt Lookup API : Finds Opt In/Out information for a given email address.
- On Demand Send API: This service will send a single email via a special Omail deployment.
- Deployment Audience List FTP : Upload a list of customer information to the Omail system via FTP.
- Deployment : Create/Update an Omail deployment.
- Deployment Clone : Clone an Omail deployment.
- Deployment Add Audience : Add an OnQ Query or Recipient List to a deployment.
- Deployment Remove Audience : Remove a list or query assigned to a deployment.
- Audience Assignment Status : The List Assignment Status API checks completion status of the list as it is processed and assigned to the deployment.
- Deployment Content : Manage the HTML/Text content for a deployment.
- Deployment Test : Send a test deployment.
- Deployment Test Approval Lookup : Lookup information for a deployment’s tests.
- Deployment Schedule : Schedule a deployment to be sent.
- Deployment Unschedule : Unschedule a deployment.
- Deployment Cancel : Cancel a deployment.
- Deployment Search : Search the system for deployments matching search parameters.
- Deployment Lookup : Retrieve deployment information for a given deployment. Information includes but is not limited to link tracking, delivery statistics, content, history, etc.
- Invalid Email API : Flag an email address as invalid.
- Click Lookup API : Retrieve Customer Click information for a given deployment.
Utility
These “dictionary” APIs provide decode capabilities for your value ids/descriptions used for demographics, products, postal information, etc.
- Postal Information : This service allows to receive postal information for a given postal code.
- Run Processor API : This service allows you to run the processor for one or many pending transactions.
- Tax Rate Lookup API : This service allows you to lookup the tax rate for a customer based on the product id and the location.
olytics
- Customer Top olytics Values : This service returns the most frequent olytics traffic values for a given customer. This can be useful in targeted content or advertisements.