Skip to main content

orderlists

Search and retrieve order lists with comprehensive filtering, sorting, and pagination capabilities.

Provides flexible search functionality across all order list data including descriptions, codes, product assignments, user permissions, company associations, and metadata. Results are automatically filtered based on user permissions and organizational access rights.

Search capabilities include:

  • Text-based filtering on descriptions and codes
  • Date range filtering for creation and modification dates
  • Product and cluster association filtering
  • User and company assignment filtering
  • Status and type filtering
  • Multi-field sorting with customizable directions

Results are paginated for performance and include comprehensive metadata about the search operation.

Possible errors:

  • ORDERLIST_CROSS_SERVICE_ERROR: Failed to validate search criteria against external services
  • ORDERLIST_VALIDATION_ERROR: Invalid search parameters or criteria
  • ORDERLIST_UKNOWN_ERROR: Unexpected system error during search operation
  • FORBIDDEN: Insufficient permissions to access order list data

AUTH: Role=[shop.OWNER,shop.EDITOR,shop.VIEWER] OR ('user is authenticated')

orderlists(
input: OrderlistSearchInput
): OrderlistsResponse!

Arguments

orderlists.input ● OrderlistSearchInput input

Search and filtering criteria for order list retrieval.

Comprehensive input object that supports filtering by multiple criteria including:

  • Pagination settings (page, offset)
  • Date range filters (creation, modification, validity dates)
  • Text filters (codes, descriptions)
  • Association filters (products, clusters, users, companies)
  • Status filters (active/inactive, type)
  • Sorting options (multiple fields with directions)

If not provided, returns all accessible order lists with default pagination settings (page 1, 12 items per page). All filters are optional and can be combined for precise result sets.

Validation: All provided criteria must be valid according to their respective field requirements.

Type

OrderlistsResponse object