Inputs
IGeoCoordinates
Field | Type | Description | |
---|---|---|---|
latitude | Float! | The latitude of the geographic coordinates. | |
longitude | Float! | The longitude of the geographic coordinates. |
IPersonNewsletter
Person data input to the newsletter.
Field | Type | Description | |
---|---|---|---|
name | String! | Person's name. | |
String! | Person's email. |
IShippingItem
Shipping Simulation item input.
Field | Type | Description | |
---|---|---|---|
id | String! | ShippingItem ID / Sku. | |
quantity | Int! | Number of items. | |
seller | String! | Seller responsible for the ShippingItem. |
IStoreCart
Shopping cart input.
Field | Type | Description | |
---|---|---|---|
order | IStoreOrder! | Order information, including orderNumber , acceptedOffer and shouldSplitItem . |
IStoreCurrency
Field | Type | Description | |
---|---|---|---|
code | String! | Currency code (e.g: USD). | |
symbol | String! | Currency symbol (e.g: $). |
IStoreDeliveryMode
Field | Type | Description | |
---|---|---|---|
deliveryChannel | String! | The delivery channel information of the session. | |
deliveryMethod | String! | The delivery method information of the session. | |
deliveryWindow | IStoreDeliveryWindow | The delivery window information of the session. |
IStoreDeliveryWindow
Delivery window information.
Field | Type | Description | |
---|---|---|---|
startDate | String! | The delivery window start date information. | |
endDate | String! | The delivery window end date information. |
IStoreGeoCoordinates
Field | Type | Description | |
---|---|---|---|
latitude | Float! | The latitude of the geographic coordinates. | |
longitude | Float! | The longitude of the geographic coordinates. |
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. | |
shouldSplitItem | Boolean | Indicates whether or not items with attachments should be split. |
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 search facet input.
Field | Type | Description | |
---|---|---|---|
key | String! | Selected search facet key. | |
value | String! | Selected search facet value. |
IStoreSession
Session input.
Field | Type | Description | |
---|---|---|---|
locale | String! | Session input locale. | |
currency | IStoreCurrency! | Session input currency. | |
country | String! | Session input country. | |
channel | String | Session input channel. | |
deliveryMode | IStoreDeliveryMode | Session input delivery mode. | |
addressType | String | Session input address type. | |
postalCode | String | Session input postal code. | |
geoCoordinates | IStoreGeoCoordinates | Session input geoCoordinates. | |
person | IStorePerson | Session input person. |