GraphQL API
Organization API
Organization / Orders

orders

List orders

Arguments

7 arguments
after•String

A cursor after which elements are returned.

before•String

A cursor before which elements are returned.

first•Int

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

last•Int

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

query•String

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
referencestring
Any value
searchstring
Any value
exceptionbool
Any value
brand.iduuid
Any value
customer.iduuid
Any value
recipient_address.country_codestring
Any value
statusenum
CANCELEDCREATEDEXPECTEDALLOCATEDPARTIALLY_SHIPPEDSHIPPEDUNALLOCATED
created_atdatetime
Any value
shipped_atdatetime
Any value
reverse•Boolean!Default: false

Reverse the order of the underlying list.

sortKey•OrdersSortKeyDefault: ID

Sort the underlying list using a key.

CREATED_ATIDSHIPPED_AT

Possible return

cursor•String!

A unique cursor that can be used for pagination.

endCursor•String

The cursor to continue paginating forwards.

hasNextPage•Boolean!

When paginating forwards, are there more items?

hasPreviousPage•Boolean!

When paginating backwards, are there more items?

startCursor•String

The cursor to continue paginating backwards.