Summary

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.

Note:

• This service does not return Products that create a Subscription. Use the Subscription Lookup API for Magazine (productType=1) and Newsletter (productType=2) type products.
• Use the OptLookup API for opt in/out status for Email Deployment type products (productType=5)

General Technical Requirements

The following technical requirements apply to all requests for this API.

Base Resource URI

Production: https://ows.omeda.com/webservices/rest/brand/{brandAbbreviation}/customer/{customerId}/orderhistory/*

Production: https://ows.omeda.com/webservices/rest/brand/{brandAbbreviation}/customer/{customerId}/orderhistory/product/{productId}/*

Testing: https://ows.omedastaging.com/webservices/rest/brand/{brandAbbreviation}/customer/{customerId}/orderhistory/*

Testing: https://ows.omedastaging.com/webservices/rest/brand/{brandAbbreviation}/customer/{customerId}/orderhistory/product/{productId}/*

brandAbbreviation

is the abbreviation for the brand

customerId

is the internal customer id (encrypted customer id may also be used.)

productId (optional)

is the product id

HTTP Headers

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.

Content Type

The content type is always application/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:

1. GET : See W3C’s GET specs for details.

Lookup Order History By Customer Id

Retrieves all Order History information about the customer or for a specific Product if one is included.

Field Definition

The following table describes the hierarchical data elements present on the response from the API.

In addition to the below elements, a SubmissionId element will also be returned with all responses. This is a unique identifier for the web services response. It can be used to cross-reference the response in Omeda’s database.

Purchase History Elements

Order History Elements

Orders Elements

Response

HTTP Response Codes

Success

{
   "Customer":"https://ows.omedastaging.com/webservices/rest/brand/FOO/customer/12345/*",
   "OrderHistory":[
      {
         "ProductId":7,
         "Orders":[
            {
               "Id":111111,
               "ShippingAddressId":123673467,
               "EmailAddressId":22176763,
               "RequestedVersion":"P",
               "Quantity":1,
               "Receive":1,
               "MarketingClassId":28114,
               "MarketingClassDescription":"Active Non-Qualified",
               "ChangedDate":"2012-09-28 21:23:34",
               "PaymentStatus":2,
               "VerificationDate":"2012-03-07"
            },
            {
               "Id":111222,
               "ShippingAddressId":123673467,
               "EmailAddressId":22176763,
               "RequestedVersion":"P",
               "Quantity":1,
               "Receive":1,
               "MarketingClassId":28114,
               "MarketingClassDescription":"Active Non-Qualified",
               "ChangedDate":"2012-09-28 21:23:34",
               "PaymentStatus":2,
               "VerificationDate":"2012-03-07"
            }
         ]
      },
      {
         "ProductId":22,
         "Orders":[
            {
               "Id":999999,
               "ShippingAddressId":123673467,
               "EmailAddressId":22176763,
               "RequestedVersion":"P",
               "Quantity":1,
               "Receive":1,
               "MarketingClassId":28114,
               "MarketingClassDescription":"Active Non-Qualified",
               "ChangedDate":"2012-09-28 21:23:34",
               "PaymentStatus":2,
               "VerificationDate":"2012-03-07"
            },
            {
               "Id":999888,
               "ShippingAddressId":123673467,
               "EmailAddressId":22176763,
               "RequestedVersion":"P",
               "Quantity":1,
               "Receive":1,
               "MarketingClassId":28114,
               "MarketingClassDescription":"Active",
               "ChangedDate":"2012-09-28 21:23:34",
               "PaymentStatus":2,
               "VerificationDate":"2012-03-07"
            }
         ]
      }
   ],
   "SubmissionId":"24B9BF6F-0677-462B-942A-D87EEBD10F77"
}

Failure

{
   "SubmissionId":"ec0c2ba6-13f4-4934-8efa-74c2ccb33f1d",
   "Errors":[
      {
         "Error":"No purchases found for customer 12345."
      }
   ]
}

Possible Error Messages

In the event of an error, an error response will be returned. Here are some of the possible responses you might receive.

No Purchases found for customer {customerId}.

Additional Information

Payment Status Codes

Marketing Class Codes