Objects

StoreAggregateOffer

Aggregate offer information is needed for a given SKU that is available to be fulfilled by multiple sellers.

Field	Argument	Type	Description
highPrice		Float!	Highest price among all sellers.
lowPrice		Float!	Lowest price among all sellers.
offerCount		Int!	Number of sellers selling this SKU.
priceCurrency		String!	ISO code of the currency used for the offer prices.
offers		[StoreOffer!]!	Array with information on each available offer.

StoreAggregateRating

Average rating, based on multiple ratings or reviews.

Field	Argument	Type	Description
ratingValue		Float!	Value of the aggregate rating.
reviewCount		Int!	Total number of ratings.

StoreAuthor

Information about the author of a product review or rating.

Field	Argument	Type	Description
name		String!	Author name.

StoreBrand

Brand of a given product.

Field	Argument	Type	Description
name		String!	Brand name.

StoreBreadcrumbList

List of items consisting of chain linked web pages, ending with the current page.

Field	Argument	Type	Description
itemListElement		[StoreListItem!]!	Array with breadcrumb elements.
numberOfItems		Int!	Number of breadcrumbs in the list.

StoreCart

Shopping cart information.

Mutated by validateCart.

Field	Argument	Type	Description
order		StoreOrder!	Order information, including orderNumber and acceptedOffer.
messages		[StoreCartMessage!]!	List of shopping cart messages.

StoreCartMessage

Shopping cart message.

Field	Argument	Type	Description
text		String!	Shopping cart message text.
status		StoreStatus!	Shopping cart message status, which can be INFO, WARNING OR ERROR.

StoreCollection

Product collection information.

Queried by collection.

Field	Argument	Type	Description
seo		StoreSeo!	Meta tag data.
breadcrumbList		StoreBreadcrumbList!	List of items consisting of chain linked web pages, ending with the current page.
meta		StoreCollectionMeta!	Collection meta information. Used for search.
id		ID!	Collection ID.
slug		String!	Corresponding collection URL slug, with which to retrieve this entity.
type		StoreCollectionType!	Collection type.

StoreCollectionConnection

Collection connection pagination information.

Queried by allCollections.

Field	Argument	Type	Description
pageInfo		StorePageInfo!	Collection connection page information.
edges		[StoreCollectionEdge!]!	Array with collection connection page edges.

StoreCollectionEdge

Collection pagination edge.

Field	Argument	Type	Description
node		StoreCollection!	Collection pagination node.
cursor		String!	Collection pagination cursor.

StoreCollectionFacet

Product collection facet, used for search.

Field	Argument	Type	Description
key		String!	Facet key.
value		String!	Facet value.

StoreCollectionMeta

Collection meta information. Used for search.

Field	Argument	Type	Description
selectedFacets		[StoreCollectionFacet!]!	List of selected collection facets.

StoreCurrency

Currency information.

Field	Argument	Type	Description
code		String!	Currency code (e.g., USD)
symbol		String!	Currency symbol (e.g., $)

StoreFacet

Search facet information.

Field	Argument	Type	Description
key		String!	Facet key.
label		String!	Facet label.
values		[StoreFacetValue!]!	Array with information on each facet value.
type		StoreFacetType!	Facet type. Possible values are BOOLEAN and RANGE.

StoreFacetValue

Information of a specific facet value.

Field	Argument	Type	Description
value		String!	Facet value.
label		String!	Facet value label.
selected		Boolean!	Indicates whether facet is selected.
quantity		Int!	Number of items with this facet.

StoreImage

Image.

Field	Argument	Type	Description
url		String!	Image URL.
alternateName		String!	Alias for the image.

StoreListItem

Item of a list.

Field	Argument	Type	Description
item		String!	List item value.
name		String!	Name of the list item.
position		Int!	Position of the item in the list.

StoreOffer

Offer information.

Field	Argument	Type	Description
listPrice		Float!	This is displayed as the "from" price in the context of promotions' price comparison. This may change before it reaches the shelf.
sellingPrice		Float!	Computed price before applying coupons, taxes or benefits. This may change before it reaches the shelf.
priceCurrency		String!	ISO code of the currency used for the offer prices.
price		Float!	Also known as spot price.
priceValidUntil		String!	Next date in which price is scheduled to change. If there is no scheduled change, this will be set a year in the future from current time.
itemCondition		String!	Offer item condition.
availability		String!	Offer item availability.
seller		StoreOrganization!	Seller responsible for the offer.
itemOffered		StoreProduct!	Information on the item being offered.
quantity		Int!	Number of items offered.

StoreOrder

Information of a specific order.

