Skip to main content

Objects

StoreAggregateOfferโ€‹

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

FieldArgumentTypeDescription
highPriceFloat!

Highest price among all sellers.

lowPriceFloat!

Lowest price among all sellers.

offerCountInt!

Number of sellers selling this SKU.

priceCurrencyString!

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.

FieldArgumentTypeDescription
ratingValueFloat!

Value of the aggregate rating.

reviewCountInt!

Total number of ratings.

StoreAuthorโ€‹

Information about the author of a product review or rating.

FieldArgumentTypeDescription
nameString!

Author name.

StoreBrandโ€‹

Brand of a given product.

FieldArgumentTypeDescription
nameString!

Brand name.

StoreBreadcrumbListโ€‹

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

FieldArgumentTypeDescription
itemListElement[StoreListItem!]!

Array with breadcrumb elements.

numberOfItemsInt!

Number of breadcrumbs in the list.

StoreCartโ€‹

Shopping cart information.

Mutated by validateCart.

FieldArgumentTypeDescription
orderStoreOrder!

Order information, including orderNumber and acceptedOffer.

messages[StoreCartMessage!]!

List of shopping cart messages.

StoreCartMessageโ€‹

Shopping cart message.

FieldArgumentTypeDescription
textString!

Shopping cart message text.

statusStoreStatus!

Shopping cart message status, which can be INFO, WARNING OR ERROR.

StoreCollectionโ€‹

Product collection information.

Queried by collection.

FieldArgumentTypeDescription
seoStoreSeo!

Meta tag data.

breadcrumbListStoreBreadcrumbList!

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

metaStoreCollectionMeta!

Collection meta information. Used for search.

idID!

Collection ID.

slugString!

Corresponding collection URL slug, with which to retrieve this entity.

typeStoreCollectionType!

Collection type.

StoreCollectionConnectionโ€‹

Collection connection pagination information.

Queried by allCollections.

FieldArgumentTypeDescription
pageInfoStorePageInfo!

Collection connection page information.

edges[StoreCollectionEdge!]!

Array with collection connection page edges.

StoreCollectionEdgeโ€‹

Collection pagination edge.

FieldArgumentTypeDescription
nodeStoreCollection!

Collection pagination node.

cursorString!

Collection pagination cursor.

StoreCollectionFacetโ€‹

Product collection facet, used for search.

FieldArgumentTypeDescription
keyString!

Facet key.

valueString!

Facet value.

StoreCollectionMetaโ€‹

Collection meta information. Used for search.

FieldArgumentTypeDescription
selectedFacets[StoreCollectionFacet!]!

List of selected collection facets.

StoreCurrencyโ€‹

Currency information.

FieldArgumentTypeDescription
codeString!

Currency code (e.g., USD)

symbolString!

Currency symbol (e.g., $)

StoreFacetโ€‹

Search facet information.

FieldArgumentTypeDescription
keyString!

Facet key.

labelString!

Facet label.

values[StoreFacetValue!]!

Array with information on each facet value.

typeStoreFacetType!

Facet type. Possible values are BOOLEAN and RANGE.

StoreFacetValueโ€‹

Information of a specific facet value.

FieldArgumentTypeDescription
valueString!

Facet value.

labelString!

Facet value label.

selectedBoolean!

Indicates whether facet is selected.

quantityInt!

Number of items with this facet.

StoreImageโ€‹

Image.

FieldArgumentTypeDescription
urlString!

Image URL.

alternateNameString!

Alias for the image.

StoreListItemโ€‹

Item of a list.

FieldArgumentTypeDescription
itemString!

List item value.

nameString!

Name of the list item.

positionInt!

Position of the item in the list.

StoreOfferโ€‹

Offer information.

FieldArgumentTypeDescription
listPriceFloat!

This is displayed as the "from" price in the context of promotions' price comparison. This may change before it reaches the shelf.

sellingPriceFloat!

Computed price before applying coupons, taxes or benefits. This may change before it reaches the shelf.

priceCurrencyString!

ISO code of the currency used for the offer prices.

priceFloat!

Also known as spot price.

priceValidUntilString!

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.

itemConditionString!

Offer item condition.

availabilityString!

Offer item availability.

sellerStoreOrganization!

Seller responsible for the offer.

itemOfferedStoreProduct!

Information on the item being offered.

