Orders: List Orders

GET /websites/:website_id/orders

Gets a list of orders.

Attribute Details
website_id
Required integer

The ID of the website the order originated from.
count
integer

Maximum number of orders to return. Value can be between 1 and 100. Default is 100.
date_end
date

Only return orders that were created before this date. The date should be specified in the YYYY-MM-DD format (e.g., 2018-01-01).
date_start
date

Only return orders that were created after this date. The date should be specified in the YYYY-MM-DD format (e.g., 2018-01-01).
direction
string

Return orders sorted in ascending or descending order. Valid options are asc and desc. Default is desc.
includes
string

Comma separated list of additional fields to include in the response. Available includes are additional_information, billing_address, items, items.attributes, items.portal, items.print_ready_files, message, notes, payment_transactions, portal, promo_code, shipments, shipments.shipping_address, shipments.shipping_carrier, shipments.shipping_method, and user.
page
integer
The page number of results to return. Defaults to page 1.
search
string

Search for messages that match the provided search string. Searches the message.message_tracking_number and user.username fields.
sort
string

The field to sort the orders by. Possible values are date_created, message.message_tracking_number, and user.username.
status
string

Only returns orders that have the provided status. Possible values are pending_approval, new, denied, processing, canceled, backordered, shipped, and completed.