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

Order Detail Item

Data Structure holding detailed information about a order detail item. 
Holds information about the actual voucher/product purchased.

Fields:
Field Data Type Nulls Description
consumerName string

The consumer's name as it appears on the voucher/shipping notice.
consumerRedeemedDate
datetime
Y
The date the consumer marked the voucher redeemed, UI tracking only.
expirationDate datetime
Y
If there is an expiration date on the purchase.  Typically voucher expiration date.
fulfillmentStatus enum

Where this item is in the order fulfillment status chain.
itemKey string

The string based identifier for this tracked item.
merchantRedeemedDate datetime
Y
The date the voucher was redeemed by the merchant if it is a voucher.
offerId int

The offer id this tracking item is for.
offerOptionId int
The offer option id this tracking item is for.
paymentStatus enum

Gets the order payment status for this tracked item.
redemptionCode string
Y
Gets or sets the redemption code if it is required for redemption purposes.  Will be null if not needed.
redemptionUrl string
Y
If this tracked item has a redemption url rather than a voucher code or a product with a tracked item.
refundDate datetime
Y
If this item was refunded, the date the refund occurred.
refundReverseDatedatetime
Y
If the refund was reversed, the date the item was reversed.
secretKeystring
Y
The secret key for this tracking item.  If the voucher code is null, this will be null.
shippingDate
datetime
Y
The date the item is shipping.
shippingProviderenum
 The shipping provider for the item.
shippingTrackingNumber
string
Y
The tracking number issued by the shipping provider.
shippingTrackingUrl
string
Y
Returns the tracking url for this shipment order.
voucherCodestring
Y
The voucher code (can also be for products) for this item.  Should be unique across a contract.
voucherCodeImageDisplayFormat
enum
 
The display format for the voucher code.  Note: This item won't be null, but still might not apply.
 

Sample JSON Response:
 {
    "consumerName": "Matt Testing",
    "consumerRedeemedDate": null,
    "expirationDate": "/Date(1353283200000)/",
    "fulfillmentStatus": "New",
    "itemKey": "gcs_odt_1193561",
    "merchantRedeemedDate": null,
    "offerId": 5734,
    "offerOptionId": 5640,
    "paymentStatus": "New",
    "redemptionCode": null,
    "redemptionUrl": null,
    "refundDate": null,
    "refundReverseDate": null,
    "secretKey": "r8PffrhdDLCyb6bpqUTJHo7WPIIpnei7PPZBIKryqDI=",
    "shippingDate": null,
    "shippingProvider": "None",
    "shippingTrackingNumber": null,
    "shippingTrackingUrl": null,
    "voucherCode": "P-4118-131-AF0A2",
    "voucherCodeImageDisplayFormat": "Barcode"
}



Sample XML Response:
<item>
    <consumerName>Matt Testing</consumerName>
    <consumerRedeemedDate i:nil="true" />
    <expirationDate>2012-11-19T00:00:00Z</expirationDate>
    <fulfillmentStatus>New</fulfillmentStatus>
    <itemKey>gcs_odt_1193561</itemKey>
    <merchantRedeemedDate i:nil="true" />
    <offerId>5734</offerId>
    <offerOptionId>5640</offerOptionId>
    <paymentStatus>New</paymentStatus>
    <redemptionCode i:nil="true" />
    <redemptionUrl i:nil="true" />
    <refundDate i:nil="true" />
    <refundReverseDate i:nil="true" />
    <secretKey>r8PffrhdDLCyb6bpqUTJHo7WPIIpnei7PPZBIKryqDI=</secretKey>
    <shippingDate i:nil="true" />
    <shippingProvider>None</shippingProvider>
    <shippingTrackingNumber i:nil="true" />
    <shippingTrackingUrl i:nil="true" />
    <voucherCode>P-4118-131-AF0A2</voucherCode>
    <voucherCodeImageDisplayFormat>Barcode</voucherCodeImageDisplayFormat>
</item>
Comments