CombinedListing
Describes a combined listing.
Type Definition
type CombinedListing {
options: [String]
optionsWithValues: [ProductOption]
optionsByHandle: [ProductOption]
}
Fields
Field | Type | Nullable | Description | Relationship |
---|---|---|---|---|
options | [String] | Yes | Returns the options handles. | None |
optionsWithValues | [ProductOption] | Yes | Returns array of options with values. | Related to ProductOption |
optionsByHandle | [ProductOption] | Yes | Returns array of options indexed by handle. | Related to ProductOption |
Relationships
optionsWithValues
andoptionsByHandle
fields return arrays of theProductOption
object type, representing detailed option data associated with the combined listing.- The
options
field returns a list of option handles as strings, which can be used to reference or filter options externally. - The
CombinedListing
type is used within theProduct
object as thecombinedListing
field, linking product data to its combined listing options.
Usage Examples
Basic Query
{
combinedListing {
options
optionsWithValues {
id
name
values
}
optionsByHandle {
handle
name
values
}
}
}
Field Selection
{
combinedListing {
options
}
}
{
combinedListing {
optionsWithValues {
name
values
}
}
}
Nested Queries
{
product(id: 12345) {
combinedListing {
optionsByHandle {
handle
name
values
}
}
}
}
Filtering and Sorting
The CombinedListing
type itself does not support direct filtering, sorting, or pagination on its fields. To filter or sort options, perform these operations on the parent Product
or ProductOption
types where applicable.
Implements
This type does not implement any interfaces.
Connections
No connection fields are defined on CombinedListing
.
Related Types
String
: Scalar type used for option handles.ProductOption
: Object type representing detailed product option data, including fields likeid
,name
,handle
, andvalues
.
Best Practices
- When querying
optionsWithValues
oroptionsByHandle
, select only the fields you need to optimize query performance. - Use the
options
field when you only require option handles for lightweight queries. - To traverse from a product to its combined listing options, query the
combinedListing
field on theProduct
object. - Since
optionsByHandle
returns options indexed by handle, it is useful for quickly accessing specific options by their unique handle.
Notes
- The API currently requires no authentication; however, this may change in future versions.
- The
CombinedListing
type fields are optional and may returnnull
if no combined listing data is available for a product. - There are no computed or derived fields on this type.
- No field arguments are defined for
CombinedListing
. - For complex filtering, sorting, or pagination, use the parent or related types such as
Product
orProductOption
. - Keep in mind that querying nested fields like
optionsWithValues
oroptionsByHandle
may increase response size and affect performance; select fields judiciously.
Last updated on