Inputs
IStoreCartโ
Shopping cart input.
Used as input by validateCart
.
Field | Type | Description | |
---|---|---|---|
order | IStoreOrder! | Order information, including |
IStoreCurrencyโ
Field | Type | Description | |
---|---|---|---|
code | String! | Currency code (e.g., USD) | |
symbol | String! | Currency symbol (e.g., $) |
IStoreImageโ
Image input.
Field | Type | Description | |
---|---|---|---|
url | String! | Image input URL. | |
alternateName | String! | Alias for the input image. |
IStoreOfferโ
Offer input.
Field | Type | Description | |
---|---|---|---|
price | Float! | Also known as spot price. | |
listPrice | Float! | This is displayed as the "from" price in the context of promotions' price comparison. This may change before it reaches the shelf. | |
seller | IStoreOrganization! | Seller responsible for the offer. | |
itemOffered | IStoreProduct! | Information on the item being offered. | |
quantity | Int! | Number of items offered. |
IStoreOrderโ
Order input.
Field | Type | Description | |
---|---|---|---|
orderNumber | String! | ID of the order in VTEX order management. | |
acceptedOffer | [IStoreOffer!]! | Array with information on each accepted offer. |
IStoreOrganizationโ
Organization input.
Field | Type | Description | |
---|---|---|---|
identifier | String! | Organization ID. |
IStorePersonโ
Client profile data.
Field | Type | Description | |
---|---|---|---|
id | String! | Client ID. | |
String! | Client email. | ||
givenName | String! | Client first name. | |
familyName | String! | 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.
Field | Type | Description | |
---|---|---|---|
sku | String! | Stock Keeping Unit. Merchant-specific ID for the product. | |
name | String! | Product name. | |
image | [IStoreImage!]! | Array of product images. | |
additionalProperty | [IStorePropertyValue!] | Custom Product Additional Properties. |
IStorePropertyValueโ
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 |
IStoreSelectedFacetโ
Selected facet input.
Used as input by product
and search
.
Field | Type | Description | |
---|---|---|---|
key | String! | ||
value | String! |
IStoreSessionโ
Session input.
Used as input by updateSession
.
Field | Type | Description | |
---|---|---|---|
locale | String! | Session input locale. | |
currency | IStoreCurrency! | Session input currency. | |
country | String! | Session input country. | |
channel | String | Session input channel. | |
postalCode | String | Session input postal code. | |
person | IStorePerson | Session input postal code. |