Screen: ShopSite > Orders > Download Orders
Orders Download Tab-Delimited Text 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 three fields of the first record (line) would contain:
Order Date Order Number Customer Name
The next two records might have the following in the first three fields:
Thu Nov 20 14:55:11 1997 1235 Joe Cool
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, and the third is the customer name. Note that empty fields indicate the customer did not enter any information in that field.
Here are the definitions of each field in version 10. If you selected a format from a previous version for compatibility reasons, you can click these links to find the details of those formats:
version 9.0
version 8.3
version 7.1
version 7.0
version 6.3
version 6.2
version 6.1
version 6.0
version 5.0
version 4.3
- Order Date
- The date and time of the order as a string, such as "Tue Jan 22 13:53:49 2002"
- Order Number
- The order number for this order. All orders have unique numbers.
- Customer Name
- The customer's first and last name from the shipping page.
- Title
- The customer's title from the billing address.
- First Name
- The customer's first name from the billing address.
- Middle Name
- The customer's middle name from the billing address.
- Last Name
- The customer's last name from the billing address.
- Suffix
- The customer's name suffix from the billing address.
- Company Name
- The company name from the order form.
- Address 1
- The first field of the customer's billing address.
- Address 2
- 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.
- Email
- The customer’s e-mail address
- Ship To
- The name from the shipping address.
- Ship Title
- The name title from the shipping address.
- Ship First Name
- The first name from the shipping address.
- Ship Middle Name
- The middle name from the shipping address.
- Ship Last Name
- The last name from the shipping address.
- Ship Suffix
- The name suffix from the shipping address.
- Ship Company
- The company name from the shipping address.
- Ship Address 1
- The first field from the shipping address, normally the street address.
- Ship Address 2
- The second field from the shipping address.
- Ship City
- The city from the shipping address.
- Ship State
- The state from the shipping address.
- Ship Zip
- The ZIP code or postal code from the shipping address.
- Ship Country
- The country from the shipping address.
- Ship Phone
- The phone number from the shipping address.
- Payment Method
- Contains a string showing the payment method the customer used (e.g. Visa, Master Card, eCheck, COD).
- Payment Info 1
- For most pay types, this field contains the customer’s credit card number, or an encrypted value for the card number.
- Payment Info 2
- The name on the credit card.
- Payment Info 3
- The company name on the credit card.
- Payment Info 4
- The credit card expiration date.
- Card Verification Value
- The CVV2 value entered by the customer, or "xxx" if using online payment processing. For manual processing, if the order has already been downloaded or viewed online, the CVV2 value will be "**purged**".
- Payment Gateway
- The payment processing method used to process the order.
- Payment Status
- The status of the payment.
- Payment Processing Info
- When the customer paid with a credit card, this field contains the authorization information returned by the payment gateway.
- Shipping Method
- The field label for the shipping method chosen by the customer.
- Order Instructions
- The text that the customer entered in the ordering instructions box.
- Order Comments
- The text that the customer entered in the Comments box.
- Email List
- Indicates whether the customer checked the box to be included in the store’s e-mail list.
- Referred By
- The name of the associate site that the customer came from before placing the order.
- Remote IP/Host Name
- The IP Address and Host Name of the computer the customer was using.
- Product Total
- 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.
- Coupon Total
- The total amount of any coupon discounts applied to the order.
- Gift Certificates
- Identifies if a Gift Certificate was used as part of the purchase.
- Discount
- The amount of any volume discount applied to the order.
- Surcharges
- The text labels of any surcharge applied to the order.
- Surcharge Total
- The total amount of any surcharge applied to the order.
- Tax Name
- The name of the tax applied to this order. The merchant defines the names and rates, but they are either selected by the customer or automatically applied based on the shipping ZIP/postal code.
- Tax Rate
- The tax rate applied to this order. The merchant defines the names and rates, but they are either selected by the customer or automatically applied based on the shipping ZIP/postal code.
- Tax Total
- The amount of tax charged for the order.
- Shipping Total
- The amount of shipping charged for the order.
- Order Total
- The total amount charged to the customer. This amount includes all product charges, all coupon and volume discounts, all taxes, shipping, and surcharges.
- Order Weight
- The total shipping weight of the products in the order.
- BuySafe Amount
- The cost used by buySAFE
- BuySafe Text
- Text displayed with the buySAFE amount.
- BuySafe Cart ID
- The ID used by buySAFE to identify the order.
- Doba Shipping
- Shipping rate for Doba products.
- Doba Order Info
- Order information for Doba products. For example, this field might contain: ID: 322163|Total: $731.60
- Custom Fields
- The names and values of all custom fields, in this format:
field01 = value
- ShopSite Transaction ID
- A unique ID number assigned to the order, which can be used to associate ShopSite orders with payments.
- Customer ID
- The customer ID number in ShopSite, if the customer was registered and logged-in when the order was placed.
- Order UTC
- The Universal Time Code for when the order was placed.
- Number of Items
- 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 the number of remaining fields can be correctly calculated for that order record.
- Product Name
- The name of the product ordered.
- Product SKU
- The SKU of the product.
- Unit Price
- The price per unit (or sale price, if applicable) of the product ordered.
- Quantity
- The number of units of the product ordered.
- Extended Price
- The subtotal for the product ordered, which is the Price multiplied by the Quantity.
- Taxable
- Contains "checked" if the product is taxable.
- Product Type
- Indicates the type of product, such as "Tangible," "Download," "Coupon", or "Gift Certificate."
- Product Type Data
- Information about the product type, such as the coupon ID number.
- Product 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|.
- Other Options
- The contents of the ordering options text box for the product.
- Total Item Weight
- The shipping weight for this line item, which is the product weight multiplied by the quantity.
- Product Dimensions
- The box dimensions for shipping the product.
- QuickBooks Info
- The QuickBooks Item Type and Sales Account selected for this product.
- Doba Item ID
- The Doba ID for the product.