Summary

The Tax Rate Lookup API returns the tax rate that should be applied to an order based on their location and product id being ordered. The lookup will also take into consideration tax exempt customers if the Customer Id is passed in.

Base Resource URI

For Production, use: https://ows.omeda.com/webservices/rest/brand/{brandAbbreviation}/taxrate/*

For Testing, use: https://ows.omedastaging.com/webservices/rest/brand/{brandAbbreviation}/taxrate/*

brandAbbreviation is the abbreviation for the brand to which the data is being posted.

HTTP Headers

The HTTP header must contain the following elementselement: x-omeda-appid a unique id provided to you by Omeda to access your data. The request will fail without a valid id.

Technical Requirements

The HTTP header must contain the following elements: 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

There are three content types supported. 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

1. GET : For looking up GDPR consent for a customer.

2. POST : For storing GDPR consent data for a customer and url.

Base Resource URI

Note: customer can be found either by customerId or anonymousId depending on which URI is used, and both GET and POST use the same URI pattern:

Production: https://ows.omeda.com/webservices/rest/brand/{brandAbbreviation}/consent/customerid/{customerId}
            https://ows.omeda.com/webservices/rest/brand/{brandAbbreviation}/consent/olyticsanonymousid/{anonymousId}

Testing:    https://ows.omedastaging.com/webservices/rest/brand/{brandAbbreviation}/consent/customerid/{customerId}
            https://ows.omedastaging.com/webservices/rest/brand/{brandAbbreviation}/consent/olyticsanonymousid/{anonymousId}

brandAbbreviation is the abbreviation for the brand customerId the encrypted or non-encrypted Omeda customer ID for the customer anonymousId the Olytics anonymous id for the customer

There is one HTTP method supported: POST See W3C’s POST specs for details.

Field Definition

The following tables describe the data elements that can be sent to this 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.

GET Response Elements

Consent Elements

included in the POST method to lookup data in the database.

Tax Rate Lookup Element

Request Examples

JSON Example

{  
   "ConsentsPostalCode":[  
      {  
         "ConsentDate":"2018-05-17",
   "60062",
     "OmedaCustomerIdOmedaProductId":454824,
  "19",
      "AlternateIdCountryCode":"05baf4ed-c969-4416-8d98-a35434180854USA",
 
       "StatusCodeRegionCode":0,
         "ConsentDomain":"olytics.omedastaging.com"IL",
         "ConsentTypeCode":1
      },
      {  
         "ConsentDate":"2018-12-04",
    "Term": 12,
    "OmedaCustomerId":454824,12345
         "AlternateId":"05baf4ed-c969-4416-8d98-a35434180854",
         "StatusCode":1,
         "ConsentDomain":"google.com",}

Response – Success

Upon successful update of a behavior, an HTTP 200 will be issued.

HTTP Response Codes

Example Responses

{  
       "ConsentTypeCodeResponseInfo":1
 [  
  },       {  
         "ConsentDateTaxRate":"2018-03-14",
 .1025
      }
 "OmedaCustomerId":454824,
         "StatusCode":1,
     ],
     "ConsentDomainSubmissionId":"yahoo.com",
         "ConsentTypeCode":1
      }
   ]
}

POST Request Elements

Example POST request

{
   "Consent":"Yes",
   "Url":"https://www.google.com",
   "ConsentDate":"2018-03-14 15:22:11"
}

11111111-22bf-3f33-4444-55ef55d55555"
}

If no tax should be charged based on supplied info then the following will be returned with a “TaxRate” of 0.

{  
   "ResponseInfo":[  
      {  
         "MessageTaxRate":"Consent0
was updated successfully",          "OmedaCustomerId":454824
      }
   ],
    "SubmissionId":"cd9ec7ab11111111-46f822bf-49303f33-8cee4444-3cd6d839f7d655ef55d55555"
}

Response – Failure

If an error occurs repeatedly, please contact your Omeda representative.

HTTP Response Codes

Example Response

{  
   "Errors":[  
      {  
         "Error":"OmedaProductId 3 is not a valid."
      }
   ],
   "SubmissionId":"11111111-22bf-3f33-4444-55ef55d55555"
}

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.

OmedaProductId {OmedaProductId} is not a valid.
OmedaCustomerId not found