Documentation
Feedback
Guides
Storefront Development

Storefront Development
FastStoreFastStore API
Inputs

IGeoCoordinates

FieldTypeDescription
latitudeFloat!
The latitude of the geographic coordinates.
longitudeFloat!
The longitude of the geographic coordinates.

IPersonNewsletter

Person data input to the newsletter.
FieldTypeDescription
nameString!
Person's name.
emailString!
Person's email.

IShippingItem

Shipping Simulation item input.
FieldTypeDescription
idString!
ShippingItem ID / Sku.
quantityInt!
Number of items.
sellerString!
Seller responsible for the ShippingItem.

IStoreCart

Shopping cart input.
FieldTypeDescription
orderIStoreOrder!
Order information, including orderNumber, acceptedOffer and shouldSplitItem.

IStoreCurrency

FieldTypeDescription
codeString!
Currency code (e.g: USD).
symbolString!
Currency symbol (e.g: $).

IStoreDeliveryMode

FieldTypeDescription
deliveryChannelString!
The delivery channel information of the session.
deliveryMethodString!
The delivery method information of the session.
deliveryWindowIStoreDeliveryWindow
The delivery window information of the session.

IStoreDeliveryWindow

Delivery window information.
FieldTypeDescription
startDateString!
The delivery window start date information.
endDateString!
The delivery window end date information.

IStoreGeoCoordinates

FieldTypeDescription
latitudeFloat!
The latitude of the geographic coordinates.
longitudeFloat!
The longitude of the geographic coordinates.

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.
shouldSplitItemBoolean
Indicates whether or not items with attachments should be split.

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 search facet input.
FieldTypeDescription
keyString!
Selected search facet key.
valueString!
Selected search facet value.

IStoreSession

Session input.
FieldTypeDescription
localeString!
Session input locale.
currencyIStoreCurrency!
Session input currency.
countryString!
Session input country.
channelString
Session input channel.
deliveryModeIStoreDeliveryMode
Session input delivery mode.
addressTypeString
Session input address type.
postalCodeString
Session input postal code.
geoCoordinatesIStoreGeoCoordinates
Session input geoCoordinates.
personIStorePerson
Session input person.
Contributors
1
Photo of the contributor
+ 1 contributors
Was this helpful?
Yes
No
Suggest edits (Github)
Contributors
1
Photo of the contributor
+ 1 contributors
On this page