Vtex Items Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathsummaryrequestExamplesresponseExamples
Example Payload
{
"operationId": "Items",
"method": "POST",
"path": "/api/checkout/pub/orderForm/{orderFormId}/items",
"summary": "VTex Add cart items",
"requestExamples": [],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"example": {
"orderFormId": "ede846222cd44046ba6c638442c3505a",
"salesChannel": "1",
"loggedIn": false,
"isCheckedIn": false,
"storeId": "1",
"allowManualPrice": false,
"canEditData": true,
"userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
"profileProvider": "VTEX",
"availableAccounts": [],
"availableAddresses": [
{
"addressType": "residential",
"receiverName": "Clark Kent",
"addressId": "666c2e830bd9474ab6f6cc53fb6dd2d2",
"isDisposable": true,
"postalCode": "70386000",
"city": "Bras\u00edlia",
"state": "DF",
"country": "BRA",
"street": "Rua da minha casa",
"number": "123",
"neighborhood": "Copacabana",
"complement": "15\u00ba andar",
"reference": null,
"geoCoordinates": [
-47.924747467041016,
-15.832582473754883
]
}
],
"userType": "User type",
"ignoreProfileData": false,
"value": 34390,
"messages": [],
"items": [
{
"uniqueId": "9D6E447B3FF64CEDA33B17C01379C119",
"id": "2",
"productId": "2005",
"productRefId": "1",
"refId": "CBC30L",
"ean": null,
"name": "Chopp Brahma Claro 30L",
"skuName": "Chopp Brahma Claro 30L",
"modalType": null,
"parentItemIndex": null,
"parentAssemblyBinding": null,
"assemblies": [],
"priceValidUntil": "2022-07-13T18:30:46Z",
"tax": 0,
"taxCode": "54WC8ZN6K8",
"price": 32890,
"listPrice": 49900,
"manualPrice": null,
"manualPriceAppliedBy": null,
"sellingPrice": 32890,
"rewardValue": 0,
"isGift": false,
"additionalInfo": {
"dimension": null,
"brandName": "Brahma",
"brandId": "2000000",
"offeringInfo": null,
"offeringType": null,
"offeringTypeId": null
},
"preSaleDate": null,
"productCategoryIds": "/1/",
"productCategories": {
"1": "Bebidas"
},
"quantity": 3,
"seller": "1",
"sellerChain": [
"1"
],
"imageUrl": "http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000",
"detailUrl": "/chopp-brahma-claro-30l/p",
"components": [],
"bundleItems": [],
"attachments": [],
"attachmentOfferings": [],
"offerings": [],
"priceTags": [],
"availability": "available",
"measurementUnit": "un",
"unitMultiplier": 1,
"manufacturerCode": null,
"priceDefinition": {
"calculatedSellingPrice": 32890,
"total": 32890,
"sellingPrices": [
{
"value": 32890,
"quantity": 1
}
]
}
}
],
"selectableGifts": [],
"totalizers": [
{
"id": "Items",
"name": "Total dos Itens",
"value": 15000
}
],
"shippingData": {
"address": {
"addressType": "residential",
"receiverName": "Clark Kent",
"addressId": "teste",
"isDisposable": true,
"postalCode": "70386000",
"city": "Bras\u00edlia",
"state": "DF",
"country": "BRA",
"street": "Rua da minha casa",
"number": "123",
"neighborhood": "Copacabana",
"complement": "15\u00ba andar",
"reference": null,
"geoCoordinates": [
-47.924747467041016,
-15.832582473754883
]
},
"logisticsInfo": [
{
"itemIndex": 0,
"selectedSla": "Normal",
"selectedDeliveryChannel": "delivery",
"addressId": "teste",
"slas": [
{
"id": "Normal",
"deliveryChannel": "delivery",
"name": "Normal",
"deliveryIds": [
{
"courierId": "1",
"warehouseId": "1_1",
"dockId": "1",
"courierName": "Transportadora",
"quantity": 1,
"kitItemDetails": []
}
],
"shippingEstimate": "3bd",
"shippingEstimateDate": null,
"lockTTL": "10d",
"availableDeliveryWindows": [],
"deliveryWindow": null,
"price": 1500,
"listPrice": 1500,
"tax": 0,
"pickupStoreInfo": {
"isPickupStore": false,
"friendlyName": null,
"address": null,
"additionalInfo": null,
"dockId": null
},
"pickupPointId": null,
"pickupDistance": 0,
"polygonName": null,
"transitTime": "3bd"
}
],
"shipsTo": [
"BRA",
"COL",
"USA"
],
"itemId": "2",
"deliveryChannels": [
{
"id": "delivery"
},
{
"id": "pickup-in-point"
}
]
}
],
"selectedAddresses": [
{
"addressType": "residential",
"receiverName": "Clark Kent",
"addressId": "teste",
"isDisposable": true,
"postalCode": "12345000",
"city": "Rio de Janeiro",
"state": "RJ",
"country": "BRA",
"street": "Rua da minha casa",
"number": "123",
"neighborhood": "Copacabana",
"complement": "15\u00ba andar",
"reference": null,
"geoCoordinates": [
-47.924747467041016,
-15.832582473754883
]
}
],
"availableAddresses": [
{
"addressType": "residential",
"receiverName": "Clark Kent",
"addressId": "teste",
"isDisposable": true,
"postalCode": "12345000",
"city": "Rio de Janeiro",
"state": "RJ",
"country": "BRA",
"street": "Rua da minha casa",
"number": "123",
"neighborhood": "Copacabana",
"complement": "15\u00ba andar",
"reference": null,
"geoCoordinates": [
-47.924747467041016,
-15.832582473754883
]
}
],
"pickupPoints": []
},
"clientProfileData": {
"email": "clark.kent@example.com",
"firstName": "Clark",
"lastName": "Kent",
"document": "12345678900",
"documentType": "cpf",
"phone": "+5521998765432",
"corporateName": "company-name",
"tradeName": "trade-name",
"corporateDocument": "12345678000100",
"stateInscription": "12345678",
"corporatePhone": "551100988887777",
"isCorporate": false,
"profileCompleteOnLoading": false,
"profileErrorOnLoading": false,
"customerClass": null
},
"paymentData": {
"installmentOptions": [
{
"paymentSystem": 2,
"bin": null,
"paymentName": null,
"paymentGroupName": null,
"value": 15000,
"installments": [
{
"count": 1,
"hasInterestRate": false,
"interestRate": 0,
"value": 15000,
"total": 15000,
"sellerMerchantInstallments": [
{
"id": "LOJADOBRENO",
"count": 1,
"hasInterestRate": false,
"interestRate": 0,
"value": 15000,
"total": 15000
}
]
},
{
"count": 2,
"hasInterestRate": false,
"interestRate": 0,
"value": 7500,
"total": 15000,
"sellerMerchantInstallments": [
{
"id": "LOJADOBRENO",
"count": 2,
"hasInterestRate": false,
"interestRate": 0,
"value": 7500,
"total": 15000
}
]
}
]
}
],
"paymentSystems": [
{
"id": 2,
"name": "Visa",
"groupName": "creditCardPaymentGroup",
"validator": {
"regex": "^2[1-8]{17}$",
"mask": "9999 9999 9999 9999",
"cardCodeRegex": "^[0-3]{8}$",
"cardCodeMask": "999",
"weights": [
2,
1,
2,
1,
2,
1
],
"useCvv": true,
"useExpirationDate": true,
"useCardHolderName": true,
"useBillingAddress": true
},
"stringId": "2",
"template": "creditCardPaymentGroup-template",
"requiresDocument": false,
"isCustom": false,
"description": "Payment description",
"requiresAuthentication": false,
"dueDate": "2020-03-05T14:59:00.7879306Z",
"availablePayments": null
}
],
"payments": [
{
"paymentSystem": 6,
"bin": null,
"accountId": "12",
"tokenId": null,
"value": 34390,
"referenceValue": 34390,
"giftCardRedemptionCode": null,
"giftCardProvider": null,
"giftCardId": null
}
],
"giftCards": [],
"giftCardMessages": [],
"availableAccounts": [],
"availableTokens": []
},
"marketingData": {
"coupon": "free-shipping",
"utmSource": "app",
"utmMedium": "CPC",
"utmCampaign": "Black friday",
"utmipage": null,
"utmiPart": null,
"utmiCampaign": null
},
"sellers": [
{
"id": "1",
"name": "lojadobreno",
"logo": "Logo"
}
],
"clientPreferencesData": {
"locale": "pt-BR",
"optinNewsLetter": false
},
"commercialConditionData": null,
"storePreferencesData": {
"countryCode": "BRA",
"saveUserData": true,
"timeZone": "E. South America Standard Time",
"currencyCode": "BRL",
"currencyLocale": 1046,
"currencySymboupdate cartl": "R$",
"currencyFormatInfo": {
"currencyDecimalDigits": 2,
"currencyDecimalSeparator": ",",
"currencyGroupSeparator": ".",
"currencyGroupSize": 3,
"startsWithCurrencySymbol": true
}
},
"giftRegistryData": null,
"openTextField": null,
"invoiceData": null,
"customData": null,
"itemMetadata": {
"items": [
{
"id": "1",
"seller": "1",
"name": "Ra\u00e7\u00e3o Royal Canin Feline Urinary 500g",
"skuName": "Ra\u00e7\u00e3o Royal Canin Feline Urinary 500g",
"productId": "1",
"refId": "0001",
"ean": "123456789",
"imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
"detailUrl": "/racao-royal-canin-feline-urinary/p",
"assemblyOptions": []
}
]
},
"hooksData": null,
"ratesAndBenefitsData": {
"rateAndBenefitsIdentifiers": [],
"teaser": []
},
"subscriptionData": null,
"itemsOrdination": {
"criteria": "NAME",
"ascending": true
}
}
}
]
}