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 asnull.- IDs are opaque
Stringvalues, even when they look numeric. Decimalholds amounts and measurements.DateTimeis an ISO 8601 date and time.
Query
| Field | Signature | Returns |
|---|---|---|
store | store | StorefrontStore! |
products | products(input: StorefrontProductsInput) | SearchResult! |
product | product(slug: String!) | ProductDetail! |
relatedProducts | relatedProducts(productId: String!, limit: Int) | [ProductSummary!]! |
collections | collections(search: String, sort: NavigationSearchSort, limit: Int) | [CollectionItem!] |
collection | collection(slug: String!) | CollectionItem! |
sellers | sellers | [StorefrontSellerDto!]! |
seller | seller(slug: String!) | StorefrontSellerProfileDto! |
productReviews | productReviews(productId: String!, limit: Int, cursor: String, search: String, sortBy: String, sortDirection: SortDirection, rating: Int) | CursorPaginatedItemsOfStorefrontReviewDto! |
storeReviews | storeReviews(limit: Int, minRating: Int) | [StorefrontStoreReviewDto!]! |
paymentMethods | paymentMethods | [StorefrontPaymentMethodDto!]! |
articles | articles(search: String, folder: String, tag: String, limit: Int) | [CmsArticlePublicSummaryDto!]! |
StorefrontProductsInput
| Field | Type | Default and limits |
|---|---|---|
includeFilters | Boolean | true. With false, filters comes back empty. |
productIds | [String!] | Up to 100 IDs. |
slugs | [String!] | Up to 100 slugs of up to 255 characters. |
search | String | Free text. |
categories | [String!] | Category names. |
brands | [String!] | Brand names. |
sellerSlugs | [String!] | Seller slugs. |
collections | [String!] | Collection slugs. |
collectionId | String | A collection ID. |
productTypes | [ProductType!] | Product types. |
tags | [String!] | Tags. |
filters | [String!] | Up to 100 filters of up to 250 characters. |
inStock | Boolean | No filter. |
minPrice | Decimal | No minimum. |
maxPrice | Decimal | No maximum. |
page | Int | 1; 1 to 100. |
pageSize | Int | 24; 1 to 100. |
sort | ProductSearchSort | DEFAULT. |
Facet filters take the form option:name:value or attribute:name:value. The combination rules are in products.
Enums
| Enum | Values |
|---|---|
StoreType | B2C, MARKETPLACE, RETAIL, B2B, SOCIAL, HUB, RESTAURANT |
ProductType | PRODUCT, SERVICE, BUNDLE |
ProductSearchSort | DEFAULT, PRICE_ASC, PRICE_DESC, NEWEST, NAME_ASC, NAME_DESC, OLDEST, BEST_SELLING |
NavigationSearchSort | DEFAULT, NAME_ASC, NAME_DESC, ORDER_ASC, ORDER_DESC, NEWEST, UPDATED_DESC |
SortDirection | ASC, DESC |
SellerLinkStyle | ICONS, TEXT |
ProductSearchSortsortsproductsandCollectionItem.products. InCollectionItem.products, nosortorDEFAULTuses the collection's own order, including manual order.- In
collections,ORDER_ASCandORDER_DESCsort by name ascending. SortDirectiongoes withsortByinproductReviewsandProductSummary.reviews. Without a direction,createdOnsortsDESCandratingsortsASC.
Store and navigation
| Type | Fields |
|---|---|
StorefrontStore | id, name, description, slug, domain, logo, icon, type, currency, language |
CollectionItem | id, slug, name, description, imageUrl, type, productCount, template, products |
StorefrontSellerDto | id, name, slug, logo, banner, tagline, verified, rating |
StorefrontSellerProfileDto | StorefrontSellerDto fields plus description, links, linkStyle, memberSince, deliveryPolicy, privacyAndSecurityPolicy |
StorefrontSellerRatingDto | average, totalReviews |
StorefrontSellerLinksDto | website, facebook, instagram, tikTok, youTube, twitter, linkedIn, whatsApp |
CollectionItem.products(limit: Int, sort: ProductSearchSort) returns [ProductSummary!]!, including inside collection.
Payments and content
| Type | Fields |
|---|---|
StorefrontPaymentMethodDto | code, name, kind, sortOrder, brands |
CmsArticlePublicSummaryDto | id, title, slug, author, folder, tags, coverUrl, excerpt, publishedOn |
kind is a String!: offline, card, wallet or other.
Products
| Type | Fields |
|---|---|
SearchResult | pageIndex, pageSize, totalCount, totalPages, products, filters |
ProductSummary | id, name, slug, url, productType, imageUrl, price, compareAtPrice, variantCount, isAvailable, totalInventory, bundleItemsCount, brand, category, status, collections, tags, seller, options, images, availableVariantId, reviews |
ProductDetail | id, 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 |
ProductSellerInfo | id, name, slug |
ProductOptionGroup | key, name, type, values |
ProductReviewSummary | averageRating, reviewCount |
SearchFilter | id, label, type, values, min, max, selectedMin, selectedMax |
FacetItem | value, count, label, selected |
SpecItem | key, name, value, valueId, valueName, type, color, imageUrl, unit |
ImageItem | url, name, order, type |
VariantItem | id, sku, status, price, compareAtPrice, quantity, isAvailable, requiresShipping, options, images |
BundleItem | productId, variantId, productName, variantName, sku, brand, imageUrl, quantity, available, allowBackorders, requiresShipping |
ProductPriceTier | variantId, minQuantity, maxQuantity, unitPrice |
SizeGuideInfo | id, name, slug, description, imageUrl, gender, measurementType, unit, notes, rows |
SizeGuideRowInfo | label, sizeKey, order, measurements |
SizeGuideMeasurementInfo | key, name, min, max, value, description |
Field types and nullability are listed in product.
ProductDetail.related(limit: Int! = 8)returns[ProductSummary!]!, the same asrelatedProducts.ProductDetail.reviewSummaryreturnsProductReviewSummary!: the average and number of approved reviews.ProductSummary.reviews(limit: Int, sortBy: String, sortDirection: SortDirection)returns[StorefrontReviewDto!]!: the first page ofproductReviewswith those arguments. To keep paginating, useproductReviews.
Reviews
productReviews returns CursorPaginatedItemsOfStorefrontReviewDto:
| Field | Type | Content |
|---|---|---|
data | [StorefrontReviewDto!]! | Reviews on this page. |
hasNextPage | Boolean! | true when there is another page. |
nextCursor | String | Cursor for the next page. |
totalCount | Long | Reviews 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
| Argument | Range | Default | Out of range |
|---|---|---|---|
product.slug, collection.slug | Up to 200 characters | — | BAD_USER_INPUT |
seller.slug | Up to 100 characters | — | BAD_USER_INPUT |
products.input.page | 1–100 | 1 | BAD_USER_INPUT |
products.input.pageSize | 1–100 | 24 | BAD_USER_INPUT |
productReviews.limit | 1–200 | 20 | BAD_USER_INPUT |
productReviews.rating | 1–5 | — | BAD_USER_INPUT |
productReviews.cursor | Up to 2000 characters | — | BAD_USER_INPUT |
productReviews.search | Up to 200 characters | — | BAD_USER_INPUT |
collections.search | Up to 200 characters | — | BAD_USER_INPUT |
relatedProducts.limit, ProductDetail.related.limit | 1–12 | 8 | Clamped to the nearest bound |
collections.limit | 1–100 | All | Clamped to the nearest bound |
CollectionItem.products.limit | 1–24 | 8 | Clamped to the nearest bound |
ProductSummary.reviews.limit | 1–10 | 3 | Clamped to the nearest bound |
storeReviews.limit | 1–12 | 3 | Clamped to the nearest bound |
articles.limit | 1–100 | 24 | Above 100 uses 100; below 1 uses 24 |
Last updated: