total_count |
Type: Number |
Title: Total Order Count |
total_count is the total number of records that match your search criteria. Note: this is not always the total orders returned. Based on the Count and Offset parameters passed, the number of records returned could be different than the total_count. |
start_offset |
Type: Number |
Title: Start Offset |
Number number of the starting offset number of orders to return. Used in conjunction with the Count parameter for paginating results of large datasets. |
id |
Type: Number |
Title: id |
Order Number for the Order |
pay_id |
Type: Number |
Title: Payment Order ID |
Id of Payment Module Used in transaction |
batch_id |
Type: Number |
Title: Batch ID |
Batch ID |
status |
Type: Number |
Title: Order Status |
Order Status. 0 = Pending, 100 = Processing, 200 = Shipped, 201 = Partially Shipped, 300 = Cancelled, 400 = Backordered, 500 = RMA Issued, 600 = Returned |
pay_status |
Type: Number |
Title: Pay Status |
Note: This field is not set currently and should be ignored. Future values will include:Payment Status. 0 = Pending, 100 = Authorized, 200 = Captured, 201 = Partially Captured. If you need to verify an order has been paid compare 'net_capt' to the 'total' field values. |
stk_status |
Type: Number |
Title: Stock Status |
Stock Status. 0 = Pending, 100 = yes, 200 = no, 201 = partial |
dt_instock |
Type: Unix Timstamp |
Title: Date/Time Instock (Unix timestamp) |
Date/Time Instock (Unix timestamp). 0 if Not set |
orderdate |
Type: Unix Timestamp |
Title: Order Date |
Order Date |
cust_id |
Type: Number |
Title: Customer ID |
Customer ID |
ship_res |
Type: Boolean |
Title: Ship Residential Flag |
Ship Residential Flag |
ship_fname |
Type: String |
Title: Shipping First Name |
Shipping First Name |
ship_lname |
Type: String |
Title: Shipping Last Name |
Shipping Last Name |
ship_email |
Type: String |
Title: Shipping Email Address |
Shipping Email Address |
ship_comp |
Type: String |
Title: Shipping Company |
Shipping Company |
ship_phone |
Type: String |
Title: Shipping Phone Number |
Shipping Phone Number |
ship_fax |
Type: String |
Title: Shipping Fax Number |
Shipping Fax Number |
ship_addr1 |
Type: String |
Title: Shipping Address Line 1 |
Shipping Address Line 1 |
ship_addr2 |
Type: String |
Title: Shipping Address Line 2 |
Shipping Address Line 2 |
ship_city |
Type: String |
Title: Shipping City |
Shipping City |
ship_state |
Type: String |
Title: Shipping State |
Shipping State |
ship_zip |
Type: String |
Title: Shipping Zip |
Shipping Zip |
ship_cntry |
Type: String |
Title: Shipping Country |
Shipping Country |
bill_fname |
Type: String |
Title: Billing First Name |
Billing First Name |
bill_lname |
Type: String |
Title: Billing Last Name |
Billing Last Name |
bill_email |
Type: String |
Title: Billing Email Address |
Billing Email Address |
bill_comp |
Type: String |
Title: Bill Company |
Bill Company |
bill_phone |
Type: String |
Title: Billing Phone Number |
Billing Phone Number |
bill_fax |
Type: String |
Title: Billing Fax Number |
Billing Fax Number |
bill_addr1 |
Type: String |
Title: Billing Address Line 1 |
Billing Address Line 1 |
bill_addr2 |
Type: String |
Title: Billing Address Line 2 |
Billing Address Line 2 |
bill_city |
Type: String |
Title: Billing City |
Billing City |
bill_state |
Type: String |
Title: Billing State |
Billing State |
bill_zip |
Type: String |
Title: Billing Zip |
Billing Zip |
bill_cntry |
Type: String |
Title: Billing Country |
Billing Country |
ship_id |
Type: Number |
Title: Shipping Module id |
Shipping Module Used in Shipping Calculations |
ship_data |
Type: String |
Title: Shipping Data |
Shipping Data - Typically Shipping Method Name |
ship_method |
Type: String |
Title: Shipping Method |
Shipping Method Name |
cust_login |
Type: String |
Title: Customer Login |
Customer Login |
cust_pw_email |
Type: String |
Title: Customer Email Password |
Customer Email Password |
business_title |
Type: String |
Title: Business Title |
Business Title |
payment_module |
Type: String |
Title: Payment Module |
Payment Module Name |
source |
Type: String |
Title: Source |
Source of how the order was placed. Possible Values include "Shopper" - Order Placed By Customer, "Subscription" - Order Created by the Subscription System, "User" - Order Created in the Admin |
source_id |
Type: Number |
Title: Source ID |
The id of the customer, id of Admin user or id of subscription based on how order was placed |
total |
Type: Number |
Title: Total |
Total |
formatted_total |
Type: String |
Title: Formatted Total |
Formatted Total |
total_ship |
Type: Number |
Title: Total Shipping |
Total Shipping |
formatted_total_ship |
Type: String |
Title: Formatted Total Shipping |
Formatted Total Shipping |
total_tax |
Type: Number |
Title: Total Tax |
Total Tax |
formatted_total_tax |
Type: String |
Title: Formatted Total Tax |
Formatted Total Tax |
total_auth |
Type: Number |
Title: Total Authorized |
Total Authorized |
formatted_total_auth |
Type: String |
Title: Formatted Total Authorized |
Formatted Total Authorized |
total_capt |
Type: Number |
Title: Total Captured |
Total Captured |
formatted_total_capt |
Type: String |
Title: Formatted Total Captured |
Formatted Total Captured |
total_rfnd |
Type: Number |
Title: Total Amount Refunded |
Total Amount Refunded |
formatted_total_rfnd |
Type: String |
Title: Formatted Total Amount Refunded |
Formatted Total Amount Refunded |
net_capt |
Type: Number |
Title: Net Amount Captured |
Net Amount Captured |
formatted_net_capt |
Type: String |
Title: Formatted Net Amount Captured |
Formatted Net Amount Captured |
pend_count |
Type: Number |
Title: Pending Item Count |
Pending Item Count |
bord_count |
Type: Number |
Title: Backordered Item Count |
Backordered Item Count |
note_count |
Type: Number |
Title: Note Count |
Note Count |
dt_updated |
Type: Unix Timestamp |
Title: Date/Time Updated |
Date Time Last Updated |
customer + Show Properties |
Type: Object |
Title: Customer |
Customer |
id |
Type: Number |
Title: Customer ID |
Customer ID |
account_id |
Type: Number |
Title: Business Account ID |
Business Account ID |
login |
Type: String |
Title: Customer Login |
Customer Login |
pw_email |
Type: String |
Title: Customer Email Password |
Customer Email Password |
ship_id |
Type: Number |
Title: Shipping ID |
Shipping ID |
ship_res |
Type: Boolean |
Title: Shipping Residential Flag |
Shipping Residential Flag |
ship_fname |
Type: String |
Title: Shipping First Name |
Shipping First Name |
ship_lname |
Type: String |
Title: Shipping Last Name |
WOShipping Last NameRDS |
ship_email |
Type: String |
Title: Shipping Email |
Shipping Email |
ship_comp |
Type: String |
Title: Shipping Company |
Shipping Company |
ship_phone |
Type: String |
Title: Shipping Phone |
Shipping Phone |
ship_fax |
Type: String |
Title: Shipping Fax |
Shipping Fax |
ship_addr1 |
Type: String |
Title: Shipping Address Line 1 |
Shipping Address Line 1 |
ship_addr2 |
Type: String |
Title: Shipping Address Line 2 |
Shipping Address Line 2 |
ship_city |
Type: String |
Title: Shipping City |
Shipping City |
ship_state |
Type: String |
Title: Shipping State |
Shipping State |
ship_zip |
Type: String |
Title: Shipping Zip |
Shipping Zip |
ship_cntry |
Type: String |
Title: Shipping Country |
Shipping Country |
bill_fname |
Type: String |
Title: Billing First Name |
Billing First Name |
bill_lname |
Type: String |
Title: Billing Last Name |
Billing Last Name |
bill_email |
Type: String |
Title: Billing Email Address |
Billing Email Address |
bill_comp |
Type: String |
Title: Bill Company |
Bill Company |
bill_phone |
Type: String |
Title: Billing Phone Number |
Billing Phone Number |
bill_fax |
Type: String |
Title: Billing Fax Number |
Billing Fax Number |
bill_addr1 |
Type: String |
Title: Billing Address Line 1 |
Billing Address Line 1 |
bill_addr2 |
Type: String |
Title: Billing Address Line 2 |
Billing Address Line 2 |
bill_city |
Type: String |
Title: Billing City |
Billing City |
bill_state |
Type: String |
Title: Billing State |
Billing State |
bill_zip |
Type: String |
Title: Billing Zip |
Billing Zip |
bill_cntry |
Type: String |
Title: Billing Country |
Billing Country |
tax_exempt |
Type: Boolean |
Title: Tax Exempt |
Tax Exempt |
note_count |
Type: Number |
Title: Note Count |
Note Count |
dt_created |
Type: Unix Timestamp |
Title: Date Created |
Date Created |
dt_updated |
Type: Unix Timestamp |
Title: Date Last Updated |
Date Order Last Updated |
dt_login |
Type: Unix Timestamp |
Title: Date Login |
Date Login |
credit |
Type: Number |
Title: Customer Credit |
Credit Credit Balance |
formatted_credit |
Type: String |
Title: Formatted Credit |
Formatted Credit Balance |