...
| Field | Type | Comment | ||
| labels | hash | this hash contains all the labels for the various fields below. This hash is powerful because it contains the mappings you specify in the back end "screen branding' section. See the order labels section for individual listings. | ||
| merchantId | string | your merchant id | ||
| customerProfileId | int | customer's internal identifier | ||
| orderId | string | order id | ||
| rejected | boolean | true if the order was rejected | ||
| themeCode | string | the theme code applied to this order. See screen branding. This code is often used when creating buy links to apply the proper look and feel to an order page. Some merchants only have one theme. Some merchants have 50. | ||
| creationDate | string | ISO-8601 format. When the order was created | ||
| creationDateFormatted | string | DD-MMM-YYYY format. When the order was created | ||
| shipOnDate | string | ISO-8601 format. When the order was requested to ship on. | ||
| shipOnDateFormatted | string | DD-MMM-YYYY format. When the order was requested to ship on. | ||
| saturdayDelivery | boolean | true if the order is set for Saturday delivery | ||
| rejectedDate | string | ISO-8601 format. When the order was rejected (null if it hasn't been) | ||
| rejectedDateFormatted | string | DD-MMM-YYYY format of when the order was rejected, if it was. | ||
| quoteExpirationDate | string | ISO-8601 format. If this order is a quote, when the quote expires. | ||
| quoteExpirationDateFormatted | string | DD-MMM-YYYY format. If this order is a quote, when the quote expires. | ||
| status | string | Completed, Rejected, Quote Sent, Quote Requested, Pre-Order Item, Pending | ||
| testOrder | boolean | true if this order was a test | ||
| shippingMethod | string | a bare bones description of the shipping method | ||
| shippingMethodName | string | a friendly version of the shipping method. This should be preferred for display over shippingMethod | ||
| shippingMethodDetailed | string | an elaborate string contain shippingMethodName and any features such as lift gates and ship to residential, | ||
| shippingMethodCompany | string | UPS, FedEx, etc. | ||
| shipping3rdPartyAccountNumber | string | |||
| string | ||||
| ccEmails | string[ ] | an array of email addresses who were cc'd on the order. | ||
| giftEmail | string | the gift recipient's email address | ||
| billToCompany | string | |||
| billToTitle | string | |||
| billToFirstName | string | |||
| billToLastName | string | |||
| billToAddress1 | string | |||
| billToAddress2 | string | |||
| billToCity | string | |||
| billToState | string | |||
| billToPostalCode | string | |||
| billToCountry | string | |||
| billToDayPhone | string | |||
| billToEveningPhone | string | |||
| shipToCompany | string | |||
| shipToTitle | string | |||
| shipToFirstName | string | |||
| shipToLastName | string | |||
| shipToAddress1 | string | |||
| shipToAddress2 | string | |||
| shipToCity | string | |||
| shipToState | string | |||
| shipToPostalCode | string | |||
| shipToCountry | string | |||
| shipToDayPhone | string | |||
| shipToEveningPhone | string | |||
| gift | boolean | true if the order is a gift | ||
| liftGate | boolean | true if the order requires a lift gate to deliver. | ||
| shipToResidential | boolean | true if the delivery is a residence | ||
| hidePaymentInformation | boolean | whether or not to show payment information. Imagine the scenario where the cost is zero and/or gift certificates were used. | ||
| refundPresent | boolean | duplicate of hasRefund. Use hasRefund, as this field is deprecated and will be removed without warning. | ||
| taxShipping | boolean | is shipping taxed? this affects the display of subtotal information (tax before subtotal or subtotal before tax). | ||
| taxCounty | string | |||
| referralCode | string | |||
| advertisingSource | string | |||
| paymentMethod | string | Credit Card, PayPal Order, etc. Supported payment methods as of 6/2013 (list may change):
| ||
| paymentNote | string | A friendly working of the paymentMethod. For display purposes, use this value instead of paymentMethod. It will always read the same or better. | ||
| cardType | string | The type of credit card used. VISA, MasterCard, etc. | ||
| cardNumber | string | masked. last four digits. | ||
| coupons | Coupon | The coupon class contains two simple fields: code and description | ||
| items | Item[ ] | The items for this order | ||
| giftWrapTitle | string | the name of the gift wrap | ||
| giftWrapCost / giftWrapCostFormatted | number / string | |||
| hasDiscount | boolean | true if a discount was made somewhere (often useful for adding an extra table column, etc.) | ||
| hasRefund | boolean | true if a refund was made somewhere (often useful for adding an extra table column, etc.) | ||
| subtotalBeforeDiscount / subtotalBeforeDiscountFormatted | number / string | |||
| discount / discountFormatted | number / string | |||
| subtotal / subtotalFormatted | number / string | subtotal with any discounts and refunds already applied | ||
| subtotalRefunded / subtotalRefundedFormatted | number / string | |||
| taxRate / taxRateFormatted | number / string | |||
| shippingHandlingDiscount / shippingHandlingDiscountFormatted | number / string | |||
| shippingHandlingTotal / shippingHandlingTotalFormatted | number / string | total with any discounts and refunds already applied. | ||
| shippingHandlingRefunded / shippingHandlingRefundedFormatted | number / string | |||
| tax / taxFormatted | number / string | tax with any refund already applied | ||
| taxRefunded / taxRefundedFormatted | number / string | |||
| giftCharge / giftChargeFormatted | number / string | |||
| surcharge / surchargeFormatted | number / string | |||
| showBuysafe | boolean | true if this order used buySAFE and the amounts should be shown. | ||
| buysafeCost / buysafeCostFormatted | number / string | |||
| buysafeRefunded / buysafeRefundedFormatted | number / string | |||
| boolean | true if this order used InsureShip and the amounts should be shown.
| |||
| number / string | insure ship cost | |||
| number / string | value of any insure ship refunded | |||
| total / totalFormatted | number / string | grand total | ||
| totalRefunded / totalRefundedFormatted | number / string | of the total, this amount was refunded | ||
| showCurrencyWarning | boolean | true if the currency warning (next line) should be shown. | ||
| currencyWarning | string | this is the standard currency warning if the order was placed in a different currnency. It contains a nicely formatted message to show to the customer. | ||
| giftCertificateCode | string | the gift certificate code. If the gift certificate was a credit card type, the code will be masked. | ||
| giftCertificateAmount / giftCertificateAmountFormatted | number / string | the amount used of the gift certificate | ||
| giftMessage | string[ ] | array of gift message lines when this field was entered, newlines were captured to preserve the look. so this field is an array of strings broken by newlines. You may join them or iterate them as desired. | ||
| specialInstructions | string[ ] | array of special instructions text when this field was entered, newlines were captured to preserve the look. so this field is an array of strings broken by newlines. You may join them or iterate them as desired. | ||
| comments | string[ ] | array of comments when this field was entered, newlines were captured to preserve the look. so this field is an array of strings broken by newlines. You may join them or iterate them as desired. | ||
| trackingNumbers | string[ ] | array of tracking numbers | ||
| orderCase | Case | See the case object above. If there is a case (customer feedback) associated with this order, it will be populated in this value. |
...