List Orders

limit

integer

The maximum number of orders to return. Default is 10.

offset

integer

The number of orders to skip before starting to return results. Default is 0.

sort

string

The field to sort the results by. Can be ‘created_date’, ‘updated_date’, ‘order_number’, etc. Default is ‘created_date’.

order

string

The order of sorting. Can be ‘asc’ or ‘desc’. Default is ‘desc’.

status

string

Filter orders by status.

customer_email

string

Filter orders by customer email.

from_date

string

Filter orders created on or after this date (format: YYYY-MM-DD).

to_date

string

Filter orders created on or before this date (format: YYYY-MM-DD).

orders

array

An array of order objects.

id

string

This is the id of the order.

name

string

This is the name of the order.

order_number

string

This is the order number.

created_date

string

This is the date the order was created.

updated_date

string

This is the date the order was last updated.

order_status

string

This is the status of the order.

imported_status

string

This is the imported status of the order.

delivery_date

string

This is the delivery date of the order.

ordered_by

string

This is the person who ordered.

delivery_address

string

This is the delivery address for the order.

notes

string

These are additional notes for the order.

imported_date

string

This is the date the order was imported.

customer_number

string

This is the customer number associated with the order.

customer_name

string

This is the name of the customer.

import

boolean

This indicates if the order was imported.

customer_email

string

This is the email of the customer.

source

string

This is the source of the order.

buyer_email

string

This is the email of the buyer.

buyer_message

string

This is a message from the buyer.

cancel_order_sla_time

string

This is the SLA time for cancelling the order.

cancel_reason

string

This is the reason for cancellation, if applicable.

cancellation_initiator

string

This is who initiated the cancellation, if applicable.

fulfillment_type

string

This is the type of fulfillment for the order.

delivery_type

string

This is the type of delivery for the order.

is_cod

boolean

This indicates if the order is cash on delivery.

is_replacement_order

boolean

This indicates if this is a replacement order.

seller_note

string

This is a note from the seller.

status

string

This is the current status of the order.

tracking_number

string

This is the tracking number for the order.

warehouse_id

string

This is the id of the warehouse handling the order.

order_line_items

array

These are the line items associated with the order.

total_count

integer

The total number of orders matching the query parameters.

Query Parameters

Response

​Query Parameters

​Response

Query Parameters

Response