Field	Argument	Type	Description
orderNumber		String!	ID of the order in VTEX order management.
acceptedOffer		[StoreOffer!]!	Array with information on each accepted offer.

StoreOrganization

Organization.

Field	Argument	Type	Description
identifier		String!	Organization ID.

StorePageInfo

Page information.

Field	Argument	Type	Description
hasNextPage		Boolean!	Indicates whether next page exists.
hasPreviousPage		Boolean!	Indicates whether previous page exists.
startCursor		String!	Page cursor start.
endCursor		String!	Page cursor end.
totalCount		Int!	Total number of items (products or collections), not pages.

StorePerson

Client profile data.

Field	Argument	Type	Description
id		String!	Client ID.
email		String!	Client email.
givenName		String!	Client first name.
familyName		String!	Client last name.

StoreProduct

Product information. Products are variants within product groups, equivalent to VTEX SKUs. For example, you may have a Shirt product group with associated products such as Blue shirt size L, Green shirt size XL and so on.

Queried by product.

Field	Argument	Type	Description
seo		StoreSeo!	Meta tag data.
breadcrumbList		StoreBreadcrumbList!	List of items consisting of chain linked web pages, ending with the current page.
slug		String!	Corresponding collection URL slug, with which to retrieve this entity.
name		String!	Product name.
productID		String!	Product ID, such as ISBN or similar global IDs.
brand		StoreBrand!	Product brand.
description		String!	Product description.
image		[StoreImage!]!	Array of images.
offers		StoreAggregateOffer!	Aggregate offer information.
sku		String!	Stock Keeping Unit. Merchant-specific ID for the product.
gtin		String!	Global Trade Item Number.
review		[StoreReview!]!	Array with review information.
aggregateRating		StoreAggregateRating!	Aggregate ratings data.
isVariantOf		StoreProductGroup!	Indicates product group related to this product.
additionalProperty		[StorePropertyValue!]!	Array of additional properties.

StoreProductConnection

Product connection pagination information.

Queried by allProducts.

Field	Argument	Type	Description
pageInfo		StorePageInfo!	Product connection page information.
edges		[StoreProductEdge!]!	Array with product connection page edges.

StoreProductEdge

Product pagination edge.

Field	Argument	Type	Description
node		StoreProduct!	Product pagination node.
cursor		String!	Product pagination cursor.

StoreProductGroup

Product group information. Product groups are catalog entities that may contain variants. They are equivalent to VTEX Products, whereas each variant is equivalent to a VTEX SKU. For example, you may have a Shirt product group with associated products such as Blue shirt size L, Green shirt size XL and so on.

Field	Argument	Type	Description
hasVariant		[StoreProduct!]!	Array of variants related to product group. Variants are equivalent to VTEX SKUs.
productGroupID		String!	Product group ID.
name		String!	Product group name.
additionalProperty		[StorePropertyValue!]!	Array of additional properties.

StorePropertyValue

Properties that can be associated with products and products groups.

Field	Argument	Type	Description
propertyID		String!	Property id. This propert changes according to the content of the object.
value		ObjectOrString!	Property value. May hold a string or the string representation of an object.
name		String!	Property name.
valueReference		String!	Specifies the nature of the value

StoreReview

Information of a given review.

Field	Argument	Type	Description
reviewRating		StoreReviewRating!	Review rating information.
author		StoreAuthor!	Review author.

StoreReviewRating

Information of a given review rating.

Field	Argument	Type	Description
ratingValue		Float!	Rating value.
bestRating		Float!	Best rating value.

StoreSearchResult

Search result.

Queried by search.

Field	Argument	Type	Description
products		StoreProductConnection!	Search result products.
facets		[StoreFacet!]!	Array of search result facets.
suggestions		StoreSuggestions!	Search result suggestions.

StoreSeo

Search Engine Optimization (SEO) tags data.

caution

This object only returns the title and description fields due to a known issue. To retrieve other SEO information, you can extend the Product query by following the Extending the GraphQL schema guide.

Field	Argument	Type	Description
title		String!	Title tag.
titleTemplate		String!	Title template tag.
description		String!	Description tag.
canonical		String!	Canonical tag.

StoreSession

Session information.

Mutated by updateSession.

Field	Argument	Type	Description
channel		String	Session channel.
country		String	Session country.
postalCode		String	Session postal code.

StoreSuggestionTerm

Suggestion term.

Field	Argument	Type	Description
value		String!	The term.
count		Int!	Its occurrences count.

StoreSuggestions

Suggestions information.

Field	Argument	Type	Description
terms		[String!]	Array with suggestion terms.
products		[StoreProduct!]	Array with suggestion products' information.