Skip to main content
Anchor to CollectionSubCollectionEligibilityState

CollectionSubCollectionEligibilityState

object

Requires read_products access scope.

Whether a collection is eligible for one role (inclusion or exclusion) in a sub-collection relationship, plus the reason it isn't if applicable.

•Boolean!
non-null

Whether the collection can be used in this sub-collection role.

•SubCollectionIneligibleReason

Stable identifier describing why the collection is ineligible. Null when eligible is true. Clients can map this to user-facing copy or use it as a feature flag.


Was this section helpful?