Choose a version:

CollectionSource

interface

Requires read_products access scope.

A source that provides products for a collection.

Anchor to FieldsFields

Anchor to appapp •App: The app that created this source, if applicable. In the case of shareable sources, this app manages this source's conditions and selections exclusively.
Anchor to descriptiondescription •String: An optional description of the source.
Anchor to idid •ID! non-null: The unique identifier for this source.
Anchor to titletitle •String! non-null: The title of the source.

Was this section helpful?

Anchor to Types implemented inTypes implemented in

Anchor to CollectionConditionsSource CollectionConditionsSource

•OBJECT

A collection source that uses conditions and selections to determine which products are included.

Anchor to appapp

•App

The app that created this source, if applicable. In the case of shareable sources, this app manages this source's conditions and selections exclusively.

Anchor to descriptiondescription

•String

An optional description of the source.

Anchor to idid

•ID!

non-null

The unique identifier for this source.

Anchor to inclusioninclusion

•CollectionSourceInclusion!

non-null

The rules and selections for including products in the collection.

Anchor to productsproducts

•ProductConnection!

non-null

The products that are members of this source: products matched by the source's inclusion conditions and manual selections, with the source's exclusion conditions, excluded collections, and manual exclusions removed.

Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to shareableshareable

•Boolean!

non-null

Whether this source can be shared across multiple collections.

Anchor to targetTypetargetType

•CollectionSourceTargetType!

non-null

Whether conditions match products or individual variants.

Anchor to titletitle

•String!

non-null

The title of the source.

Anchor to CollectionSubCollectionSource CollectionSubCollectionSource

•OBJECT

A collection source whose membership comes from a single referenced collection (sub-collection).

Sub-collection sources are always non-shareable: the inherited shareable field on the CollectionSource interface always resolves to false for this type. Sharing a sub-collection source across owners is not supported because the chain reference is owner-bound.

Anchor to appapp •App: The app that created this source, if applicable. In the case of shareable sources, this app manages this source's conditions and selections exclusively.
Anchor to descriptiondescription •String: An optional description of the source.
Anchor to idid •ID! non-null: The unique identifier for this source.
Anchor to subCollectionsubCollection •Collection! non-null: The single referenced sub-collection that supplies products to this source.
Anchor to titletitle •String! non-null: The title of the source.

Was this section helpful?

{

"app": "",

"description": "",

"id": "",

"title": ""

}

Anchor to FieldsFields

Anchor to Types implemented inTypes implemented in

Arguments