Skip to main content

OrderingQuery.draftOrders()

Retrieves a paginated list of draft orders. Can optionally filter by a search term.
type OrderingQuery {
  draftOrders(searchTerm: String, first: Int = 10, offset: Int = 0): OrderingDraftOrdersConnection!
}

Input

searchTerm

string | undefined - An optional search term to filter draft orders.

first

number - The number of draft orders to return. Defaults to 10.

offset

number - The number of draft orders to skip before returning results. Defaults to 0.

Response

OrderingDraftOrdersConnection

type OrderingDraftOrdersConnection {
  edges: [OrderingDraftOrdersEdge!]!
}

edges

OrderingDraftOrdersEdge[] - An array of draft order edges.

OrderingDraftOrdersEdge

type OrderingDraftOrdersEdge {
  node: OrderingDraftOrder!
}

node

OrderingDraftOrder - The draft order.