Schema y tipos
Campos raíz, inputs, enums, objetos y límites del schema GraphQL de Storefront.
El schema tiene una raíz Query. No hay mutaciones ni suscripciones.
Convenciones
!indica un valor no nulo. Un argumento sin!se puede omitir o enviar comonull.- Los IDs son
Stringopacos, aunque parezcan números. Decimalrepresenta importes y medidas.DateTimees una fecha y hora ISO 8601.
Query
| Campo | Firma | Retorno |
|---|---|---|
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
| Campo | Tipo | Predeterminado y límites |
|---|---|---|
includeFilters | Boolean | true. Con false, filters llega vacío. |
productIds | [String!] | Hasta 100 IDs. |
slugs | [String!] | Hasta 100 slugs de hasta 255 caracteres. |
search | String | Texto libre. |
categories | [String!] | Nombres de categoría. |
brands | [String!] | Nombres de marca. |
sellerSlugs | [String!] | Slugs de vendedor. |
collections | [String!] | Slugs de colección. |
collectionId | String | ID de una colección. |
productTypes | [ProductType!] | Tipos de producto. |
tags | [String!] | Etiquetas. |
filters | [String!] | Hasta 100 filtros de hasta 250 caracteres. |
inStock | Boolean | Sin filtro. |
minPrice | Decimal | Sin mínimo. |
maxPrice | Decimal | Sin máximo. |
page | Int | 1; de 1 a 100. |
pageSize | Int | 24; de 1 a 100. |
sort | ProductSearchSort | DEFAULT. |
Los filtros de faceta tienen la forma option:nombre:valor o attribute:nombre:valor. Las reglas de combinación están en products.
Enums
| Enum | Valores |
|---|---|
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 |
ProductSearchSortordenaproductsyCollectionItem.products. EnCollectionItem.products, sinsorto conDEFAULTse usa el orden de la colección, incluido el manual.- En
collections,ORDER_ASCyORDER_DESCordenan por nombre ascendente. SortDirectionacompaña asortByenproductReviewsyProductSummary.reviews. Sin dirección,createdOnordenaDESCyrating,ASC.
Tienda y navegación
| Tipo | Campos |
|---|---|
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 | Campos de StorefrontSellerDto más description, links, linkStyle, memberSince, deliveryPolicy, privacyAndSecurityPolicy |
StorefrontSellerRatingDto | average, totalReviews |
StorefrontSellerLinksDto | website, facebook, instagram, tikTok, youTube, twitter, linkedIn, whatsApp |
CollectionItem.products(limit: Int, sort: ProductSearchSort) devuelve [ProductSummary!]!, también dentro de collection.
Pagos y contenido
| Tipo | Campos |
|---|---|
StorefrontPaymentMethodDto | code, name, kind, sortOrder, brands |
CmsArticlePublicSummaryDto | id, title, slug, author, folder, tags, coverUrl, excerpt, publishedOn |
kind es un String!: offline, card, wallet u other.
Productos
| Tipo | Campos |
|---|---|
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 |
Los tipos y la nulabilidad de cada campo están en product.
ProductDetail.related(limit: Int! = 8)devuelve[ProductSummary!]!, igual querelatedProducts.ProductDetail.reviewSummarydevuelveProductReviewSummary!: el promedio y la cantidad de reseñas aprobadas.ProductSummary.reviews(limit: Int, sortBy: String, sortDirection: SortDirection)devuelve[StorefrontReviewDto!]!: la primera página deproductReviewscon esos argumentos. Para seguir paginando, usaproductReviews.
Reseñas
productReviews devuelve CursorPaginatedItemsOfStorefrontReviewDto:
| Campo | Tipo | Contenido |
|---|---|---|
data | [StorefrontReviewDto!]! | Reseñas de la página. |
hasNextPage | Boolean! | true si hay otra página. |
nextCursor | String | Cursor para la siguiente página. |
totalCount | Long | Reseñas que cumplen los filtros. |
StorefrontReviewDto tiene id, productId, isVerifiedPurchase, rating, title, content, reviewerName y createdOn.
StorefrontStoreReviewDto tiene id, productId, productName, rating, title, content, reviewerName y createdOn.
Límites
| Argumento | Rango | Predeterminado | Fuera de rango |
|---|---|---|---|
product.slug, collection.slug | Hasta 200 caracteres | — | BAD_USER_INPUT |
seller.slug | Hasta 100 caracteres | — | 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 | Hasta 2000 caracteres | — | BAD_USER_INPUT |
productReviews.search | Hasta 200 caracteres | — | BAD_USER_INPUT |
collections.search | Hasta 200 caracteres | — | BAD_USER_INPUT |
relatedProducts.limit, ProductDetail.related.limit | 1–12 | 8 | Se ajusta al extremo |
collections.limit | 1–100 | Todas | Se ajusta al extremo |
CollectionItem.products.limit | 1–24 | 8 | Se ajusta al extremo |
ProductSummary.reviews.limit | 1–10 | 3 | Se ajusta al extremo |
storeReviews.limit | 1–12 | 3 | Se ajusta al extremo |
articles.limit | 1–100 | 24 | Más de 100 usa 100; menos de 1 usa 24 |
Última actualización: