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

Order

Data Structure holding information about an order in the system.

Fields:
Field Data Type Nulls Description
amount Currency

The amount the purchase was for (the amount the consumer was charged: order total + shipping costs + taxes - discounts and credits used).
creditsApplied
Currency
 
Will contain the amount of credits that was applied to the order.
currencySymbol string    The symbol for the currency of the order (e.g. $) 
estimatedChargeAmount
Currency
 
The estimated total amount of the order that will be paid in cash, including shipping fee and taxes.
estimatedTax  
decimal
Y
If this order has taxable items, returns the tax estimate for this order generated at purchase time. Once taxes have been completely calculated for this order (see taxesCalculated), this value will be set to null, and the actual amount of tax (see totalTax) charged to the consumer may differ. If this order has no taxable items, this will always return null.   
isoCurrencyCode string    The three character iso currency code for the order (e.g. USD) 
offers list

List of offers that are related to this order.
offPlatformPurchaseInformation
OffPlatform
PurchaseInformation

Y Off platform purchase information for the order (null if this order was not purchased off platform)
orderDate datetime
The date the order was purchased.
orderDetails list

A collection of order details.
promoCodeDiscountAmount decimal  The amount subtracted from the order total due to the promo codes that were applied to this order.  Null if no promo code was applied to the order.
orderId int
The id of the order.
shippingFee decimal  The shipping fee for the order (null if not applicable). 
status OrderStatus

Will contain the current status of the order.  This field is useful for displaying different states of an order from the customer my account page.
subtotal decimal   The total cost of goods for this order (price * quantity) 
taxesCalculated
bool If this order has taxable items, indicates if taxes have finished calculating. If this order does not have taxable items, this will always return false.
totalTax decimal  The final tax amount for the order calculated when the order is charged.  This field will be zero if the order's status is still Processing (i.e. before the order is charged).  Null if the order is not taxable.
 

Sample JSON Response:
{
    "amount": {
        /* see currency */
    },
    "creditsApplied": {
        /* see currency */
    },

    "currencySymbol": "$",
    "estimatedChargeAmount": {
        /* see currency */
    },

    "estimatedTax": 4.32
,
    "isoCurrencyCode": "USD",
 
    "offers": [
        { /*
see offer */ },
        { /* see offer */ }
    ],
    "offerOptionId": 7111,
    "offPlatformPurchaseInformation": {
        /* see off platform purchase information */
    },
    "orderDate": "/Date(1319748346000)/",
    "orderDetails": [
        { /*
see order detail */ },
        { /* see order detail */ }
    ],
    "orderId": 55884,
    "shippingFee": 0,
    "status": "Completed",
    "subtotal": 163.50,
    "taxesCalculated": false,
    "totalTax": 0
}



Sample XML Response:
<order>
    <amount>
       
<!-- see currency -->
    </amount>
    <creditsApplied>
        <!--
see currency -->
    </creditsApplied>
    <currencySymbol>$</currencySymbol>
    <estimatedChargeAmount>
        <!--
see currency -->
    </estimatedChargeAmount>
    <estimatedTax>4.32</estimatedTax>
    <isoCurrencyCode>USD</isoCurrencyCode>
    <offers>

        <offer>
            <!-- see offer -->
        </offer>

        <offer>
            <!-- see offer -->
        </offer>

    </offers>
    <offPlatformPurchaseInformation>
        <!-- see off platform purchase information -->   
    </offPlatformPurchaseInformation>
    <orderDate>2011-10-27T20:45:46Z</orderDate>
    <orderDetails>
        <orderDetail>
           
<!-- see order detail -->
        </orderDetail>
        <orderDetail>
           
<!-- see order detail -->
        </orderDetail>
    </orderDetails>
    <orderId>55884</orderId>
    <promoCodeDiscountAmount>27.8</promoCodeDiscountAmount>
    <shippingFee>0</shippingFee>
    <status>Completed</status>
    <subtotal>163.50</subtotal>
    
<taxesCalculated>false</taxesCalculated>
    <totalTax>0</totalTax>
</order>

Comments