24/7 Support: 800.608.6482

Navigation


OrderList_Load_Query

This function is used to query one or more orders from Miva.

Request Parameters

count Type:
Number
Title:
Count
Count is used to tell Miva how many Orders you returned. If for example you are querying thousands of orders you'll want to set the count to limit how many you get back in a single request.
offset Type:
Offset
Title:
Number
Used in conjunction with the Count parameter for paginating results of large datasets. Default 0 is no offset.
sort Type:
String
Title:
Sort
Field to sort results by. Avaiilable sorting fields listed below. Use - prefix for a decending sort.
Filter Type:
Object
Title:
Filter
Array of Object containing search filters. See usage here: List Load Query Overview

Additional Input Parameters

Passphrase Single decryption passphrase for payment data (if requested in ondemandcolumns)

On Demand Columns

ship_method Full Name of Shipping Method Used on the order. The shipping method is also returned under the Charges object with type "SHIPPING". Including this ondemandcolumn adds an explict "ship_method" value to the JSON response containitng the name of the shippig method.
cust_login Customer login attached to the order. This data is also available in the Customer Object
cust_pw_email Customer Password Reset Email Address. This data is also available in the Customer Object
business_title Name of Business Account Associated with Account
payment_module Name of Payment Module Used for Payment. This data is also available in the Payment Object
customer Includes Customer Object in response
items Includes Items object in response
charges Includes charges object in response
coupons Includes coupons object in response
discounts Includes discounts object in response
payments Includes payments object in response
payment_data Requires Passphrase to also be sent. Includes decrypted payment data object in response
notes Includes notes object in response
parts Includes kits parts in the response, if a product is setup as a kit in Miva.

Other custom Filters

Customer_ID
BusinessAccount_ID

Supported Search Filter Columns

id ship_zip source
batch_id ship_city source_id
status ship_cntry total
pay_status ship_state total_ship
orderdate ship_data total_tax
dt_instock bill_fname total_auth
ship_res bill_lname total_rfnd
ship_fname bill_email net_capt
ship_lname bill_comp pend_count
ship_email bill_phone bord_count
ship_comp bill_fax cust_login
ship_phone bill_addr1 cust_pw_email
ship_fax bill_addr2 business_title
ship_addr1 bill_city bill_zip
ship_addr2 bill_state bill_city
ship_city bill_cntry note_count
product_code
Loads all orders containing the specified product code. Operator is ignored.
payment
One of "auth_0_capt", "partial_capt", "capt_not_ship", "ship_not_capt". Operator is ignored.
pay_id
Loads all order for the specified payment module id. Operator is ignored.

Supported Sort Columns

One of these values would be passed in the sort request parameter to have the results sorted by that column. Value may be preceded by "-" for a descending sort.

id ship_zip source
batch_id ship_city source_id
status ship_cntry total
pay_status bill_fname total_ship
orderdate bill_lname total_tax
dt_instock bill_email total_auth
ship_res bill_comp total_rfnd
ship_fname bill_phone net_capt
ship_lname bill_fax pend_count
ship_email bill_addr1 bord_count
ship_comp bill_addr2 cust_login
ship_phone bill_city cust_pw_email
ship_fax bill_state business_title
ship_addr1 bill_zip note_count
ship_addr2 bill_city payment_module
ship_city bill_cntry  
ship_state ship_data  

