options
View as MarkdownQuery `options` on the catalog subgraph (Option).
query
Requires commerce.product:read.
Query options on the catalog subgraph (Option).
Required headers
| Header | Required | Description |
|---|---|---|
x-store-id | Yes | ID of the store the operation targets. Omitting it returns HTTP 200 with a GraphQL error: extensions.code: "UNAUTHENTICATED". |
Go to Authentication for credential setup.
Arguments
afterStringoptionalassignableToSkuGroupIdStringoptional — Returns shareable options that are not already associated with the specified SKU group. Use this to find options that can be added to a SKU group. Cannot be combined with skuGroupId or skuGroupStatus filters.beforeStringoptionalcreatedAtCreatedAtFilteroptionalgtStringoptionalltStringoptional
firstIntoptionalidOptionIdsFilteroptionalin[String!]optional
labelLabelFilteroptionalcontainsStringoptional — Filters items where the label contains the specified string, case-insensitive.eqStringoptional
lastIntoptionalnameNameFilteroptionalcontainsStringoptional — Filters items where the name contains the specified string, case-insensitive.eqStringoptionalin[String!]optional — Filters items where the name matches any of the specified names.
orderByOptionOrderByoptionalcreatedAtOrderByDirectionEnumoptionalidOrderByDirectionEnumoptionallabelOrderByDirectionEnumoptionalnameOrderByDirectionEnumoptionalpositionOrderByDirectionEnumoptionalpriceOrderByDirectionEnumoptionalupdatedAtOrderByDirectionEnumoptional
paginationTypePaginationTypeoptional Default:"CURSOR".shareableBooleanoptional — Filter options by their shareable status. When true, returns only shareable options; when false, returns only non-shareable options.skuGroupIdSKUGroupIdFilteroptionaleqStringoptionalin[String!]optional
skuGroupStatusSKUGroupStatusFilteroptionaleqStringoptionalin[String!]optional
updatedAtUpdatedAtFilteroptionalgtStringoptionalltStringoptional
Possible returns
QueryOptionsConnectionQueryOptionsConnection
Last updated on
How is this guide?