Get orders

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Retailer ID

Retailer order number

Tags used for categorization. Multiple values may be added, separated by commas.

Meta data. Multiple values may be added, separated by commas.

Metadata values

Shipping methods (names). Multiple values may be added, separated by comma

Purchase order number

Customer order number

Retailer order number

Search by purchase order number, customer order number or retailer order number

Variant IDs. Multiple values may be separated by commas.

Variant SKUs. Multiple values may be added, separated by commas.

Retailer categories. Multiple values may be separated by commas.

Retailer category IDs. Multiple values may be separated by commas.

Status of the order such as pending, new, creating_shipments, ship, invoice, creating_invoices, on_hold, closed, shipping_errors, and invoice_errors. Multiple values may be separated by commas.

Order status such as open, closed partial, *pending and cancelled.

Shipment status such as open, closed, partial, *pending, and cancelled

Order line status

1: Order is a gift <br /> 0: Order is not a gift

1: Order is a replacement <br /> 0: Order is not a replacement

1: Product is backordered <br /> 0: Product is not backordered

1: Shipment is acknowledged <br /> 0: Shipment is not acknowledged

1: Cancellation is acknowledged <br /> 0: Cancellation is not acknowledged

1: Invoice is acknowledged <br /> 0: Invoice is not acknowledged

1: RMA is acknowledged <br /> 0: RMA is not acknowledged

1: Backorder is acknowledged <br /> 0: Backorder is not acknowledged

1: Order has shipments <br /> 0: Order does not have shipments

1: Order has cancellation <br /> 0: Order does not have cancellation

1: Order has invoices <br /> 0: Order does not have invoices

1: Order has RMA <br /> 0: Order does not have RMA

1: Order is not fully shipped <br /> 0: Order is fully shipped

1: Order is not fully invoiced <br /> 0: Order is fully invoiced

Cancellation acknowledgement date is greater than specified Time (Unix epoch format)

Cancellation acknowledgement date is greater than or equal to specified Time (Unix epoch format)

Cancellation acknowledgement date is less than specified Time (Unix epoch format)

Cancellation acknowledgement date is less than or equal to specified Time (Unix epoch format)

Backordered date is greater than specified Time (Unix epoch format)

Backordered date is greater than or equal to specified Time (Unix epoch format)

Backordered date is less than specified Time (Unix epoch format)

Backordered date is less than or equal to specified Time (Unix epoch format)

Memos creation date is greater than or equal to specified Time (Unix epoch format)

Past date till the current time (Unix epoch format)

Batch ID of order. Multiple values may be separated by commas.

Vendor IDs. Multiple values may be separated by commas.

Retailer ID. Multiple values may be separated by commas.

Connection ID. Multiple values may be separated by commas.Connection ID

Sorting preference

Page number of the paginated response

Number of results per page

Total number of records

Next page (applicable in a paginated response)

Previous page (applicable in a paginated response)