Skip to main content

orders

Search and retrieve orders with comprehensive filtering and pagination capabilities.

Provides flexible search across order data including customer information, order status, financial details, date ranges, and product information. Results are paginated and can be filtered based on various business criteria to support operational workflows and customer service needs.

Possible errors:

  • ORDER_FETCH_ERROR: Failed to retrieve orders due to system error
  • ORDERS_LIST_ERROR: Error occurred during order list processing
  • FORBIDDEN: Insufficient permissions to access orders
  • VALIDATION_ERROR: Invalid search parameters provided

AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER] OR (('user is authenticated') AND ('userId if present in input matches JWT' AND 'companyId(s) if present in input matches JWT'))

orders(
input: OrderSearchArguments
): OrderResponse!

Arguments

orders.input ● OrderSearchArguments input

Search criteria and pagination parameters for filtering orders.

All fields are optional - if no criteria provided, returns all accessible orders with default pagination settings.

Type

OrderResponse object