OrderCriteria

Overview

The OrderCriteria object contains parameters you can use to query order data.

Fields

OrderCreationFilterBeginTimeGMT
OrderCreationFilterEndTimeGMT
StatusUpdateFilterBeginTimeGMT
StatusUpdateFilterEndTimeGMT
DetailLevel
OrderIDList
OrderStateFilter
PaymentStatusFilter
CheckoutStatusFilter
ShippingStatusFilter
PageNumberFilter
PageSize

Field Name	Data Type	Description
OrderCreationFilterBeginTimeGMT	date	Only return orders created on or after this date and time.
OrderCreationFilterEndTimeGMT	date	Only return orders created on or before this date and time.
StatusUpdateFilterBeginTimeGMT	date	Only return orders whose status was set after this date and time.
StatusUpdateFilterEndTimeGMT	date	Only return orders whose status was set before this date and time.
DetailLevel	DetailLevelType	Enumerated string value. To conserve system resources, the value chosen here will affects the PageSize you can request below. Acceptable Values: Low Medium High Complete These values control how much data is returned by each order-related function which uses this object to filter its results. Callers are strongly encouraged to use the lowest acceptable detail-level required to retrieve their necessary data.
ExportState	ExportStateType	Users can call GetOrderList and request only orders that have not been exported as part of their filter critieria. Acceptable Values: Unknown NotExported - what most people will want to use. get orders not yet marked exported through the API.
OrderIDList	int[]	Only return orders matching this list of Order IDs
OrderStateFilter	OrderStateCode	Enumerated value. Acceptable Values: Active - regardless of cancelled status. Check OrderState in the returned order to see if it is a Cancelled order. For example: if (order.OrderState == ShippingAPIHarness.localhost.OrderStateCode.Cancelled) {// Handle cancelled order} Archived - regardless of cancelled status. See notes above. Cancelled - Cancelled Orders only
PaymentStatusFilter	PaymentStatusCode	Enumerated value. Acceptable Values: NoChange Not Submitted Cleared Submitted Failed Deposited: Check has deposited but not cleared. Credit card has been authorized but not charged.
CheckoutStatusFilter	CheckoutStatusCode	Enumerated value. Acceptable Values: NoChange Not Visited Completed Visited Cancelled CompletedOffline OnHold
ShippingStatusFilter	ShippingStatusCode	Enumerated value. Acceptable Values: NoChange Unshipped Shipped PartiallyShipped
PageNumberFilter	int	Which page of results to return. To begin, use the value 1. To request additional pages of data, increase this value by 1 each time you call this method to request an additional set of data.
PageSize	int	Number of results to return per page. Based on the DetailLevel, only certain numbers of items can be returned. DetailLevel = Low allows retrieving up to 200 orders at a time. DetailLevel = Medium allows retrieving up to 100 orders at a time. DetailLevel = High allows retrieving up to 50 orders at a time. DetailLevel = Complete allows retrieving up to 20 orders at a time.

Tips

To retrieve all unpaid orders, use the following values for criteria fields: OrderStateFilter = Active and PaymentStatusFilter = NotSubmitted.
To mark an order as exported after downloading it, call this method:
http://developer.channeladvisor.com/display/cadn/SetOrdersExportStatus

API Documentation

Solutions Directory

General Topics

Resources

Page Operations

Browse Space

Overview

Fields

Tips

References