Objects

Address

Address information.

Field	Type	Description
postalCode	String	Address postal code.
city	String	Address city.
state	String	Address state.
country	String	Address country.
street	String	Address street.
number	String	Address number.
neighborhood	String	Address neighborhood.
complement	String	Address complement.
reference	String	Address reference.
geoCoordinates	[Float]	Address geoCoordinates.

AvailableDeliveryWindows

Field	Type	Description
startDateUtc	String	Available delivery window start date in UTC.
endDateUtc	String	Available delivery window end date in UTC.
price	Int	Available delivery window price.
listPrice	Int	Available delivery window list price.
tax	Int	Available delivery window tax.

DeliveryIds

Field	Type	Description
courierId	String	DeliveryIds courier id.
warehouseId	String	DeliveryIds warehouse id.
dockId	String	DeliveryIds dock id.
courierName	String	DeliveryIds courier name.
quantity	Int	DeliveryIds quantity.

LogisticsInfo

Field	Type	Description
itemIndex	String	LogisticsInfo itemIndex.
selectedSla	String	LogisticsInfo selectedSla.
slas	[ShippingSLA]	List of LogisticsInfo ShippingSLA.

LogisticsItem

Shipping Simulation Logistic Item.

Field	Type	Description
id	String	LogisticsItem ID or SKU.
requestIndex	Int
quantity	Int	Number of items.
seller	String	Seller responsible for the ShippingItem.
sellerChain	[String]	List of Sellers.
tax	Int	LogisticsItem tax.
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.
price	Int	LogisticsItem price.
listPrice	Int	LogisticsItem listPrice.
rewardValue	Int	LogisticsItem rewardValue.
sellingPrice	Int	LogisticsItem sellingPrice.
measurementUnit	String	LogisticsItem measurementUnit.
unitMultiplier	Int	LogisticsItem unitMultiplier.
availability	String	LogisticsItem availability.

MessageFields

Field	Type	Description
itemIndex	String	MessageFields item index.
ean	String	MessageFields ean.
skuName	String	MessageFields sku name.

MessageInfo

Field	Type	Description
code	String	MessageInfo code.
text	String	MessageInfo text.
status	String	MessageInfo status.
fields	MessageFields	MessageInfo fields.

PersonNewsletter

Newsletter information.

Field	Argument	Type	Description
id		String!	Person's ID in the newsletter list.

PickupAddress

Field	Type	Description
addressType	String	PickupAddress address type.
receiverName	String	PickupAddress receiver name.
addressId	String	PickupAddress address id.
postalCode	String	PickupAddress postal code.
city	String	PickupAddress city.
state	String	PickupAddress state.
country	String	PickupAddress country.
street	String	PickupAddress street.
number	String	PickupAddress number.
neighborhood	String	PickupAddress neighborhood.
complement	String	PickupAddress complement.
reference	String	PickupAddress reference.
geoCoordinates	[Float]	PickupAddress geo coordinates.

PickupStoreInfo

Field	Type	Description
friendlyName	String	PickupStoreInfo friendly name.
address	PickupAddress	PickupStoreInfo address.
additionalInfo	String	PickupStoreInfo additional information.
dockId	String	PickupStoreInfo dock id.
isPickupStore	Boolean	Information if the store has pickup enable.

SearchMetadata

Search result.

Field	Type	Description
isTermMisspelled	Boolean!	Indicates if the search term was misspelled.
logicalOperator	String!	Logical operator used to run the search.
fuzzy	String!	Indicates how the search engine corrected the misspelled word by using fuzzy logic.

SellerInfo

Information of sellers.

Field	Type	Description
id	String	Identification of the seller.
name	String	Name of the seller.
logo	String	Logo of the seller.

SellersData

Regionalization with sellers information.

Field	Argument	Type	Description
id		String	Identification of region.
sellers		[SellerInfo]	List of sellers.

ShippingData

Shipping Simulation information.

Field	Type	Description
items	[LogisticsItem]	List of LogisticsItem.
logisticsInfo	[LogisticsInfo]	List of LogisticsInfo.
messages	[MessageInfo]	List of MessageInfo.
address	Address	Address information.

ShippingSLA

Field	Type	Description
id	String	ShippingSLA id.
name	String	ShippingSLA name.
price	Float	ShippingSLA price.
shippingEstimate	String	ShippingSLA shipping estimate.
localizedEstimates	String	ShippingSLA localized shipping estimate. Note: this will always return a localized string for locale `en-US`.
availableDeliveryWindows	[AvailableDeliveryWindows]	ShippingSLA available delivery windows.
shippingEstimateDate	String	ShippingSLA shipping estimate date.
deliveryIds	[DeliveryIds]	List of ShippingSLA delivery ids.
deliveryChannel	String	ShippingSLA delivery channel.
friendlyName	String	ShippingSLA friendly name.
carrier	String	ShippingSLA carrier.
pickupPointId	String	ShippingSLA pickup point id.
pickupStoreInfo	PickupStoreInfo	ShippingSLA pickup store info.
pickupDistance	Float	ShippingSLA pickup distance.

SkuVariants

