Search the Omeda Knowledge Base

< All Topics
Print

API – Order Lookup Service

Summary

The Order Lookup service is used to check on the submission status of a particular POST submission. 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}/order/{orderId}/*

In Testing, use: https://ows.omedastaging.com/webservices/rest/brand/{brandAbbreviation}/order/{orderId}/*

brandAbbreviation is the abbreviation for the brand orderId the order identifier, handed back by the DataQueue POST submission. See Order Queue Service for more details.

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 NameOptional?Description
OrderIdnothe order identifier
StgOrderIdnothe staging order identifier
Statusnothe status of the transaction. See Status Descriptions for more details.
OmedaCustomerIdyesthe internal identifier for a customer
ClientCustomerIdyesthe external identifier for a customer
Errorsyesa list of errors with the transaction

Errors Elements

Element NameOptional?Description
Erroryesa description of the error

Response Examples

JSON Example

{
  "OrderId":5435634,
  "StgOrderId":8722287,
  "Status":2,
  "ClientCustomerId":1293401,
  "Errors":[
    {
      "Error":"Invalid Product ID = 101589"
    }
  ]
}

Additional Information

Status Descriptions

StatusDescription
0Loaded into DataPool
1Customer On Hold
2Customer Has Excessive Errors
8Verification Rules Ready
9Failed Validation Rules
10Passed Validation Rules
19OEC Ready
20OEC On Hold
21OEC Done
28DupeCheck Ready
29DupeCheck Running
30DupeCheck New Customer
31DupeCheck Existing Customer
35DupeCheck Manual Review
36DupeCheck Manual Review New Customer
37DupeCheck Manual Review Existing Customer
49Source Prioritization Ready
50Source Prioritization Passed
51Entire record held in Datapool – Source Prioritization Failed
90Ready to Migrate to ERD – New Customer
91Ready to Migrate to ERD – Existing Customer
98Moved to ERD – Failed Source Prioritization
99Partially moved to ERD – Source Prioritization Failed
100Moved to ERD – Complete – New Customer
101Moved to ERD – Complete – Existing Customer
110Discard Record
Tags:
Table of Contents
Scroll to Top