Vtex Placeorder 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": "PlaceOrder",
"method": "PUT",
"path": "/api/checkout/pub/orders",
"summary": "VTex Place order",
"requestExamples": [],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"example": {
"orderForm": null,
"transactionData": {
"merchantTransactions": [
{
"id": "MYSTORE",
"transactionId": "296D6D245C17437E823EB77E403FC88D",
"merchantName": "MYSTORE",
"payments": [
{
"paymentSystem": 6,
"bin": null,
"accountId": "12",
"tokenId": null,
"value": 34390,
"referenceValue": 34390,
"giftCardRedemptionCode": null,
"giftCardProvider": null,
"giftCardId": null
}
]
}
],
"receiverUri": "https://mystore.vtexpayments.com.br/split/1146512005522/payments",
"gatewayCallbackTemplatePath": "/checkout/gatewayCallback/1146512005522/{messageCode}"
},
"orders": [
{
"orderId": "1146512005522-01",
"orderGroup": "1146512005522",
"state": null,
"isCheckedIn": false,
"sellerOrderId": "00-1146512005522-01",
"storeId": "1",
"checkedInPickupPointId": "21",
"value": 34390,
"items": [
{
"uniqueId": "9D6E447B3FF64CEDA33B17C01379C119",
"id": "2",
"productId": "2",
"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,
"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": 1,
"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
}
]
}
}
],
"sellers": [
{
"id": "1",
"name": "Tracking QA",
"logo": "Logo"
}
],
"totals": [
{
"id": "Items",
"name": "Total dos Itens",
"value": 32890
},
{
"id": "Discounts",
"name": "Total dos Descontos",
"value": 0
},
{
"id": "Shipping",
"name": "Total do Frete",
"value": 1500
},
{
"id": "Tax",
"name": "Total da Taxa",
"value": 0
}
],
"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
},
"ratesAndBenefitsData": {
"rateAndBenefitsIdentifiers": [],
"teaser": []
},
"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": []
},
"paymentData": {
"giftCards": [],
"transactions": [
{
"isActive": true,
"transactionId": "296D6D245C17437E823EB77E403FC88D",
"merchantName": "MYSTORE",
"payments": [
{
"paymentSystem": 6,
"bin": null,
"accountId": "12",
"tokenId": null,
"value": 34390,
"referenceValue": 34390,
"giftCardRedemptionCode": null,
"giftCardProvider": null,
"giftCardId": null
}
],
"sharedTransaction": false
}
]
},
"clientPreferencesData": null,
"commercialConditionData": null,
"giftRegistryData": null,
"marketingData": null,
"storePreferencesData": {
"countryCode": "BRA",
"saveUserData": false,
"timeZone": "E. South America Standard Time",
"currencyCode": "BRL",
"currencyLocale": 1046,
"currencySymbol": "R$",
"currencyFormatInfo": {
"currencyDecimalDigits": 2,
"currencyDecimalSeparator": ",",
"currencyGroupSeparator": ".",
"currencyGroupSize": 3,
"startsWithCurrencySymbol": true
}
},
"openTextField": {
"value": null
},
"invoiceData": null,
"itemMetadata": {
"items": [
{
"id": "2",
"seller": "1",
"name": "Chopp Brahma Claro 30L",
"skuName": "Chopp Brahma Claro 30L",
"productId": "2",
"refId": "CBC30L",
"ean": null,
"imageUrl": "http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000",
"detailUrl": "/chopp-brahma-claro-30l/p",
"assemblyOptions": []
}
]
},
"taxData": null,
"customData": null,
"hooksData": null,
"changeData": null,
"subscriptionData": null,
"salesChannel": "1",
"followUpEmail": "6c10d76b5170456d89823b38b7c8f6ac@ct.vtex.com.br",
"creationDate": "2021-07-13T18:33:25.3029443Z",
"lastChange": "2021-07-13T18:33:27.736557Z",
"timeZoneCreationDate": "2021-07-13T15:33:25.3029443",
"timeZoneLastChange": "2021-07-13T15:33:27.736557",
"isCompleted": false,
"hostName": "mystore",
"merchantName": null,
"userType": "User type",
"roundingError": 0,
"allowEdition": false,
"allowCancellation": false,
"isUserDataVisible": true,
"allowChangeSeller": false,
"orderFormCreationDate": "2021-07-13T18:33:25.1313373Z"
}
],
"salesAssociateData": {
"salesAssociateId": "seller123"
}
}
}
]
}