Skip to content

Search the Omeda Knowledge Base

Brand Promotions By Promo Code

Summary

This API provides capabilities to retrieve information about a single Brand’s Promotions. Including the Promotion Products, Price Group and Price Code Information.

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}/promotion/promocode/{promotionCode}/* 

Testing:    https://ows.omedastaging.com/webservices/rest/brand/{brandAbbreviation}/promotion/promocode/{promotionCode}/* 
brandAbbreviation
is the abbreviation for the brand
promocode
is the promotion code

HTTP Headers

The HTTP header must contain the following element:

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

The 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:

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

Lookup All Promotions

Retrieves all defined Promotions for the brand.

Field Definition

The following table describes the 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.

Brand Elements

Element NameAlways Returned…Data TypeDescription
IdYesIntegerThe brand identifier.
DescriptionYesStringThe name of the brand.
BrandAbbrevYesStringThe abbreviation for the brand (used in most web service URLs).
PromotionYesListList of Promotion Elements attached to this Brand.

Promotion Elements

Element NameAlways Returned…Data TypeDescription
PromoCodeYesStringThis is the unique way of identifying a Promotion Code.
AlternateIdNoStringThis is the Alternate Id used to refer to the Promotion.
DescriptionYesStringThis is the descriptive name for the Promotion.
PromoChannelNoInteger
PromoTypeNoInteger
DataSourceIdNoInteger
EffectiveDateNoDateTimeThe date and time the promotion starts to be effective. yyyy-MM-dd HH:mm:ss format. Example: 2010-03-08 21:23:34.
EndDateNoDateTimeThe date and time the promotion is no longer effective. yyyy-MM-dd HH:mm:ss format. Example: 2010-03-08 21:23:34.
QuantitySentNoint
SalesChannelNoString
StatusCodeYesintStatus of the current promotion.
PromotionProductYesListA list of PromotionProduct elements. These define the Products that are attached to the Promotion.

Promotion Product Elements

Element NameAlways Returned…Data TypeDescription
IdYesintThis is the unique Identifier for the Promotion Product.
ProductIdYesintThe Product Id of the product associated with the Promotion.
ParentProductIdNointThis would the the Parent Product associated, if any.
ProductPriceGroupNoListA list of ProductPriceGroup elements. These define any Price Groups that are attached to the Product for a Promotion.
SKUNostringthe id assigned to the single copy sale product used to indicate the individual issue

Promotion Price Group Elements

Element NameAlways Returned…Data TypeDescription
IdYeslongThe product price group identifier.
EndDateNoDatetimeThe date and time the price group is no longer effective. yyyy-MM-dd HH:mm:ss format. Example: 2010-03-08 21:23:34.
StartDateNoDatetimeThe date and time the price group starts to be effective. yyyy-MM-dd HH:mm:ss format. Example: 2010-03-08 21:23:34.
StatusCodeYesintStatus of the current price group.
ProductPriceCodeNoListA list of ProductPriceCode elements. These define any Prices that are attached to the Price Group for a Product.

Promotion Price Code Elements

Element NameAlways Returned…Data TypeDescription
IdYeslongThe product price code identifier.
GeographicLocationYesStringGeographic Location that is valid code for the associated price code.
TermYesintThe term/length for the product associated with the price group.
AmountYesBigDecimalThe price associated with the product for the term.
StatusYesintThe current status of the price for the associated product.
PriceChoiceIdNoint
PriceChoiceDescriptionNoString
CountryCodeNoStringThe Country for which the this price code is valid.
RegionCodeNoStringThe Region for which the this price code is valid.
RequestedVersionTypeNoStringThe Requested Version Type for which the this price code is valid.

Response

HTTP Response Codes

StatusDescription
200 OKThe request has succeeded. See Example Response below.
404 Not FoundIn the event no Promotions are found, an HTTP 404 (not found) response will be returned.

Example Response

{
   "SubmissionId":"C95AE90C-BEC6-41F2-91E2-2BA9168D1D1F",
   "Id":3000,
   "Description":"AppDev Today",
   "BrandAbbrev":"APPDEV",
   "Promotion":[
      {
         "Description":"Second Promotion",
         "EffectiveDate":"2012-10-01 00:00:00.0",
         "PromoCode":"Promo2",
         "QuantitySent":0,
         "PromoType":2,
         "PromoChannel":1,
         "PromotionProduct":[
            {
               "Id":1,
               "ProductId":10
            },
            {
               "Id":2,
               "ProductId":8,
               "ProductPriceGroup":[
                  {
                     "StatusCode":5,
                     "Description":"Price Group",
                     "EndDate":"2013-10-30 07:43:29.853",
                     "StartDate":"2012-10-30 07:43:29.853",
                     "Id":44,
                     "ProductPriceCode":[
                        {
                           "Status":1,
                           "Amount":12.5,
                           "PriceChoiceId":1,
                           "GeographicLocation":3,
                           "ProductPriceCodeId":111,
                           "Term":1
                        },
                        {
                           "Status":1,
                           "Amount":11.5,
                           "PriceChoiceId":2,
                           "GeographicLocation":2,
                           "ProductPriceCodeId":311,
                           "Term":1
                        }
                     ]
                  }
               ]
            }
         ]
      }
   ]
}
Tags:
Table of Contents
Knowledge Base Feedback