Organization / Orders

orders

List orders

Arguments

afterString

A cursor after which elements are returned.

beforeString

A cursor before which elements are returned.

firstInt

Limits number of fetched items. Maximum allowed value: 250.

lastInt

Limits number of fetched items. Maximum allowed value: 250.

queryString

Search and filter expression for orders. A filter made up of field terms, connectives, modifiers, and comparators. You can apply one or more filters to a query.

Supported filters
referencestringAny value
searchstringAny value
exceptionboolAny value
brand.iduuidAny value
customer.iduuidAny value
recipient_address.country_codestringAny value
statusenum
CANCELED
Canceled, or every ordered quantity was reduced to zero.
CREATED
New order that has not been allocated yet.
EXPECTED
Awaiting payment; stock is not allocated until the order is paid.
ALLOCATED
Stock is reserved for all quantity not shipped yet, also when the order is partly shipped.
PARTIALLY_SHIPPED
Partly shipped, and part of the remaining quantity has no stock reserved.
SHIPPED
UNALLOCATED
Nothing shipped yet, and part of the quantity has no stock reserved (backorder).
created_atdatetimeAny value
shipped_atdatetimeAny value
reverseBoolean!Default: false

Reverse the order of the underlying list.

sortKeyOrdersSortKeyDefault: ID

Sort the underlying list using a key.

CREATED_ATIDSHIPPED_AT

Returns

cursorString!

A unique cursor that can be used for pagination.

endCursorString

The cursor to continue paginating forwards.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.