Get orders

Gets a list of orders.

Authorizations

Authorization

string

headerrequired

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

Path Parameters

retailer_pk

string

required

Retailer ID

Query Parameters

retailer_order_num

string

Retailer order number

tags

string[]

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

metadata

string[]

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

metadata_value

string

Metadata values

generic_shipping_method

string[]

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

purchase_order_number

string

Purchase order number

customer_order_number

string

Customer order number

retailer_order_number

string

Retailer order number

search_order_number

string

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

variant_id

number[]

Variant IDs. Multiple values may be separated by commas.

variant_identifier

string[]

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

retailer_category

string[]

Retailer categories. Multiple values may be separated by commas.

retailer_category_id

number[]

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

workflow

string[]

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.

status

string

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

shipment_status

string

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

orderline_status

string

Order line status

is_gift

number

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

is_replacement

number

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

is_backordered

number

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

shipment_is_acknowledged

number

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

cancel_is_acknowledged

number

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

invoice_is_acknowledged

number

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

rma_is_acknowledged

number

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

backorder_is_acknowledged

number

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

has_shipments

number

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

has_cancels

number

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

has_invoices

number

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

has_rmas

number

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

not_fully_shipped

number

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

not_fully_invoiced

number

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

cancel_acknowledged_at_gt

number

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

cancel_acknowledged_at_gte

number

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

cancel_acknowledged_at_lt

number

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

cancel_acknowledged_at_lte

number

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

backordered_until_gt

number

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

backordered_until_gte

number

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

backordered_until_lt

number

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

backordered_until_lte

number

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

memos_created_at_gte

number

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

since

number

Past date till the current time (Unix epoch format)

order_batch_id

number[]

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

brand_id

number[]

Vendor IDs. Multiple values may be separated by commas.

retailer_id

number[]

Retailer ID. Multiple values may be separated by commas.

connection_id

number[]

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

order_by

string

Sorting preference

page

integer

Page number of the paginated response

limit

integer

Number of results per page

Response

200 - application/json

count

integer

required

Total number of records

results

object[]

required

Show child attributes

next

string | null

Next page (applicable in a paginated response)

previous

string | null

Previous page (applicable in a paginated response)