Skip to content

Schema and types

Root fields, inputs, enums, objects and limits of the Storefront GraphQL schema.

The schema has one Query root. There are no mutations or subscriptions.

Conventions

  • ! marks a non-null value. An argument without ! can be omitted or sent as null.
  • IDs are opaque String values, even when they look numeric.
  • Decimal holds amounts and measurements.
  • DateTime is an ISO 8601 date and time.

Query

FieldSignatureReturns
storestoreStorefrontStore!
productsproducts(input: StorefrontProductsInput)SearchResult!
productproduct(slug: String!)ProductDetail!
relatedProductsrelatedProducts(productId: String!, limit: Int)[ProductSummary!]!
collectionscollections(search: String, sort: NavigationSearchSort, limit: Int)[CollectionItem!]
collectioncollection(slug: String!)CollectionItem!
sellerssellers[StorefrontSellerDto!]!
sellerseller(slug: String!)StorefrontSellerProfileDto!
productReviewsproductReviews(productId: String!, limit: Int, cursor: String, search: String, sortBy: String, sortDirection: SortDirection, rating: Int)CursorPaginatedItemsOfStorefrontReviewDto!
storeReviewsstoreReviews(limit: Int, minRating: Int)[StorefrontStoreReviewDto!]!
paymentMethodspaymentMethods[StorefrontPaymentMethodDto!]!
articlesarticles(search: String, folder: String, tag: String, limit: Int)[CmsArticlePublicSummaryDto!]!

StorefrontProductsInput

FieldTypeDefault and limits
includeFiltersBooleantrue. With false, filters comes back empty.
productIds[String!]Up to 100 IDs.
slugs[String!]Up to 100 slugs of up to 255 characters.
searchStringFree text.
categories[String!]Category names.
brands[String!]Brand names.
sellerSlugs[String!]Seller slugs.
collections[String!]Collection slugs.
collectionIdStringA collection ID.
productTypes[ProductType!]Product types.
tags[String!]Tags.
filters[String!]Up to 100 filters of up to 250 characters.
inStockBooleanNo filter.
minPriceDecimalNo minimum.
maxPriceDecimalNo maximum.
pageInt1; 1 to 100.
pageSizeInt24; 1 to 100.
sortProductSearchSortDEFAULT.

Facet filters take the form option:name:value or attribute:name:value. The combination rules are in products.

Enums

EnumValues
StoreTypeB2C, MARKETPLACE, RETAIL, B2B, SOCIAL, HUB, RESTAURANT
ProductTypePRODUCT, SERVICE, BUNDLE
ProductSearchSortDEFAULT, PRICE_ASC, PRICE_DESC, NEWEST, NAME_ASC, NAME_DESC, OLDEST, BEST_SELLING
NavigationSearchSortDEFAULT, NAME_ASC, NAME_DESC, ORDER_ASC, ORDER_DESC, NEWEST, UPDATED_DESC
SortDirectionASC, DESC
SellerLinkStyleICONS, TEXT
  • ProductSearchSort sorts products and CollectionItem.products. In CollectionItem.products, no sort or DEFAULT uses the collection's own order, including manual order.
  • In collections, ORDER_ASC and ORDER_DESC sort by name ascending.
  • SortDirection goes with sortBy in productReviews and ProductSummary.reviews. Without a direction, createdOn sorts DESC and rating sorts ASC.

Store and navigation

TypeFields
StorefrontStoreid, name, description, slug, domain, logo, icon, type, currency, language
CollectionItemid, slug, name, description, imageUrl, type, productCount, template, products
StorefrontSellerDtoid, name, slug, logo, banner, tagline, verified, rating
StorefrontSellerProfileDtoStorefrontSellerDto fields plus description, links, linkStyle, memberSince, deliveryPolicy, privacyAndSecurityPolicy
StorefrontSellerRatingDtoaverage, totalReviews
StorefrontSellerLinksDtowebsite, facebook, instagram, tikTok, youTube, twitter, linkedIn, whatsApp

