Support

Query `skus` on the catalog subgraph (SKU).

query

Requires commerce.product:read.

Query skus on the catalog subgraph (SKU).

Required headers

HeaderRequiredDescription
x-store-idYesID 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

  • after String optional
  • attributeValues SKUAttributeValueFilter optional
    • has [String!] optional
  • before String optional
  • code SKUCodeFilter optional
    • contains String optional — Filters SKUs where the code contains the specified string, case-insensitive.
    • eq String optional
    • in [String!] optional — Filters SKUs where the code matches any of the specified codes.
  • createdAt CreatedAtFilter optional
    • gt String optional
    • lt String optional
  • eanCode SKUEanCodeFilter optional
    • eq String optional
    • in [String!] optional
  • first Int optional
  • gtinCode SKUGtinCodeFilter optional
    • eq String optional
    • in [String!] optional
  • id SKUIdsFilter optional
    • in [String!] optional
  • isbnCode SKUIsbnCodeFilter optional
    • eq String optional
    • in [String!] optional
  • label LabelFilter optional
    • contains String optional — Filters items where the label contains the specified string, case-insensitive.
    • eq String optional
  • last Int optional
  • locationId LocationIdFilter optional
    • eq String optional
  • name NameFilter optional
    • contains String optional — Filters items where the name contains the specified string, case-insensitive.
    • eq String optional
    • in [String!] optional — Filters items where the name matches any of the specified names.
  • orderBy SKUOrderBy optional
    • createdAt OrderByDirectionEnum optional
    • id OrderByDirectionEnum optional
    • label OrderByDirectionEnum optional
    • name OrderByDirectionEnum optional
    • price OrderByDirectionEnum optional
    • updatedAt OrderByDirectionEnum optional
  • paginationType PaginationType optional Default: "CURSOR".
  • queryFilter String optional — A string filter in the ODATA format. ex: "label eq 'shirt' and contains(code, '123')". Supported columns: label, code Supported operators: eq, ne, lt, gt, and, or Supported functions: contains
  • referenceValue ReferenceValueFilter optional
    • eq String optional
    • in [String!] optional
  • skuGroupId SKUGroupIdFilter optional
    • eq String optional
    • in [String!] optional
  • skuGroupStatus SKUGroupStatusFilter optional — Filter SKUs by their SKU group's status. SKUs without a SKU group will be excluded when this filter is present.
    • eq String optional
    • in [String!] optional
  • status SKUStatusFilter optional
    • eq String optional
    • in [String!] optional
  • upcCode SKUUpcCodeFilter optional
    • eq String optional
    • in [String!] optional
  • updatedAt UpdatedAtFilter optional
    • gt String optional
    • lt String optional

Possible returns

  • QuerySkusConnection QuerySkusConnection

Last updated on

How is this guide?