Field	Type	Description
activeVariations	ActiveVariations	SKU property values for the current SKU.
allVariantsByName	VariantsByName	All available options for each SKU variant property, indexed by their name.
slugsMap	SlugsMap	Maps property value combinations to their respective SKU's slug. Enables us to retrieve the slug for the SKU that matches the currently selected variations in O(1) time. If `dominantVariantName` is not present, the first variant will be considered the dominant one.
dominantVariantName	String
availableVariations	FormattedVariants	Available options for each varying SKU property, taking into account the `dominantVariantName` property. Returns all available options for the dominant property, and only options that can be combined with its current value for other properties. If `dominantVariantName` is not present, the first variant will be considered the dominant one.
dominantVariantName	String

StoreAggregateOffer

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

Field	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.

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.

Field	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 connections, including pagination information and collections returned by the query.

Field	Argument	Type	Description
pageInfo		StorePageInfo!	Collection pagination information.
edges		[StoreCollectionEdge!]!	Array with collection connection page edges, each containing a collection and a corresponding cursor.

StoreCollectionEdge

Each collection edge contains a node, with product collection information, and a cursor, that can be used as a reference for pagination.

Field	Argument	Type	Description
node		StoreCollection!	Each collection node contains the information of a product collection returned by the query.
cursor		String!	Collection cursor. Used as pagination reference.

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: `$`).

StoreDeliveryMode

Delivery mode information.

Field	Type	Description
deliveryChannel	String!	The delivery channel information of the session.
deliveryMethod	String!	The delivery method information of the session.
deliveryWindow	StoreDeliveryWindow	The delivery window information of the session.

StoreDeliveryWindow

Delivery window information.

Field	Argument	Type	Description
startDate		String!	The delivery window start date information.
endDate		String!	The delivery window end date information.

StoreFacet

Search facet information.

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

StoreFacetBoolean

Search facet boolean information.

Field	Type	Description
key	String!	Facet key.
label	String!	Facet label.
values	[StoreFacetValueBoolean!]!	Array with information on each facet value.

StoreFacetRange

Search facet range information.

Field	Type	Description
key	String!	Facet key.
label	String!	Facet label.
min	StoreFacetValueRange!	Minimum facet range value.
max	StoreFacetValueRange!	Maximum facet range value.

StoreFacetValueBoolean

Information of a specific facet value.

Field	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.

StoreFacetValueRange

Search facet range value information. Used for minimum and maximum range values.

Field	Argument	Type	Description
absolute		Float!	Search facet range absolute value.
selected		Float!	Search facet range selected value.

StoreGeoCoordinates

Geographic coordinates information.

Field	Argument	Type	Description
latitude		Float!	The latitude of the geographic coordinates.
longitude		Float!	The longitude of the geographic coordinates.

StoreImage

Image.

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

StoreListItem

Item of a list.

Field	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	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

Whenever you make a query that allows for pagination, such as allProducts or allCollections, you can check StorePageInfo to learn more about the complete set of items and use it to paginate your queries.

Field	Type	Description
hasNextPage	Boolean!	Indicates whether there is at least one more page with items after the ones returned in the current query.
hasPreviousPage	Boolean!	Indicates whether there is at least one more page with items before the ones returned in the current query.
startCursor	String!	Cursor corresponding to the first possible item.
endCursor	String!	Cursor corresponding to the last possible item.
totalCount	Int!	Total number of items (products or collections), not pages.

StorePerson

Client profile data.

Field	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.

Field	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.
context	String
limit	Int
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.
releaseDate	String!	The product's release date. Formatted using ISO 8601.

StoreProductConnection

Product connections, including pagination information and products returned by the query.

Field	Argument	Type	Description
pageInfo		StorePageInfo!	Product pagination information.
edges		[StoreProductEdge!]!	Array with product connection edges, each containing a product and a corresponding cursor.

StoreProductEdge

Each product edge contains a node, with product information, and a cursor, that can be used as a reference for pagination.

Field	Argument	Type	Description
node		StoreProduct!	Each product node contains the information of a product returned by the query.
cursor		String!	Product cursor. Used as pagination reference.

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	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.
skuVariants	SkuVariants	Object containing data structures to facilitate handling different SKU variant properties. Specially useful for implementing SKU selection components.

StorePropertyValue

Properties that can be associated with products and products groups.

Field	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.

StoreRedirect

Redirect informations, including url returned by the query. https://schema.org/Thing

Field	Argument	Type	Description
url		String	URL to redirect.

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.

Field	Type	Description
products	StoreProductConnection!	Search result products.
facets	[StoreFacet!]!	Array of search result facets.
suggestions	StoreSuggestions!	Search result suggestions.
metadata	SearchMetadata	Search result metadata. Additional data can be used to send analytics events.

StoreSeo

Search Engine Optimization (SEO) tags data.

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

StoreSession

Session information.

Field	Type	Description
locale	String!	Session locale.
currency	StoreCurrency!	Session currency.
country	String!	Session country.
channel	String	Session channel.
deliveryMode	StoreDeliveryMode	Session delivery mode.
addressType	String	Session address type.
postalCode	String	Session postal code.
geoCoordinates	StoreGeoCoordinates	Session input geoCoordinates.
person	StorePerson	Session input person.

StoreSuggestionTerm

Suggestion term.

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

StoreSuggestions

Suggestions information.

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