CollectionItem.products(limit: Int, sort: ProductSearchSort) returns [ProductSummary!]!, including inside collection.

Payments and content

TypeFields
StorefrontPaymentMethodDtocode, name, kind, sortOrder, brands
CmsArticlePublicSummaryDtoid, title, slug, author, folder, tags, coverUrl, excerpt, publishedOn

kind is a String!: offline, card, wallet or other.

Products

TypeFields
SearchResultpageIndex, pageSize, totalCount, totalPages, products, filters
ProductSummaryid, name, slug, url, productType, imageUrl, price, compareAtPrice, variantCount, isAvailable, totalInventory, bundleItemsCount, brand, category, status, collections, tags, seller, options, images, availableVariantId, reviews
ProductDetailid, name, slug, url, description, productType, status, imageUrl, price, compareAtPrice, isAvailable, totalInventory, brand, category, categoryId, tags, specifications, variants, images, bundleItems, sizeGuide, priceTiers, createdAt, updatedAt, seller, related, reviewSummary
ProductSellerInfoid, name, slug
ProductOptionGroupkey, name, type, values
ProductReviewSummaryaverageRating, reviewCount
SearchFilterid, label, type, values, min, max, selectedMin, selectedMax
FacetItemvalue, count, label, selected
SpecItemkey, name, value, valueId, valueName, type, color, imageUrl, unit
ImageItemurl, name, order, type
VariantItemid, sku, status, price, compareAtPrice, quantity, isAvailable, requiresShipping, options, images
BundleItemproductId, variantId, productName, variantName, sku, brand, imageUrl, quantity, available, allowBackorders, requiresShipping
ProductPriceTiervariantId, minQuantity, maxQuantity, unitPrice
SizeGuideInfoid, name, slug, description, imageUrl, gender, measurementType, unit, notes, rows
SizeGuideRowInfolabel, sizeKey, order, measurements
SizeGuideMeasurementInfokey, name, min, max, value, description

Field types and nullability are listed in product.

  • ProductDetail.related(limit: Int! = 8) returns [ProductSummary!]!, the same as relatedProducts.
  • ProductDetail.reviewSummary returns ProductReviewSummary!: the average and number of approved reviews.
  • ProductSummary.reviews(limit: Int, sortBy: String, sortDirection: SortDirection) returns [StorefrontReviewDto!]!: the first page of productReviews with those arguments. To keep paginating, use productReviews.

Reviews

productReviews returns CursorPaginatedItemsOfStorefrontReviewDto:

FieldTypeContent
data[StorefrontReviewDto!]!Reviews on this page.
hasNextPageBoolean!true when there is another page.
nextCursorStringCursor for the next page.
totalCountLongReviews that match the filters.

StorefrontReviewDto has id, productId, isVerifiedPurchase, rating, title, content, reviewerName and createdOn.

StorefrontStoreReviewDto has id, productId, productName, rating, title, content, reviewerName and createdOn.

Limits

ArgumentRangeDefaultOut of range
product.slug, collection.slugUp to 200 characters—BAD_USER_INPUT
seller.slugUp to 100 characters—BAD_USER_INPUT
products.input.page1–1001BAD_USER_INPUT
products.input.pageSize1–10024BAD_USER_INPUT
productReviews.limit1–20020BAD_USER_INPUT
productReviews.rating1–5—BAD_USER_INPUT
productReviews.cursorUp to 2000 characters—BAD_USER_INPUT
productReviews.searchUp to 200 characters—BAD_USER_INPUT
collections.searchUp to 200 characters—BAD_USER_INPUT
relatedProducts.limit, ProductDetail.related.limit1–128Clamped to the nearest bound
collections.limit1–100AllClamped to the nearest bound
CollectionItem.products.limit1–248Clamped to the nearest bound
ProductSummary.reviews.limit1–103Clamped to the nearest bound
storeReviews.limit1–123Clamped to the nearest bound
articles.limit1–10024Above 100 uses 100; below 1 uses 24

Last updated:

On this page