VTEX · Example Payload
Vtex Placeorderfromexistingorderform Example
CommerceE-CommerceRetailMarketplacePayments
Vtex Placeorderfromexistingorderform 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": "PlaceOrderFromExistingOrderForm",
"method": "POST",
"path": "/api/checkout/pub/orderForm/{orderFormId}/transaction",
"summary": "VTex Place order from an existing cart",
"requestExamples": [],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"example": {
"orderForm": null,
"transactionData": {
"merchantTransactions": [
{
"id": "STORE",
"transactionId": "62FEDE228E2144649CF67812C4E5ER79",
"merchantName": "STORE",
"payments": [
{
"paymentSystem": 6,
"bin": null,
"accountId": "12",
"value": 15650,
"referenceValue": 15650,
"giftCardRedemptionCode": null,
"giftCardProvider": null,
"giftCardId": null
}
]
}
],
"receiverUri": "https://store.vtexpayments.com.br/split/v976778amgh/payments",
"gatewayCallbackTemplatePath": "/checkout/gatewayCallback/v976778amgh/{messageCode}"
},
"orders": [
{
"orderId": "v976778amgh-01",
"orderGroup": "v976778amgh",
"state": "order-created",
"isCheckedIn": false,
"sellerOrderId": "00-v976778amgh-01",
"storeId": "1",
"value": 15650,
"items": [
{
"uniqueId": "0F93E9C4926A4CD97FDD4C2599BDF9DB",
"id": "2000016",
"productId": "2000002",
"refId": "35-Preto",
"ean": null,
"name": "Produto Sele\u00e7\u00e3o SKU - Lista 35 - Preto",
"skuName": "35 - Preto",
"modalType": null,
"priceValidUntil": "2018-02-16T23:42:44.5467295Z",
"tax": 0,
"price": 15000,
"listPrice": 15000,
"manualPrice": null,
"sellingPrice": 15000,
"rewardValue": 1,
"isGift": false,
"additionalInfo": {
"brandName": "Marca Um",
"brandId": "1",
"offeringInfo": null,
"offeringType": null,
"offeringTypeId": null
},
"preSaleDate": null,
"productCategoryIds": "/12/28/",
"productCategories": {
"12": "Departamento 5",
"28": "Categoria 5-3"
},
"defaultPicker": null,
"handlerSequence": 0,
"handling": false,
"quantity": 1,
"seller": "1",
"imageUrl": "http://store.vteximg.com.br/arquivos/ids/168463-55-55/imagem-modo-lista.png",
"detailUrl": "/produto-selecao-sku-lista/p",
"components": [],
"bundleItems": [],
"attachments": [],
"itemAttachment": {
"name": null,
"content": {}
},
"attachmentOfferings": [],
"offerings": [],
"priceTags": [],
"availability": "available",
"measurementUnit": "un",
"unitMultiplier": 1
}
],
"sellers": [
{
"id": "1",
"name": "Store",
"logo": "Logo"
}
],
"totals": [
{
"id": "Items",
"name": "Total dos Itens",
"value": 15000
},
{
"id": "Discounts",
"name": "Total dos Descontos",
"value": 0
},
{
"id": "Shipping",
"name": "Total do Frete",
"value": 650
},
{
"id": "Tax",
"name": "Total da Taxa",
"value": 0
}
],
"clientProfileData": {
"email": "clark.kent@examplemail.com",
"firstName": "Clark",
"lastName": "Kent",
"document": "12345678900",
"documentType": "cpf",
"phone": "+5500123456789",
"corporateName": "company-name",
"tradeName": "trade-name",
"corporateDocument": "12345678000100",
"stateInscription": "12345678",
"corporatePhone": "551100988887777",
"isCorporate": false,
"profileCompleteOnLoading": false,
"profileErrorOnLoading": false,
"customerClass": null
},
"ratesAndBenefitsData": {
"attachmentId": "ratesAndBenefitsData",
"rateAndBenefitsIdentifiers": [],
"teaser": []
},
"shippingData": {
"attachmentId": "shippingData",
"address": {
"addressType": "residential",
"receiverName": "Marcelo",
"addressId": "49ad09e5fba8434a8ff1e0faa4b60ceb",
"postalCode": "28050987",
"city": "Rio de Janeiro",
"state": "RJ",
"country": "BRA",
"street": "Rua da minha casa",
"number": "123",
"neighborhood": "Copacabana",
"complement": "15\u00ba andar",
"reference": null,
"geoCoordinates": []
},
"logisticsInfo": [
{
"itemIndex": 0,
"selectedSla": "Normal",
"slas": [
{
"id": "n2_2",
"name": "n2_2",
"deliveryIds": [
{
"courierId": "1de4790",
"warehouseId": "1_1",
"dockId": "N2",
"courierName": "N2_2",
"quantity": 1
}
],
"shippingEstimate": "6bd",
"shippingEstimateDate": null,
"lockTTL": "7d",
"availableDeliveryWindows": [
{
"startDateUtc": "2017-03-27T00:00:00+00:00",
"endDateUtc": "2017-03-27T00:00:00+00:00",
"price": 0,
"lisPrice": 0,
"tax": 0
},
{
"startDateUtc": "2017-03-28T00:00:00+00:00",
"endDateUtc": "2017-03-28T00:00:00+00:00",
"price": 0,
"lisPrice": 0,
"tax": 0
}
],
"deliveryWindow": null,
"price": 650,
"listPrice": 650,
"tax": 0,
"pickupStoreInfo": {
"isPickupStore": false,
"friendlyName": null,
"address": null,
"additionalInfo": null,
"dockId": null
}
},
{
"id": "Normal",
"name": "Normal",
"deliveryIds": [
{
"courierId": "2p1t",
"warehouseId": "1_1",
"dockId": "N2",
"courierName": "Post_Test_2",
"quantity": 1
}
],
"shippingEstimate": "6bd",
"shippingEstimateDate": null,
"lockTTL": "7d",
"availableDeliveryWindows": [],
"deliveryWindow": null,
"price": 650,
"listPrice": 650,
"tax": 0,
"pickupStoreInfo": {
"isPickupStore": false,
"friendlyName": null,
"address": null,
"additionalInfo": null,
"dockId": null
}
},
{
"id": "P_T",
"name": "P_T",
"deliveryIds": [
{
"courierId": "1p1t",
"warehouseId": "1_1",
"dockId": "N2",
"courierName": "Post_Teste",
"quantity": 1
}
],
"shippingEstimate": "6bd",
"shippingEstimateDate": null,
"lockTTL": "7d",
"availableDeliveryWindows": [],
"deliveryWindow": null,
"price": 1462,
"listPrice": 1462,
"tax": 0,
"pickupStoreInfo": {
"isPickupStore": false,
"friendlyName": null,
"address": null,
"additionalInfo": null,
"dockId": null
}
},
{
"id": "Econ\u00f4mica",
"name": "Econ\u00f4mica",
"deliveryIds": [
{
"courierId": "2B9C2C7D-7A76-485D-94EF-701D041E448C",
"warehouseId": "1_1",
"dockId": "1_1_1",
"courierName": "Leve 30kg (De: 10000-000 At\u00e9: 25999-999) ",
"quantity": 1
}
],
"shippingEstimate": "20bd",
"shippingEstimateDate": null,
"lockTTL": "7d",
"availableDeliveryWindows": [],
"deliveryWindow": null,
"price": 2265,
"listPrice": 2265,
"tax": 0,
"pickupStoreInfo": {
"isPickupStore": false,
"friendlyName": null,
"address": null,
"additionalInfo": null,
"dockId": null
}
}
],
"shipsTo": [
"BRA"
],
"itemId": "2000016"
}
],
"availableAddresses": [
{
"addressType": "residential",
"receiverName": "Marcelo",
"addressId": "49ad09e5fba8434a8ff1e0faa4b60ceb",
"postalCode": "28050642",
"city": "Rio de Janeiro",
"state": "RJ",
"country": "BRA",
"street": "Rua da minha casa",
"number": "123",
"neighborhood": "Copacabana",
"complement": "15\u00ba andar",
"reference": null,
"geoCoordinates": []
}
]
},
"paymentData": {
"attachmentId": "paymentData",
"transactionId": "62FEDE228E2144649CF67812C4E5DD87",
"payments": [
{
"paymentSystem": 6,
"bin": null,
"accountId": "12",
"tokenId": null,
"value": 34390,
"referenceValue": 34390,
"giftCardRedemptionCode": null,
"giftCardProvider": null,
"giftCardId": null
}
],
"giftCards": [],
"transactions": [
{
"isActive": true,
"transactionId": "62FEDE228E2144649CF67812C4E5DD87",
"merchantName": "STORE",
"payments": [
{
"paymentSystem": 6,
"bin": null,
"accountId": "12",
"tokenId": null,
"value": 34390,
"referenceValue": 34390,
"giftCardRedemptionCode": null,
"giftCardProvider": null,
"giftCardId": null
}
]
}
],
"merchantName": "STORE"
},
"clientPreferencesData": {
"attachmentId": "clientPreferencesData",
"locale": "pt-BR",
"optinNewsLetter": true
},
"giftRegistryData": null,
"marketingData": null,
"storePreferencesData": {
"countryCode": "BRA",
"checkToSavePersonDataByDefault": false,
"templateOptions": {
"toggleCorporate": false
},
"timeZone": "E. South America Standard Time",
"currencyCode": "BRL",
"currencyLocale": 1046,
"currencySymbol": "R$",
"currencyFormatInfo": {
"currencyDecimalDigits": 2,
"currencyDecimalSeparator": ",",
"currencyGroupSeparator": ".",
"currencyGroupSize": 3,
"startsWithCurrencySymbol": true
}
},
"openTextField": {
"attachmentId": "openTextField",
"value": null
},
"changeData": null,
"salesChannel": "1",
"followUpEmail": "f1e7309d88dd4633825ce183d52a50a6@ct.vtex.com.br",
"creationDate": "2017-02-16T23:42:43.9605088Z",
"lastChange": "2017-02-16T23:42:47.62285Z",
"timeZoneCreationDate": "2017-02-16T21:42:43.9605088",
"timeZoneLastChange": "2017-02-16T21:42:47.62285",
"isCompleted": false,
"hostName": "ambienteqa",
"merchantName": null,
"userType": "User type",
"roundingError": 0
}
]
}
}
]
}