Saltar al contenido

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 como null.
  • Los IDs son String opacos, aunque parezcan números.
  • Decimal representa importes y medidas.
  • DateTime es una fecha y hora ISO 8601.

Query

CampoFirmaRetorno
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

CampoTipoPredeterminado y límites
includeFiltersBooleantrue. Con false, filters llega vacío.
productIds[String!]Hasta 100 IDs.
slugs[String!]Hasta 100 slugs de hasta 255 caracteres.
searchStringTexto libre.
categories[String!]Nombres de categoría.
brands[String!]Nombres de marca.
sellerSlugs[String!]Slugs de vendedor.
collections[String!]Slugs de colección.
collectionIdStringID de una colección.
productTypes[ProductType!]Tipos de producto.
tags[String!]Etiquetas.
filters[String!]Hasta 100 filtros de hasta 250 caracteres.
inStockBooleanSin filtro.
minPriceDecimalSin mínimo.
maxPriceDecimalSin máximo.
pageInt1; de 1 a 100.
pageSizeInt24; de 1 a 100.
sortProductSearchSortDEFAULT.

Los filtros de faceta tienen la forma option:nombre:valor o attribute:nombre:valor. Las reglas de combinación están en products.

Enums

EnumValores
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 ordena products y CollectionItem.products. En CollectionItem.products, sin sort o con DEFAULT se usa el orden de la colección, incluido el manual.
  • En collections, ORDER_ASC y ORDER_DESC ordenan por nombre ascendente.
  • SortDirection acompaña a sortBy en productReviews y ProductSummary.reviews. Sin dirección, createdOn ordena DESC y rating, ASC.

Tienda y navegación

TipoCampos
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
StorefrontSellerProfileDtoCampos de StorefrontSellerDto más description, links, linkStyle, memberSince, deliveryPolicy, privacyAndSecurityPolicy
StorefrontSellerRatingDtoaverage, totalReviews
StorefrontSellerLinksDtowebsite, facebook, instagram, tikTok, youTube, twitter, linkedIn, whatsApp

CollectionItem.products(limit: Int, sort: ProductSearchSort) devuelve [ProductSummary!]!, también dentro de collection.

Pagos y contenido

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

kind es un String!: offline, card, wallet u other.

Productos

TipoCampos
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

Los tipos y la nulabilidad de cada campo están en product.

  • ProductDetail.related(limit: Int! = 8) devuelve [ProductSummary!]!, igual que relatedProducts.
  • ProductDetail.reviewSummary devuelve ProductReviewSummary!: el promedio y la cantidad de reseñas aprobadas.
  • ProductSummary.reviews(limit: Int, sortBy: String, sortDirection: SortDirection) devuelve [StorefrontReviewDto!]!: la primera página de productReviews con esos argumentos. Para seguir paginando, usa productReviews.

Reseñas

productReviews devuelve CursorPaginatedItemsOfStorefrontReviewDto:

CampoTipoContenido
data[StorefrontReviewDto!]!Reseñas de la página.
hasNextPageBoolean!true si hay otra página.
nextCursorStringCursor para la siguiente página.
totalCountLongReseñ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

ArgumentoRangoPredeterminadoFuera de rango
product.slug, collection.slugHasta 200 caracteres—BAD_USER_INPUT
seller.slugHasta 100 caracteres—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.cursorHasta 2000 caracteres—BAD_USER_INPUT
productReviews.searchHasta 200 caracteres—BAD_USER_INPUT
collections.searchHasta 200 caracteres—BAD_USER_INPUT
relatedProducts.limit, ProductDetail.related.limit1–128Se ajusta al extremo
collections.limit1–100TodasSe ajusta al extremo
CollectionItem.products.limit1–248Se ajusta al extremo
ProductSummary.reviews.limit1–103Se ajusta al extremo
storeReviews.limit1–123Se ajusta al extremo
articles.limit1–10024Más de 100 usa 100; menos de 1 usa 24

Última actualización:

En esta página