Search the Omeda Knowledge Base
-
The Omeda Experience
-
Documentation
-
-
- Brand Comprehensive Lookup Service
- Brand Promotions Quantity
- Brand Group Lookup
- Brand Promotions Content By Promo Code
- Brand Promotions By Promo Code
- Behavior Categories Lookup
- Behavior Actions Lookup
- Behavior Lookup Grouped By Product
- Behavior Lookup By Id
- Behavior Lookup
- Demographic Lookup by Brand API
- Deployment Type Lookup by Brand API
- Product Lookup by Brand API
-
- Customer Lookup By Email Address
- Subscription Lookup By Customer Id
- Order History Lookup by Customer Id
- Customer Lookup by Hashed Email Address
- Email Address Lookup By Customer Id
- Gift Lookup by Donor ID
- Behavior Lookup By Customer Id
- Subscription Lookup By Email
- Customer Merge History Lookup
- Customer Lookup By Name and Country
- External ID Lookup By Customer Id
- Demographic Lookup By Customer Id
- Phone Lookup By Customer Id
- Postal Address Lookup By Customer Id
- Customer Change Lookup
- Customer Comprehensive Lookup By Customer Id
- Customer Lookup By EncryptedCustomerId
- Customer Lookup By External ID
- Customer Lookup By PostalAddressId
- Customer Lookup By Customer Id
- Email Validity Lookup API
- Show all articles ( 6 ) Collapse Articles
-
- Email On Demand Send
- Email Deployment
- Email Deployment Clone
- Email Deployment Remove Audience
- Email Audience Assignment Status
- Email Deployment Content
- Email Deployment Approval Lookup
- Email Deployment Schedule
- Email Deployment Cancel
- Email Deployment Search
- Email Flag Email As Invalid
- Email Clicks
- Email - Checklist for Sends Created via API Calls
- Email Deployment Content Lookup
- Email Deployment Unschedule
- Email Deployment Lookup
- Email Deployment Test
- Email Deployment Add Audience
- Email Opt In/Out Lookup
- Email Optout Queue
- Email Optin Queue
- Email Deployment Audience List FTP
- Show all articles ( 7 ) Collapse Articles
-
-
- Release Notes for Jan 14 | V22.1
- Release Notes for Feb 4 | V22.2
- Release Notes for Feb 25 | V22.3
- Release Notes for Mar 18 | V22.4
- Release Notes for Apr 8 | V22.5
- Release Notes for Apr 29 | V22.6
- Release Notes for May 20 | V22.7
- Release Notes for June 10 | V22.8
- Release Notes for July 1 | V22.9
- Release Notes for July 22 | V22.10
- Release notes for Aug 12 | V22.11
- Release Notes for Sep 2 | V22.12
- Release Notes for Sep 23 | V22.13
- Release Notes for Oct 14 | V22.14
- Release Notes for Nov 4 | V22.15
- Release Notes for Dec 2 | V22.16
- Show all articles ( 1 ) Collapse Articles
-
- Release Notes for V21.1
- Release Notes for V21.2
- Release Notes for V21.3
- Release Notes for V21.4
- Release Notes for V21.5
- Release Notes for V21.6
- Release Notes for V21.7
- Release Notes for V21.8
- Release Notes for V21.9
- Release Notes for V21.10
- Release Notes for V21.11
- Release Notes for V21.12
- Release Notes for V21.13
- Release Notes for V21.14
- Release Notes for V21.15
- Release Notes for V21.16
- Release Notes for V21.17
- Show all articles ( 2 ) Collapse Articles
-
- Release Notes for V20.1
- Release Notes for V20.2
- Release Notes for V20.3
- Release Notes for V20.4
- Release Notes for V20.5
- Release Notes for V20.6
- Release Notes for V20.7
- Release Notes for V20.8
- Release Notes for V20.9
- Release Notes for V20.10
- Release Notes for V20.11
- Release Notes for V20.12
- Release Notes for V20.13
- Release Notes for V20.14
- Release Notes for V20.15
- Release Notes for V20.16
- Release Notes for V20.17
- Show all articles ( 2 ) Collapse Articles
-
- Release Notes for V19.1
- Release Notes for V19.2
- Release Notes for V19.3
- Release Notes for V19.4
- Release Notes for V19.5
- Release Notes for V19.6
- Release Notes for V19.7
- Release Notes for V19.8
- Release Notes for V19.9
- Release Notes for V19.10
- Release Notes for V19.11
- Release Notes for V19.12
- Release Notes for V19.13
- Release Notes for V19.14
- Release Notes for V19.15
- Release Notes for V19.16
- Release Notes for V19.17
- Show all articles ( 2 ) Collapse Articles
-
-
CDP – Customer Data Platform
-
-
- Personalization Overview
- Personalization - FAQs
- Personalization - Reporting
- Personalization - Archiving & Restoring
- Personalization - HTML Templates
- Personalization - Scroll Trigger and Infinite Scroll Pages
- Personalization - Merge Variables
- Personalization - 'Generate Personalization' Option
- Personalization & Metering - Click Tracking
- GDPR Consent Management
- Form Builder - Embedding Webforms via iFrame or Javascript
-
-
Integrations
-
-
- Integration with Zapier
- Bring Customer Data in via Webhooks by Zapier Action - POST Event
- Bring Customer Data in using Zapier
- Omeda's Add Customer Action in Zapier
- Send Form Submission Data via Zapier
- Bring Customer Data in via Webhooks by Zapier Action – Custom Request Event
- Formatter by Zapier Action
-
-
-
Analytics & Reporting
-
- Odyssey - Reporting
- Personalization - Reporting
- Reports - Email Device and Client Type Reporting
- Email - Clickbot Reporting
- Reports - Email Reporting
- Metering - Reporting
- Reports - Audience Overlap Report
- Reports - Engaged Companies Report
- Reports-AutoRenewals Analysis Report
- Reports - Audience Report
- Reports - Issue Activity Reporting
- Reports - Overview
- Reports - Web Behavior Reporting
- Reports- FAQs
- Reports - Data Tracker Reporting
- Reports - Audience Builder (OnQ) Reporting
- Form Submit Report
- Behavior Promo Code Report
- Reporting Library
- Show all articles ( 4 ) Collapse Articles
-
Marketing Automation & Email Builder
-
-
- Email On Demand Send
- Email Deployment
- Email Deployment Clone
- Email Deployment Remove Audience
- Email Audience Assignment Status
- Email Deployment Content
- Email Deployment Approval Lookup
- Email Deployment Schedule
- Email Deployment Cancel
- Email Deployment Search
- Email Flag Email As Invalid
- Email Clicks
- Email - Checklist for Sends Created via API Calls
- Email Deployment Lookup
- Email Deployment Test
- Email Deployment Add Audience
- Email Opt In/Out Lookup
- Email Optout Queue
- Email Optin Queue
- Email Deployment Audience List FTP
- Show all articles ( 5 ) Collapse Articles
- Email Builder - User Guide
- Email - Clickbot Reporting
- Reports - Email Reporting
- Email - Link Tracking Errors
- Email - Deployment Defaults
- Omeda - Getting Support
- Email - Checklist for Sends Created via API Calls
- Email - Assigning Link Tracking Categories
- Email - Deliverability
- Email - Opt-Out Footer Merge Variable
- Email - Stealth Link
- Email - Behavioral Data
- Email - Automation for Email Sending
- Email - Checklist for New Clients
- Email - Deployment Type Creation
- Email – Training Schedules for New Clients
- Email - Request a New Deployment Type
- Email - Adding Domains to Safe Sender List
- Email - Deployment Checklist & Best Practices
- Email Deployment Unschedule
- Email Builder - Getting Started
- Campaign App - Overview
- Email - Automated ACS Notifications
- Email - Dynamic Content
- Email - Recurring Deployments
- Email - FAQs
- Email - Web Tracking
- Email - Validation Services
- Email Services - Overview & Capabilities
- Email - Web Tracking String Parameter Definitions
- Email - Appending Lists On Triggered Deployments
- Email - Preference Page
- Email - A/B Testing
- Email - Triggered Deployments
- Email - Merge Variables
- Email - User Set-up
- Email - Advanced Features
- Email - Glossary
- Show all articles ( 23 ) Collapse Articles
-
-
-
- Odyssey - Audience Element
- Odyssey - Timing Elements
- Odyssey - Adroll Elements
- Odyssey - Facebook Elements
- Odyssey - Filter Element
- Odyssey - Form Submit Element
- Odyssey - Pathfinder Element
- Odyssey - Export Element
- Odyssey - Split Element
- Odyssey - Personalization Element
- Odyssey - Metering Element
- Odyssey - Email Element
- Odyssey - Goal Element
- Odyssey - A/B Test Element
- Odyssey - Google Ad Manager Element
- Odyssey Fatigue Filter Element
- Show all articles ( 1 ) Collapse Articles
- Odyssey Overview
- Odyssey - FAQs
- Odyssey - Editing an In Progress Voyage
- Odyssey - Reporting
- Odyssey - Querying Element Visitors in Audience Builder
- Odyssey - Using Profiles
- Odyssey - Creating Custom Templates
- Odyssey - Global Settings
- Odyssey - Email Conditions
- Odyssey - Omeda's Email Designer
- Odyssey - Email Designer Templates
- Odyssey - Voyage Templates
- Odyssey - Merging Paths
- Odyssey - Email Merge Variables
- Odyssey - Error Troubleshooting
- Odyssey - Dynamic Content
- Show all articles ( 1 ) Collapse Articles
-
-
-
Data Management & Governance
-
- Odyssey - Querying Element Visitors in Audience Builder
- Audience Builder - Product Field Library
- Examples of Audience Builder Queries Using Paid Fields
- Querying Olytics Your Olytics Data
- Data Loader - Querying in Audience Builder
- Email - Behavioral Data
- Audience Builder (OnQ) - Date Field Definitions
- Audience Builder (OnQ) - How To Query Customers
- Audience Builder (OnQ) - Query Result Outputs
- Audience Builder (OnQ) - Overview
- Reports - Audience Builder (OnQ) Reporting
- Audience Builder (OnQ) - Admin User Guide
- Audience Builder (OnQ) - Advanced Features
- Audience Builder (OnQ) - Match Evaluation
-
-
Subscription & Fulfillment Management
-
Forms & Landing Pages
-
- Form Builder (Dragon) - Overview
- How To Use Progressive Profiling
- Using a Custom Domain for your Dragon Webform
- Dragon Forms URL Structure and Appending Parameters
- Best Practices for Testing Forms
- Test Links v. Live Links
- Styling Your Dragon Webforms
- CredSpark - Omeda Form Listener Integration
- Using Dragon Form Builder to capture a Behavior Subscription Attribute
- Form Builder ADA Compliance
- Form Builder (Dragon) Themes
- 2020 Form Builder Updates
- Form Builder - Using Campaign Promo Codes
- Form Builder - Using the PayPal Payment Method
- Form Builder - Embedding Webforms via iFrame or Javascript
-
- How To Use A/B Testing on your Dragon Webform (video)
- How to conditionally display a question on your form (video)
- How to create and add an email confirmation to your form (video)
- How to update a demographic (video)
- How to send a user back to your website after form submission (redirect to a return URL)
- Form Builder - Export URL
- Form Builder - Adding a This Is Not Me Widget
- Form Builder - Embedding Webforms via iFrame or Javascript
-
-
Success Use Cases
-
Professional Services
-
Video Library
-
FAQs
Transaction Lookup
Summary
The Transaction Lookup service is used to check on the submission status of a particular POST submission from DataQueue. Please note that the data submitted to the queue will not necessarily be kept available indefinitely.
Base Resource URI
In Production, use: https://ows.omeda.com/webservices/rest/brand/{brandAbbreviation}/transaction/{transactionId}/* In Testing, use: https://ows.omedastaging.com/webservices/rest/brand/{brandAbbreviation}/transaction/{transactionId}/*
brandAbbreviationidentifies the brand, typically a short alphanumeric codetransactionIdthe transaction identifier, handed back by the Save Customer And Order POST submission.
Technical Requirements
The HTTP header must contain the following elements: x-omeda-appid a unique id provided to you by Omeda to access your data. The request will fail without a valid id.content-typea content type supported by this resource. See Supported Content Types for more details. If omitted, the default content type is application/json.
Supported Content Types
If omitted, the default content type is application/json.JSONapplication/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:GETSee W3C’s GET specs for details.
Field Definition
The following table describes the hierarchical data elements.
ResponseInfo Elements
Element Name | Optional? | Description |
---|---|---|
TransactionId | no | the identifier for a transaction |
Status | no | the status of the transaction. See Status Descriptions for more details. |
OmedaCustomerId | yes | the internal identifier for a customer |
ClientCustomerId | yes | the external identifier for a customer |
Errors | yes | a list of errors with the transaction |
Errors Elements
Element Name | Optional? | Description |
---|---|---|
Error | yes | a description of the error |
Response Examples
JSON Example
Successful Return:
Note – the Error in this return is not an Error for the API call, but an error found in the transaction. If there is no error in the transaction, this error block will not be returned in the API call.
{ "TransactionId":42355632, "Status":2, "ClientCustomerId":1293401, "Errors":[ { "Error":"invalid email", "Error":"vulgarity" } ] }
Unsuccessful Return:
Note – the Error for the API would return a 404 if a bad transactionid exists in the API call. See unsuccessful example below.
{ "Errors":[ { "Error": "No status found for transaction 55973543453." } ],"SubmissionId":"40078f34-7f99-416b-9635-1d63242ef3fd" }
Additional Information
Status Descriptions
Status | Description |
---|---|
0 | Loaded into Staging |
1 | Customer On Hold |
2 | Customer Has Excessive Errors |
3 | Paid Customer On Hold |
4 | Payment Pending |
5 | Payment Succeeded |
6 | Payment Failed |
7 | API Transaction Loaded into Staging |
8 | Verification Rules Ready |
9 | Failed Validation Rules |
10 | Passed Validation Rules |
19 | OEC Ready |
20 | OEC On Hold |
21 | OEC Done |
28 | DupeCheck Ready |
29 | DupeCheck Running |
30 | DupeCheck New Customer |
31 | DupeCheck Existing Customer |
35 | DupeCheck Manual Review |
36 | DupeCheck Manual Review New Customer |
37 | DupeCheck Manual Review Existing Customer |
49 | Source Prioritization Ready |
50 | Source Prioritization Passed |
51 | Source Prioritization Failed |
52 | Source Prioritization Partial Failure |
90 | Ready to Migrate to ERD New Customer |
91 | Ready to Migrate to ERD Existing Customer |
98 | Moved to ERD – Failed Source Prioritization |
99 | Moved to ERD – Partial |
100 | Moved to ERD – Complete New Customer |
101 | Moved to ERD – Complete Existing Customer |
110 | Discard Record |