CombinedListing

Describes a combined listing.

Type Definition

type CombinedListing {
  options: [String]
  optionsWithValues: [ProductOption]
  optionsByHandle: [ProductOption]
}

Fields

Relationships

• optionsWithValues and optionsByHandle fields return arrays of the ProductOption 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 the Product object as the combinedListing 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 like id, name, handle, and values.

Best Practices

• When querying optionsWithValues or optionsByHandle, 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 the Product 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 return null 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 or ProductOption.
• Keep in mind that querying nested fields like optionsWithValues or optionsByHandle may increase response size and affect performance; select fields judiciously.