Welcome‎ > ‎Version 3‎ > ‎Publisher Api‎ > ‎Data Structures‎ > ‎

Promo Code Information

Data Structure holding information about a promo code as it applies to a specific order.

Fields:
Field Data Type Nulls Description
applicableOfferOptionIds
List of int32
Y
A list of all offer option ids in an order that the promo code applies to.  If the promo code is valid and this list is null, the promo code applies to all offer option ids in the order.
description
string
Y
A description of the promo code (e.g. "$20 off for first time buyers this summer")
discountAmount
decimal
Y
The amount subtracted from the order's total if the promo code is valid.  Null if the promo code is invalid for the order.
errorMessage
string
Y
The error message associated with this promo code.  Null if the promo code is valid.
promoCode
string

The promo code
 

Sample JSON Response:
{
       "applicableOfferOptionIds": [
           27564
       ],
       "description": "12.00% Discount",
       "discountAmount": 14.4,
       "errorMessage": null,
       "promoCode": "lol"
}


Sample XML Response:
<promoCodeInformation>
      <applicableOfferOptionIds>
        <id>27564</id>
      </applicableOfferOptionIds>
      <description>12.00% Discount</description>
      <discountAmount>14.40</discountAmount>
      <errorMessage i:nil="true" />
      <promoCode>lol</promoCode>
</promoCodeInformation>
Comments