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

Offer Option Pricing

Data Structure holding publisher segment information.

Fields:
Field Data Type Nulls Description
isoCurrencyCode string
Three letter code denoting the currency.  USD, CAD, etc
currencySymbol
string

The currency symbol to be used, eg $, €, ¥
discountPercent decimal
The percentage to 2 decimal places, the savings divided by originalPrice.  eg 49.23
originalPrice decimal

The original price of this option.
price
decimal

The price the option can be purchased for.
promotionalPrice decimal
Y
The promotional price that might or might not exist for the option depending on publisher membership, etc.
savings
decimal

The difference between originalPrice and price.
shippingFeedecimalYAdditional shipping fee to be applied at checkout.
shippingFeePerQuantity
bool
Y
True if the shipping fee is to be applied per quantity ordered, false if it is a flat fee per shipping address.  Null if the offer does not require shipping.
vatPercentage
decimal
Y
The value added tax percentage for UK offers.  Null if the offer does not require VAT.
 

Sample JSON Response:
{
    "isoCurrencyCode": "USD",
    "currencySymbol": "$",
    "discountPercent": 49.23,
    "originalPrice": 100,
    "price": 50.77,
    "promotionalPrice": null,
    "savings": 49.23,
    "shippingFee": null,
    "shippingFeePerQuantity": null,
    "vatPercentage": null
}


Sample XML Response:
<pricing>
    <
isoCurrencyCode>USD</isoCurrencyCode>
    <currencySymbol>$</currencySymbol>
    <discountPercent>49.23</discountPercent>
    <originalPrice>100</originalPrice>
    <price>50.77</price>
    <promotionalPrice i:nil="true"/>
    <savings>49.23</savings>
   
<shippingFee i:nil="true"/>
    <shippingFeePerQuantity i:nil="true"/>
    <vatPercentage i:nil="true"/>
</pricing>

Comments