quantityInt!

Number of items offered.

StoreOrderโ€‹

Information of a specific order.

FieldArgumentTypeDescription
orderNumberString!

ID of the order in VTEX order management.

acceptedOffer[StoreOffer!]!

Array with information on each accepted offer.

StoreOrganizationโ€‹

Organization.

FieldArgumentTypeDescription
identifierString!

Organization ID.

StorePageInfoโ€‹

Page information.

FieldArgumentTypeDescription
hasNextPageBoolean!

Indicates whether next page exists.

hasPreviousPageBoolean!

Indicates whether previous page exists.

startCursorString!

Page cursor start.

endCursorString!

Page cursor end.

totalCountInt!

Total number of items (products or collections), not pages.

StorePersonโ€‹

Client profile data.

FieldArgumentTypeDescription
idString!

Client ID.

emailString!

Client email.

givenNameString!

Client first name.

familyNameString!

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.

FieldArgumentTypeDescription
seoStoreSeo!

Meta tag data.

breadcrumbListStoreBreadcrumbList!

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

slugString!

Corresponding collection URL slug, with which to retrieve this entity.

nameString!

Product name.

productIDString!

Product ID, such as ISBN or similar global IDs.

brandStoreBrand!

Product brand.

descriptionString!

Product description.

image[StoreImage!]!

Array of images.

offersStoreAggregateOffer!

Aggregate offer information.

skuString!

Stock Keeping Unit. Merchant-specific ID for the product.

gtinString!

Global Trade Item Number.

review[StoreReview!]!

Array with review information.

aggregateRatingStoreAggregateRating!

Aggregate ratings data.

isVariantOfStoreProductGroup!

Indicates product group related to this product.

additionalProperty[StorePropertyValue!]!

Array of additional properties.

StoreProductConnectionโ€‹

Product connection pagination information.

Queried by allProducts.

FieldArgumentTypeDescription
pageInfoStorePageInfo!

Product connection page information.

edges[StoreProductEdge!]!

Array with product connection page edges.

StoreProductEdgeโ€‹

Product pagination edge.

FieldArgumentTypeDescription
nodeStoreProduct!

Product pagination node.

cursorString!

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.

FieldArgumentTypeDescription
hasVariant[StoreProduct!]!

Array of variants related to product group. Variants are equivalent to VTEX SKUs.

productGroupIDString!

Product group ID.

nameString!

Product group name.

additionalProperty[StorePropertyValue!]!

Array of additional properties.

StorePropertyValueโ€‹

Properties that can be associated with products and products groups.

FieldArgumentTypeDescription
propertyIDString!

Property id. This propert changes according to the content of the object.

valueObjectOrString!

Property value. May hold a string or the string representation of an object.

nameString!

Property name.

valueReferenceString!

Specifies the nature of the value

StoreReviewโ€‹

Information of a given review.

FieldArgumentTypeDescription
reviewRatingStoreReviewRating!

Review rating information.

authorStoreAuthor!

Review author.

StoreReviewRatingโ€‹

Information of a given review rating.

FieldArgumentTypeDescription
ratingValueFloat!

Rating value.

bestRatingFloat!

Best rating value.

StoreSearchResultโ€‹

Search result.

Queried by search.

FieldArgumentTypeDescription
productsStoreProductConnection!

Search result products.

facets[StoreFacet!]!

Array of search result facets.

suggestionsStoreSuggestions!

Search result suggestions.

StoreSeoโ€‹

Search Engine Optimization (SEO) tags data.

FieldArgumentTypeDescription
titleString!

Title tag.

titleTemplateString!

Title template tag.

descriptionString!

Description tag.

canonicalString!

Canonical tag.

StoreSessionโ€‹

Session information.

Mutated by updateSession.

FieldArgumentTypeDescription
channelString

Session channel.

countryString

Session country.

postalCodeString

Session postal code.

StoreSuggestionTermโ€‹

Suggestion term.

FieldArgumentTypeDescription
valueString!

The term.

countInt!

Its occurrences count.

StoreSuggestionsโ€‹

Suggestions information.

FieldArgumentTypeDescription
terms[String!]

Array with suggestion terms.

products[StoreProduct!]

Array with suggestion products' information.

Didn't find your answers? Ask the Community. For documentation suggestions, submit your feedback.

JOIN THE COMMUNITY