⌘K
Get Orders
Fetch orders created by the API integration.
Parameters
allOrders
boolean
Whether or not to query all orders or only orders created by the API integration.
limit
number
Required
Number of results to return in each paginated query.
maxDate
string
Filter by the maximum created date of orders.
minDate
string
Filter by the minimum created date of orders.
name
string
Filter by
name or orderId of the order.offset
number
Offset for pagination.
sortDirection
enum
Sort direction for orders based on
createdAt date. Defaults to descending.Possible enum values
ascdescstatuses
array of enums
Filter by the statuses of the order.
Possible enum values
PendingFulfillmentActionThe order requires user action before it can be sent to production.
AwaitingPaymentThe order has been received by Artelo but is not yet paid for in the connected integration.
ReceivedThe order is received and is waiting to be sent to production. This period is to allow for cancellations to take place before production begins.
PaidThe order has been paid for but has not yet been sent to production.
WarehouseProcessingThe production facility is currently processing the order.
ShippedThe order has been shipped.
CanceledThe order was canceled.
Show more values
Returns
The
Order objects matching the supplied filters.GET
/orders/get
cURL
Response