Skip to main content

BundleSearchInput

Search criteria for filtering and retrieving bundles.

Provides comprehensive filtering options including bundle IDs, product associations, pagination, and sorting capabilities.

input BundleSearchInput {
  ids: [String!]
  productIds: [Int!]
  taxZone: String
  page: Int!
  offset: Int!
  sortInputs: [BundleSortInput!]
}

Fields​

BundleSearchInput.ids ● [String!] list scalar​

Specific bundle identifiers to filter search results.

When provided, only bundles with these exact IDs will be included in the search results. Each ID must be a valid UUID format. Validation ensures proper UUID format for each entry.

BundleSearchInput.productIds ● [Int!] list scalar​

Product identifiers to search for within bundles.

Returns bundles that contain any of the specified products, useful for finding cross-selling opportunities and product associations. Each ID must be a positive integer. Validation ensures unique values and proper integer format.

BundleSearchInput.taxZone ● String scalar​

Geographic tax zone for pricing calculations.

Determines which tax rates and rules apply to bundle pricing in the search results. Must be exactly 2 characters representing a country code.

BundleSearchInput.page ● Int! non-null scalar​

Page number for pagination, starting from 1.

Used to navigate through multiple pages of results when the total number of bundles exceeds the offset limit. Must be at least 1. Validation ensures positive integer values.

BundleSearchInput.offset ● Int! non-null scalar​

Number of bundles to return per page.

Controls the size of each page in the paginated response to manage data volume and performance. Must be between 1 and 100. Validation ensures values within the acceptable range.

BundleSearchInput.sortInputs ● [BundleSortInput!] list input​

Sorting criteria for search results.

Specify multiple sort fields with their respective order to control how results are organized and presented. Each sort input must be unique. Validation ensures proper structure and uniqueness of sort criteria.

Member Of​

bundles query