Skip to main content

Inputs

IStoreCart

Shopping cart input.

Used as input by validateCart.

FieldTypeDescription
orderIStoreOrder!

Order information, including orderNumber and acceptedOffer.

IStoreCurrency

FieldTypeDescription
codeString!

Currency code (e.g., USD)

symbolString!

Currency symbol (e.g., $)

IStoreImage

Image input.

FieldTypeDescription
urlString!

Image input URL.

alternateNameString!

Alias for the input image.

IStoreOffer

Offer input.

FieldTypeDescription
priceFloat!

Also known as spot price.

listPriceFloat!

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

sellerIStoreOrganization!

Seller responsible for the offer.

itemOfferedIStoreProduct!

Information on the item being offered.

quantityInt!

Number of items offered.

IStoreOrder

Order input.

FieldTypeDescription
orderNumberString!

ID of the order in VTEX order management.

acceptedOffer[IStoreOffer!]!

Array with information on each accepted offer.

IStoreOrganization

Organization input.

FieldTypeDescription
identifierString!

Organization ID.

IStorePerson

Client profile data.

FieldTypeDescription
idString!

Client ID.

emailString!

Client email.

givenNameString!

Client first name.

familyNameString!

Client last name.

IStoreProduct

Product input. 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.

FieldTypeDescription
skuString!

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

nameString!

Product name.

image[IStoreImage!]!

Array of product images.

additionalProperty[IStorePropertyValue!]

Custom Product Additional Properties.

IStorePropertyValue

FieldTypeDescription
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

IStoreSelectedFacet

Selected facet input.

Used as input by product and search.

FieldTypeDescription
keyString!
valueString!

IStoreSession

Session input.

Used as input by updateSession.

FieldTypeDescription
localeString!

Session input locale.

currencyIStoreCurrency!

Session input currency.

countryString!

Session input country.

channelString

Session input channel.

postalCodeString

Session input postal code.

personIStorePerson

Session input postal code.

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

JOIN THE COMMUNITY