Search the Omeda Knowledge Base
-
-
-
-
- Behavior Lookup By Customer Id
- Customer Change Lookup
- Customer Comprehensive Lookup By Customer Id
- Customer Lookup By Customer Id
- Customer Lookup By Email Address
- Customer Lookup By EncryptedCustomerId
- Customer Lookup By External ID
- Customer Lookup By Name and Country
- Customer Lookup By PostalAddressId
- Customer Merge History Lookup
- Demographic Lookup By Customer Id
- Email Address Lookup By Customer Id
- External ID Lookup By Customer Id
- Phone Lookup By Customer Id
- Postal Address Lookup By Customer Id
- Subscription Lookup By Customer Id
- Subscription Lookup By Email
- Customer Lookup by Hashed Email Address
- Order History Lookup by Customer Id
- Show all articles ( 4 ) Collapse Articles
-
- Email Deployment
- Email Audience Assignment Status
- Email Clicks
- Email Deployment Add Audience
- Email Deployment Approval Lookup
- Email Deployment Audience List FTP
- Email Deployment Cancel
- Email Deployment Clone
- Email Deployment Content
- Email Deployment Content Lookup
- Email Deployment Lookup
- Email Deployment Remove Audience
- Email Deployment Schedule
- Email Deployment Search
- Email Deployment Test
- Email Deployment Unschedule
- Email On Demand Send
- Email Opt In/Out Lookup
- Email Optin Queue
- Email Optout Queue
- Email Flag Email As Invalid
- Show all articles ( 6 ) Collapse Articles
-
-
-
- Release Notes for V20.17
- Release Notes for V20.16
- Release Notes for V20.15
- Release Notes for V20.14
- Release Notes for V20.13
- Release Notes for V20.12
- Release Notes for V20.11
- Release Notes for V20.10
- Release Notes for V20.9
- Release Notes for V20.8
- Release Notes for V20.7
- Release Notes for V20.6
- Release Notes for V20.5
- Release Notes for V20.4
- Release Notes for V20.3
- Release Notes for V20.2
- Release Notes for V20.1
- Show all articles ( 2 ) Collapse Articles
-
- Release Notes for V19.17
- Release Notes for V19.16
- Release Notes for V19.15
- Release Notes for V19.14
- Release Notes for V19.13
- Release Notes for V19.12
- Release Notes for V19.11
- Release Notes for V19.10
- Release Notes for V19.9
- Release Notes for V19.8
- Release Notes for V19.7
- Release Notes for V19.6
- Release Notes for V19.5
- Release Notes for V19.4
- Release Notes for V19.3
- Release Notes for V19.2
- Release Notes for V19.1
- Show all articles ( 2 ) Collapse Articles
-
-
-
-
- Customer Olytics Data
- Form Listener
- Olytics - Integration Description
- Olytics - Product Outline
- Olytics Comprehensive Lookup
- Olytics Customer Search
- Olytics Customer Top Values
- Reports - Web Behavior Reporting
- Web Behavioral Tracking (Olytics) - Overview & Capabilities
- Audience Builder (OnQ) - Querying Olytics Fields
-
-
-
-
-
- Email - Clickbot Reporting
- Reports - Audience Builder (OnQ) Reporting
- Reports - Audience Overlap Report
- Reports - Audience Report
- Reports - Data Tracker Reporting
- Reports - Email Reporting
- Reports - Issue Activity Reporting
- Reports - Web Behavior Reporting
- Reports - Overview
- Reports- FAQs
- Reports - Email Device and Client Type Reporting
-
-
-
- Email Deployment
- Email Audience Assignment Status
- Email Clicks
- Email Deployment Add Audience
- Email Deployment Approval Lookup
- Email Deployment Audience List FTP
- Email Deployment Cancel
- Email Deployment Clone
- Email Deployment Content
- Email Deployment Lookup
- Email Deployment Remove Audience
- Email Deployment Schedule
- Email Deployment Search
- Email Deployment Test
- Email Deployment Unschedule
- Email On Demand Send
- Email Opt In/Out Lookup
- Email Optin Queue
- Email Optout Queue
- Email Flag Email As Invalid
- Email - Checklist for Sends Created via API Calls
- Show all articles ( 6 ) Collapse Articles
- Email Services - Overview & Capabilities
- Email Builder - User Guide
- Email - Deployment Checklist & Best Practices
- Omeda - Getting Support
- Email - Advanced Features
- Email - A/B Testing
- Email - Appending Lists On Triggered Deployments
- Email - Assigning Link Tracking Categories
- Email - Automated ACS Notifications
- Email - Deliverability
- Email - Dynamic Content
- Email - FAQs
- Email - Glossary
- Email - Link Tracking Errors
- Email - Merge Variables
- Email - Preference Page
- Email - Recurring Deployments
- Email - Triggered Deployments
- Email - User Set-up
- Email - Web Tracking
- Email - Web Tracking String Parameter Definitions
- Email Builder - Getting Started
- Email - Stealth Link
- Email - Clickbot Reporting
- Email - Validation Services
- Email - Opt-Out Footer Merge Variable
- Reports - Email Reporting
- Email - Whitelisting Email Newsletters
- Email - Request a New Deployment Type
- Email - Behavioral Data
- Email - Deployment Defaults
- Email - Deployment Type Creation
- Email - Automation for Email Sending
- Show all articles ( 18 ) Collapse Articles
-
-
-
- Odyssey - Audience Element
- Odyssey - Timing Elements
- Odyssey - Email Element
- Odyssey - Filter Element
- Odyssey - Form Submit Element
- Odyssey - Export Element
- Odyssey - Split Element
- Odyssey - Personalization Element
- Odyssey - Metering Element
- Odyssey - Pathfinder Element
- Odyssey - Google Ad Manager Element
- Odyssey - Adroll Elements
- Odyssey - Facebook Elements
- Odyssey - Goal Element
- Odyssey Overview
- Odyssey - FAQs
- Odyssey - Reporting
- Odyssey - Querying Element Visitors in Audience Builder
- Odyssey - Using Profiles
- Odyssey - Email Merge Variables
- Odyssey - Omeda's Email Designer
- Odyssey - Email Designer Templates
- Odyssey - Merging Paths
- Odyssey - Creating Custom Templates
- Odyssey - Voyage Templates
- Odyssey - Editing an In Progress Voyage
- Odyssey - Error Troubleshooting
- Odyssey - Dynamic Content
-
-
-
-
- Audience Builder (OnQ) - Admin User Guide
- Audience Builder (OnQ) - How To Query Customers
- Audience Builder (OnQ) - Match Evaluation
- Audience Builder (OnQ) - Overview
- Audience Builder (OnQ) - Query Result Outputs
- Reports - Audience Builder (OnQ) Reporting
- Email - Behavioral Data
- Audience Builder (OnQ) - Advanced Features
- Audience Builder (OnQ) - Querying Olytics Fields
-
-
-
-
-
- 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 Use A/B Testing on your Dragon Webform (video)
- How To Use Progressive Profiling
- How to send a user back to your website after form submission (redirect to a return URL)
- Best practices for testing forms
- Dragon Forms URL Structure and Appending Parameters
- Form Builder (Dragon) - Overview
- Form Builder (Dragon) Themes
- Form Builder ADA Compliance
- Styling Your Dragon Webforms
- Test links v. live links
- Using a Custom Domain for your Dragon Webform
- Using Dragon Form Builder to capture a Behavior Subscription Attribute
- 2020 Form Builder Updates
- Form Builder - Using Campaign Promo Codes
-
-
-
- Knowledge Base Home
- Documentation
- API & Webservices
- Store Customer Info APIs
- Transaction Lookup
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}/*
- brandAbbreviation
- identifies the brand, typically a short alphanumeric code
- transactionId
- the 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-type
- a 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.
- 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:
- GET
- See 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 |