Screen: ShopSite > Orders > Download Orders
Download Orders File Format
Each line in the downloaded file is an order (except for the first line). The first line indicates the name and sequence of each field found in the remaining records. For example the first four fields of the first record (line) would contain:
Date OrderNum Name Company
The next two records might have the following in the first four fields:
Thu Nov 20 14:55:11 1997 1235 Joe Cool ShopSite, Inc.
Thu Nov 20 16:35:31 1997 1236 Sally Smith
Each field is separated by a tab. The first field is the date and time the order was placed, the second is the order number, the third is the customer name, and the fourth field is the company name. Note that in the second order the customer did not enter a company name so the field is empty.
Here are the definitions of each field:
- Date
- The date and time of the order as a string, such as "Tue Jan 22 13:53:49 2002"
- OrderNum
- The order number for this order. All orders have unique numbers.
- Name
- The customer name from the order form.
- Name Company
- The company name from the order form.
- Email
- The customer’s e-mail address
- Address
- The first field of the customer’s billing address.
- Address2
- The second field of the customer’s billing address.
- City
- The city from the customer’s billing address.
- State
- The state from the customer’s billing address.
- Zip
- The ZIP or postal code from the customer’s billing address.
- Country
- The country from the customer’s billing address.
- Phone
- The phone number from the customer’s billing address.
- ShipName
- The name from the shipping address.
- ShipCompany
- The company name from the shipping address.
- ShipAddress
- The first field from the shipping address, normally the street address.
- ShipAddress2
- The second field from the shipping address.
- ShipCity
- The city from the shipping address.
- ShipState
- The state from the shipping address.
- ShipZip
- The ZIP code or postal code from the shipping address.
- ShipCountry
- The country from the shipping address.
- ShipPhone
- The phone number from the shipping address.
- PayType
- Contains a string showing the payment method that the customer used:
Visa
MasterCard
Discover
American Express
Purchase Order
C.O.D.
Check
Generic 1
Generic 2
- pay1
- For most pay types, this field contains the customer’s credit card number.
- pay2
- The name on the credit card.
- pay3
- The company name on the credit card.
- pay4
- The credit card expiration date.
- OrderInst
- The text that the customer entered in the ordering instructions box.
- Comments
- The text that the customer entered in the Comments box.
- ProductTotal
- The cost of all products ordered. This value is based on sale prices if any products are on sale. It does not include coupon discounts, tax, shipping, or surcharges.
- TaxTotal
- The amount of tax charged for the order.
- ShippingTotal
- The amount of shipping charged for the order.
- GrandTotal
- The total amount charged to the customer. This amount includes all product charges, all coupon and volume disounts, all taxes, shipping, and surchages.
- NumItems
- The number of separate products that were ordered (not to be confused with "Quantity," which indicates the number of a specific product that was ordered.) For example, if Sally orders 5 copies of the book Selling on the Web using ShopSite then NumItems would be 1 and Quantity would be 5. But if Joe orders 1 copy of Selling on the Web using ShopSite and 1 copy of ShopSite for Dummies then NumItems would be 2 and Quantity would be 1 for each product in the order record. Note that all product-specific fields would be repeated in the order record for Joe, because Joe ordered two separate products. It is therefore important for a program to read the NumItems field so that the number of remaining fields can be correctly calculated for that order record.
- Shipping
- The field label for the shipping method chosen by the customer.
- Discount
- The amount of any volume discount applied to the order.
- Surcharge
- The text label and amount of any surcharge applied to the order.
- RefName
- The name of the associate site that the customer came from before placing the order.
- Coupon Total
- The total amount of any coupon discounts applied to the order.
- OrderInfo
- When the customer paid with a credit card, this field contains the authorization information returned by the payment gateway.
- cvv2
- The CVV2 value entered by the customer.
- EmailList
- Indicates whether the customer checked the box to be included in the store’s e-mail list.
- Name
- The name of the product ordered.
- Price
- The price per unit (or sale price, if applicable) of the product ordered.
- Quantity
- The number of units of the product ordered.
- Sub-total
- The subtotal for the product ordered, which is the Price multiplied by the Quantity.
- Finite Options
- The values that the customer selected in pull-down menu options (e.g., small, medium, large, or x-large) for the product. If the product had multiple ordering options, each value is separated by |n|.
- Freeform Options
- The contents of the ordering options text box for the product.
- SKU
- The SKU of the product.
- Product Type
- Indicates the type of producte, either "Tangible," "Download," or "Coupon."
- Total Item Weight
- The total weight of the products in this line item. This value is the product’s weight multiplied by the quantity ordered.
- Dimension
- The shipping box dimensions for this product.
- QBImport
- Information to categorize this product when product and order information is imported into QuickBooks. It is shown as two fields separated by a | symbol, such as PART|Sales:ShopSite. The first value is the QuickBooks Item Type assigned to the product, and the second value is the QuickBooks account used to track sales of this product.
- Taxable
- "checked" if this product is taxable.