Response Parameters

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
items
+ Show Properties
Type:
Object
Title:
Items
Items
order_id Type:
Number
Title:
Order ID
Order ID
line_id Type:
Number
Title:
Line ID
Line ID
status Type:
Number
Title:
Status
Item Status. 0 = Pending, 100 = Picking, 200 = Shipped, 210 = Gift Certificate: Not Redeemed, 211 = Gift Certificate: Redeemed, 220 = Digital: Not Downloaded, 221 = Digital: Downloaded , 300 = Cancelled, 400 = Backordered, 500 = RMA Issued, 600 = Returned
subscrp_id Type:
Number
Title:
Subscription ID
Subscription ID
subterm_id Type:
Number
Title:
Subscription Term Id
Subscription Term Id
rma_id Type:
Number
Title:
Return Merchandise Authorization Id
Return Merchandise Authorization Id
dt_instock Type:
Number
Title:
Date/Time Instock (Unix timestamp)
Date/Time Instock (Unix timestamp)
code Type:
String
Title:
Code
Code
name Type:
String
Title:
Name
Name
sku Type:
String
Title:
Sku Number
Sku Number
retail Type:
Number
Title:
Retail Price
Retail Price
base_price Type:
Number
Title:
Base Price
Base Price
price Type:
Number
Title:
Price
Price
weight Type:
Number
Title:
Weight
Weight
taxable Type:
Boolean
Title:
Taxable
Taxable
tax Type:
Number
Title:
Tax
Sales tax for this specific Item
formatted_tax Type:
String
Title:
Currency Formatted Tax
Currency formatted sales tax for this specific Item
upsold Type:
Boolean
Title:
Upsold
Upsold
quantity Type:
Number
Title:
Quantity
Quantity
discounts
+ Show Properties
Type:
Object
Title:
Discounts
Discounts
order_id Type:
Number
Title:
Order ID
Order ID
line_id Type:
Number
Title:
Line ID
Line ID
pgrp_id Type:
Number
Title:
Price Group Id
Price Group Id
display Type:
Boolean
Title:
Display
Display
descrip Type:
String
Title:
Description
Description
discount Type:
Number
Title:
Discount Amount
Discount Amount
parts
+ Show Properties
Type:
Object
Title:
Item Parts
This Object will only be output if the item has parts. Otherwise it will not be returned.
code Type:
String
Title:
Code
Part Product Code
sku Type:
String
Title:
SKU
Part Product SKU
name Type:
String
Title:
Name
Part Product Name
quantity Type:
Number
Title:
Quantity
Quantity of Part
total_quantity Type:
Number
Title:
Total Quantity
Part Quantity * Item Quantity
price Type:
Number
Title:
Price
Part Product Price
options
+ Show Properties
Type:
Object
Title:
Options
Options
attribute Type:
String
Title:
Attribute
Attribute
value Type:
String
Title:
Value
Value
weight Type:
Number
Title:
Weight
Weight
retail Type:
Number
Title:
Retail
Retail
base_price Type:
Number
Title:
Base Price
Base Price
price Type:
Number
Title:
Price
Price - Including any item level discounts
discounts
+ Show Properties
Type:
Object
Title:
Discounts
Discounts
order_id Type:
Number
Title:
Order ID
Order ID
line_id Type:
Number
Title:
Line ID
Line ID
attr_id Type:
Number
Title:
Attribute ID
Attribute ID
attmpat_id Type:
Number
Title:
Attribute Template ID
Attribute Template ID
pgrp_id Type:
Number
Title:
Price Group Id
Price Group Id
display Type:
Boolean
Title:
Display
Display
descrip Type:
String
Title:
Description
Description
discount Type:
Number
Title:
Discount Amount
Discount Amount
total Type:
Number
Title:
Total
Total
shipment
+ Show Properties
Type:
Object
Title:
Shipment
Shipment
id Type:
Number
Title:
ID
ID
code Type:
String
Title:
Code
Code
order_id Type:
Number
Title:
Order ID
Order ID
status Type:
Number
Title:
Shipment Status
Shipment Status. 100 = Picking, 200 = Shipped
labelcount Type:
Number
Title:
Label Count
Label Count
ship_date Type:
String
Title:
Ship Date
Ship Date
tracknum Type:
String
Title:
Tracking Number
Tracking Number
tracktype Type:
String
Title:
Tracking Type
Tracking Type. Default Types include "CanadaPost", "Endicia", "FedEx", "UPS", "USPS"
tracklink Type:
String
Title:
Tracking Link
Tracking Link
weight Type:
Number
Title:
Weight
Weight
cost Type:
Number
Title:
Cost
Cost
formatted_cost Type:
String
Title:
Formatted Cost
Formatted Cost
subscription
+ Show Properties
Type:
Object
Title:
Subscription
Subscription
id Type:
Number
Title:
ID
ID
order_id Type:
Number
Title:
Order ID
Order ID
line_id Type:
Number
Title:
Line ID
Line ID
cust_id Type:
Number
Title:
Customer ID
Customer ID
custpc_id Type:
Number
Title:
Customer Payment Card Id
Customer Payment Card Id
product_id Type:
Number
Title:
Product ID
Product ID
subterm_id Type:
Number
Title:
Subscription Term Id
Subscription Term Id
addr_id Type:
Number
Title:
Address ID
Address ID
ship_id Type:
Number
Title:
Shipping ID
Shipping ID
ship_data Type:
String
Title:
Shipping Date
Shipping Date
quantity Type:
Number
Title:
Quantity
Quantity
termrem Type:
Number
Title:
Subscription Term Remaining Orders
Subscription Term Remaining Orders
termproc Type:
Number
Title:
Number of Subscription Terms Processed
Number of Subscription Terms Processed
firstdate Type:
Unix Timestamp
Title:
First Date
First Date
lastdate Type:
Unix Timestamp
Title:
Last Date
Last Date
nextdate Type:
Unix Timestamp
Title:
Next Date
Next Date
status Type:
String
Title:
Status
Status
message Type:
String
Title:
Message
Message
cncldate Type:
Unix Timestamp
Title:
Cancellation Date
Cancellation Date
tax Type:
Number
Title:
Tax
Tax
formatted_tax Type:
String
Title:
Formatted Tax
Formatted Tax
shipping Type:
Number
Title:
Shipping
Shipping
formatted_shipping Type:
String
Title:
Formatted Shipping
Formatted Shipping
subtotal Type:
Number
Title:
Subtotal
Subtotal
formatted_subtotal Type:
String
Title:
Formatted Subtotal
Formatted Subtotal
total Type:
Number
Title:
Total
Total
formatted_total Type:
String
Title:
Formatted Total
Formatted Total
method Type:
String
Title:
Method
Method
productsubscriptionterm
+ Show Properties
Type:
Object
Title:
Product Subscription Term
Product Subscription Term
id Type:
Number
Title:
ID
ID
product_id Type:
Number
Title:
Product ID
Product ID
frequency Type:
Number
Title:
Frequency
Frequency
term Type:
Number
Title:
Term
Term
descrip Type:
String
Title:
Description
Description
n Type:
Number
Title:
n
Term Every n Days
fixed_dow Type:
Number
Title:
Subscription Term – Fixed Day of Week
Subscription Term – Fixed Day of Week
fixed_dom Type:
Number
Title:
Subscription Term – Fixed Day of Month
Subscription Term – Fixed Day of Month
sub_count Type:
Number
Title:
Subscription Count
Subscription Count
sub_count Type:
Number
Title:
Subscription Count
Subscription Count
options
+ Show Properties
Type:
Object
Title:
Options
Options
subscrp_id Type:
Number
Title:
Subscription ID
Subscription ID
templ_code Type:
String
Title:
Template Code
Template Code
attr_code Type:
String
Title:
Attribute Code
Attribute Code
value Type:
String
Title:
Value
Value
charges
+ Show Properties
Type:
Object
Title:
Charges
Charges
order_id Type:
Number
Title:
Order ID
Order ID
charge_id Type:
Number
Title:
Charge ID
Charge ID
module_id Type:
Number
Title:
Module ID
Module ID
type Type:
String
Title:
Type
Charge Type. Charge types include (but not limited to): "TAX", "SHIPPING" , "DISCOUNT", "HANDLING". Its possible for custom charge types to exist.
descrip Type:
String
Title:
Description
Description
amount Type:
Number
Title:
Amount
Amount
disp_amt Type:
Number
Title:
Display Amount
Display Amount
tax_exempt Type:
Number
Title:
Tax Exempt
Tax Exempt
coupons
+ Show Properties
Type:
Object
Title:
Coupons
Coupons
order_id Type:
Number
Title:
Order ID
Order ID
coupon_id Type:
Number
Title:
Coupon Id
Coupon Id
code Type:
String
Title:
Code
Code
descrip Type:
String
Title:
Description
Description
total Type:
Number
Title:
Total
Total
discounts
+ Show Properties
Type:
Object
Title:
Discounts
Discounts
order_id Type:
Number
Title:
Order ID
Order ID
pgrp_id Type:
Number
Title:
Price Group Id
Price Group Id
name Type:
String
Title:
Name
Name
descrip Type:
String
Title:
Description
Description
total Type:
Number
Title:
Total
Total
payments
+ Show Properties
Type:
Object
Title:
Payments
Payments
id Type:
Number
Title:
Payment Id
Payment Id
order_id Type:
Number
Title:
Order Id
Order Id
type Type:
Number
Title:
Payment Type
Payment Type. 0 = declined, 1 = Legacy Authorization, 2 = Legacy Capture, 3 = Authorization, 4 = Capture, 5 = Auuthorization + Capture, 6 = Refund, 7 = VOID
refnum Type:
String
Title:
Reference Number
Reference Number. This value is typically the authization code or unique payment reference number.
amount Type:
Number
Title:
Amount
Amount
fornatted_amount Type:
String
Title:
Formatted Amount
Formatted Amount
available Type:
Number
Title:
Available
Amount Available For Capture
formatted_available Type:
String
Title:
Formatted Available
Formatted Amount Available For Capture
dtstamp Type:
Unix timestamp
Title:
Date Time Stamp
The unix time of the payment transaction occured
expires Type:
Number
Title:
Expires
Expires
pay_id Type:
Number
Title:
Payment Module Id
id of the payemnt module used to take payment
pay_secid Type:
Number
Title:
Payment Encryption Passphrase Id
id of the payment encryption key used to encrypt payment data
decrypt_status Type:
String
Title:
Dectyption Status
One of two values: "decrypted" or "not_decrypted"
decrypt_error Type:
String
Title:
Dectyption Error
Only present if decryption error occured. Contains error message if field to decrypt payment.
description Type:
String
Title:
Description
This typically contains the card type.
module
+ Show Properties
Type:
Object
Title:
Payment Module
Details on the payment module which created the payment record.
id Type:
Number
Title:
Module Id
Module Id
code Type:
String
Title:
Module Code
Module Code
name Type:
String
Title:
Module Name
Module Name
provider Type:
String
Title:
Module Provide
Developer/Company who created the module
api_ver Type:
Number
Title:
API Version
Module API Version module is using
version Type:
String
Title:
Version
Module Version
module Type:
String
Title:
Module Path
relative path to module file on the server
refcount Type:
Number
Title:
Reference Count
Number of Stores Payment module is installed on
active Type:
Boolean
Title:
Active
Boolean flag for active
data Type:
Object
Title:
Payment Data
Only present if "payment_data" is passed in ondemandcolumns. Object containing payment fields retruned back from gateway/payment provider. Will vary based on payment module being used.
notes
+ Show Properties
Type:
Object
Title:
Notes
Notes
id Type:
Number
Title:
Note Id
Note Id
cust_id Type:
Number
Title:
Customer Id
Customer Id
account_id Type:
Number
Title:
Business Account Id
Business Account Id
order_id Type:
String
Title:
Order Id
Order Id
user_id Type:
Number
Title:
User Id
The Admin User Id who created the note.
notetext Type:
String
Title:
Note Text
Note Text
cust_login Type:
String
Title:
Customer Login
Login for the customer attached to the note
business_title Type:
String
Title:
Business Accout Name
Business Accout Name
admin_user Type:
String
Title:
Admin User
The admin username who created the note
CustomField_Values Type:
Object
Title:
Custom Field Values
Array of custom field modules. Each module will have its own children of name/value pairs for order custom fields.

Example Requests

Request containing a search filter

Example Response

This website uses cookies to identify visitors, track visitors to our website, store login session information and to remember your user preferences. By continuing to use this site you agree to our use of cookies. Learn More.

This website uses cookies. By continuing to use this site you agree to our use of cookies. Learn More.

Accept

Copyright © 1997 – 2023 Miva©, Miva Merchant©, MivaPay©, MivaCon©, Camp Miva ℠, Miva, Inc. All Rights Reserved.