Vtex 3Sendadditionaldata 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": "3.SendAdditionalData",
"method": "POST",
"path": "/api/pvt/transactions/{transactionId}/additional-data",
"summary": "VTex 3. Send additional data",
"requestExamples": [
{
"contentType": "application/json",
"example": [
{
"name": "cart",
"value": "{\"items\":[{\"id\":\"6257034\",\"name\":\"Tamanco Couro Preto Po\u00e1\",\"value\":5999,\"quantity\":1,\"priceTags\":[],\"components\":null,\"commission\":0.0,\"freightCommission\":0.0,\"sellerChain\":null,\"shippingDiscount\":0,\"discount\":0,\"refId\":\"C503YC002_34\",\"productId\":\"6257000\",\"sellingPrice\":59.99,\"sellerId\":\"1\",\"dockId\":\"999800000-5\",\"categoryId\":\"18\",\"categoryName\":\"Tamanco\",\"deliveryChannel\":\"delivery\",\"deliveryType\":\"Convencional\",\"deliverySlaInMinutes\":5760,\"deliveryWindow\":null,\"tax\":0,\"freight\":167},{\"id\":\"7136034\",\"name\":\"Sand\u00e1lia Off White Espadrile Salto Forrado\",\"value\":5999,\"quantity\":1,\"priceTags\":[],\"components\":null,\"commission\":0.0,\"freightCommission\":0.0,\"sellerChain\":null,\"shippingDiscount\":0,\"discount\":0,\"refId\":\"S5146R881_34\",\"productId\":\"7136000\",\"sellingPrice\":59.99,\"sellerId\":\"1\",\"dockId\":\"999800000-5\",\"categoryId\":\"12\",\"categoryName\":\"Anabela\",\"deliveryChannel\":\"delivery\",\"deliveryType\":\"Convencional\",\"deliverySlaInMinutes\":5760,\"deliveryWindow\":null,\"tax\":0,\"freight\":166},{\"id\":\"8305038\",\"name\":\"Tamanco Caramelo Salto Fachete\",\"value\":9999,\"quantity\":1,\"priceTags\":[],\"components\":null,\"commission\":0.0,\"freightCommission\":0.0,\"sellerChain\":null,\"shippingDiscount\":0,\"discount\":0,\"refId\":\"S534IZ012_38\",\"productId\":\"8305000\",\"sellingPrice\":99.99,\"sellerId\":\"1\",\"dockId\":\"999800000-5\",\"categoryId\":\"18\",\"categoryName\":\"Tamanco\",\"deliveryChannel\":\"delivery\",\"deliveryType\":\"Convencional\",\"deliverySlaInMinutes\":5760,\"deliveryWindow\":null,\"tax\":0,\"freight\":166},{\"id\":\"7641034\",\"name\":\"T\u00eanis Slip On Couro Preto Recorte\",\"value\":9999,\"quantity\":1,\"priceTags\":[],\"components\":null,\"commission\":0.0,\"freightCommission\":0.0,\"sellerChain\":null,\"shippingDiscount\":0,\"discount\":0,\"refId\":\"C524B9002_34\",\"productId\":\"7641000\",\"sellingPrice\":99.99,\"sellerId\":\"coinshop\",\"dockId\":\"0405\",\"categoryId\":\"30\",\"categoryName\":\"Cl\u00e1ssico\",\"deliveryChannel\":\"delivery\",\"deliveryType\":\"Correios - PAC\",\"deliverySlaInMinutes\":18720,\"deliveryWindow\":null,\"tax\":0,\"freight\":7138},{\"id\":\"8278038\",\"name\":\"T\u00eanis Slip Caramelo Matelass\u00ea\",\"value\":5999,\"quantity\":1,\"priceTags\":[],\"components\":null,\"commission\":0.0,\"freightCommission\":0.0,\"sellerChain\":null,\"shippingDiscount\":0,\"discount\":0,\"refId\":\"S534IR012_38\",\"productId\":\"8278000\",\"sellingPrice\":59.99,\"sellerId\":\"coinmarket\",\"dockId\":\"0571\",\"categoryId\":\"32\",\"categoryName\":\"Slip On\",\"deliveryChannel\":\"delivery\",\"deliveryType\":\"PAC\",\"deliverySlaInMinutes\":14400,\"deliveryWindow\":null,\"tax\":0,\"freight\":7090}],\"sellers\":[{\"id\":\"1\",\"name\":\"CONSTANCE\",\"documentType\":\"CNPJ\",\"document\":\"30901791000191\"},{\"id\":\"coinshop\",\"name\":\"coinshop\",\"documentType\":\"CNPJ\",\"document\":\"48275547000126\"},{\"id\":\"coinmarket\",\"name\":\"coinmarket\",\"documentType\":\"CNPJ\",\"document\":\"48314133000169\"}],\"freight\":14727,\"shippingdate\":null,\"shippingestimated\":\"4bd\",\"orderUrl\":\"http://www.constance.com.br/admin/checkout/#/orders?q=1373160984904\",\"tax\":0,\"isGiftRegistry\":null,\"giftRegistryDescription\":null,\"giftRegistryId\":null,\"isPickupStore\":null,\"isCallCenter\":null}"
},
{
"name": "clientProfileData",
"value": "{\"email\":\"test@test.com\",\"firstName\":\"Izidio\",\"lastName\":\"Test Trace\",\"document\":\"111111111\",\"phone\":\"+56987654321\",\"corporateName\":null,\"tradeName\":null,\"corporateDocument\":null,\"stateInscription\":\"Exento\",\"postalCode\":\"8320000\",\"address\":{\"receiverName\":\"wqqw weqw\",\"postalCode\":\"8320000\",\"city\":\"wdade\",\"state\":\"Regi\u00f3n Metropolitana\",\"country\":\"CHL\",\"street\":\"asdafd\",\"number\":\"sadas\",\"neighborhood\":\"Santiago\",\"complement\":\"604\",\"reference\":\"efa\"},\"gender\":null,\"birthDate\":null,\"createdDate\":null,\"corporatePhone\":null,\"isCorporate\":false,\"documentType\":\"rutCHL\",\"id\":\"d48a1cd3-c04e-4949-a275-df4b197a7ec9\"}"
}
]
}
],
"responseExamples": []
}