Vtex Transactiondetails 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": "TransactionDetails",
"method": "GET",
"path": "/api/pvt/transactions/{transactionId}",
"summary": "VTex Get transaction details",
"requestExamples": [],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"example": {
"id": "D3640578F8124C50CB42BD3F8D282CD9",
"transactionId": "D3640578F8124C50CB42BD3F8D282CD9",
"referenceKey": "505288",
"interactions": {
"href": "/api/pvt/transactions/D3640578F8124C50CB42BD3F8D282CD9/interactions"
},
"settlements": {
"href": "/api/pvt/transactions/D3640578F8124C50CB42BD3F8D282CD9/settlements"
},
"payments": {
"href": "/api/pvt/transactions/D3640578F8124C50CB42BD3F8D282CD9/payments"
},
"refunds": {
"href": "/api/pvt/transactions/D3640578F8124C50CB42BD3F8D282CD9/refunds"
},
"cancellations": {
"href": "/api/pvt/transactions/D3640578F8124C50CB42BD3F8D282CD9/cancellations"
},
"capabilities": {
"href": "/api/pvt/transactions/D3640578F8124C50CB42BD3F8D282CD9/capabilities"
},
"timeoutStatus": 0,
"totalRefunds": 0,
"status": "Finished",
"value": 61400,
"receiverUri": null,
"startDate": "2023-06-02T17:04:19",
"authorizationToken": "0C825428F9804701A8DCF2BE9E0968C4",
"authorizationDate": "2023-06-02T17:04:24",
"commitmentToken": "1E25BAB9A8F84DBC8A5E4AC26A0A534H",
"commitmentDate": "2023-06-02T17:05:44",
"refundingToken": null,
"refundingDate": null,
"cancelationToken": null,
"cancelationDate": null,
"fields": [
{
"name": "owner",
"value": "vtexappkey-appvtex"
},
{
"name": "conditions",
"value": "[{\"id\":\"1\",\"value\":609.0}]"
},
{
"name": "postbackStatusUrl",
"value": "https://oms.vtexcommercestable.com.br/api/oms/pvt/orders/order-group/1336650505288/notifications/transaction-status?an=cosmetics2"
},
{
"name": "shopperInteraction",
"value": "ecommerce"
},
{
"name": "lastTransitionDate",
"value": "6/2/2023 5:05:44 PM"
},
{
"name": "TotalTimeSpentInTransitionsUntilThisTransition",
"value": "87581.1868"
},
{
"name": "channel",
"value": "COSMETICS2"
},
{
"name": "salesChannel",
"value": "1"
},
{
"name": "parentMerchant",
"value": "a8b27fb4-6516-4cc0-82b6-a5f2b011e6e2"
},
{
"name": "orderId",
"value": "1336650505288"
},
{
"name": "ip",
"value": "152.248.55.27"
},
{
"name": "sessionId",
"value": "09d7f6d1-53fe-4e6f-95de-2a0c38c8c0d0"
},
{
"name": "macId",
"value": "89314737-9d03-4607-9814-61ed1a59b0bd"
},
{
"name": "userAgent",
"value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/113.0.0.0 Safari/537.36"
},
{
"name": "acceptHeader",
"value": "application/json,text/plain,*/*"
},
{
"name": "deviceInfo",
"value": "{\"screenWidth\":1920,\"screenHeight\":1080,\"colorDepth\":24,\"timeZoneOffset\":180,\"language\":\"en\",\"javaEnabled\":false,\"acceptHeader\":\"application/json,text/plain,*/*\",\"userAgent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/113.0.0.0 Safari/537.36\",\"ipAddress\":\"152.248.55.27\",\"sourceApplication\":\"vcs.checkout-ui@v6.83.1\",\"installedApplications\":[\"payment-provider\",\"adyen-authentication-app\",\"cielo-authentication-app\",\"pix-payment\",\"google-pay-payment-authorization-app\",\"apple-pay-payment-authorization-app\"]}"
},
{
"name": "cart",
"value": "{\"items\":[{\"id\":\"9\",\"name\":\"Matcha Butter Conditioning Mask 100 ml\",\"value\":60900,\"quantity\":1,\"priceTags\":[],\"components\":null,\"commission\":0.0,\"freightCommission\":0.0,\"sellerChain\":null,\"shippingDiscount\":0,\"discount\":0,\"refId\":null,\"productId\":\"4\",\"sellingPrice\":609.0,\"sellerId\":\"vtxfqw4064\",\"dockId\":\"doca_principal\",\"categoryId\":\"1\",\"categoryName\":\"Treatments\",\"deliveryChannel\":\"delivery\",\"deliveryType\":\"Normal\",\"deliverySlaInMinutes\":4320,\"deliveryWindow\":null,\"tax\":0,\"freight\":500}],\"sellers\":[{\"id\":\"vtxfqw4064\",\"name\":\"\u300c\u30db\u30ef\u30a4\u30c8\u30ec\u30fc\u30d9\u30eb\u300d\u30f4\u30a3\u30c8\u30eb\u306e\u30b7\u30e7\u30c3\u30d7\",\"documentType\":\"CNPJ\",\"document\":null}],\"freight\":500,\"shippingdate\":null,\"shippingestimated\":\"3bd\",\"orderUrl\":\"http://vtexdayhackaton--cosmetics2.myvtex.com/admin/checkout/#/orders?q=1336650505288\",\"tax\":0,\"isGiftRegistry\":null,\"giftRegistryDescription\":null,\"giftRegistryId\":null,\"isPickupStore\":null,\"isCallCenter\":null}"
},
{
"name": "clientProfileData",
"value": "{\"email\":\"teste@teste.com\",\"firstName\":\"teste\",\"lastName\":\"teste\",\"document\":\"01234567890\",\"phone\":\"+5511999999999\",\"corporateName\":null,\"tradeName\":null,\"corporateDocument\":null,\"stateInscription\":null,\"postalCode\":\"22250-040\",\"address\":{\"receiverName\":\"test\",\"postalCode\":\"22250040\",\"city\":\"Rio de Janeiro\",\"state\":\"RJ\",\"country\":\"BRA\",\"street\":\"Praia Botafogo\",\"number\":\"123\",\"neighborhood\":\"Botafogo\",\"complement\":null,\"reference\":null},\"gender\":null,\"birthDate\":null,\"createdDate\":\"2023-06-01T03:09:50.408969Z\",\"corporatePhone\":null,\"isCorporate\":false,\"documentType\":\"cpf\",\"id\":\"db324ab8-fd91-40b3-b31f-c63b3b602495\"}"
},
{
"name": "shippingData",
"value": "{\"receiverName\":\"test\",\"postalCode\":\"22250040\",\"city\":\"Rio de Janeiro\",\"state\":\"RJ\",\"country\":\"BRA\",\"street\":\"Praia Botafogo\",\"number\":\"123\",\"neighborhood\":\"Botafogo\",\"complement\":null,\"reference\":null}"
},
{
"name": "retainPartialSettlements",
"value": "False"
}
],
"shopperInteraction": "ecommerce",
"ipAddress": "152.248.55.27",
"sessionId": "09d7f6d1-53fe-4e6f-95de-2a0c38c8c0d0",
"macId": "89314737-9d03-4607-9814-61ed1a59b0bd",
"vtexFingerprint": null,
"chargeback": null,
"whiteSignature": null,
"owner": "vtexappkey-appvtex",
"orderId": "1336650505288",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.0 Safari/605.1.15",
"acceptHeader": "application/json,text/plain,*/*",
"antifraudTid": null,
"antifraudResponse": null,
"antifraudReference": null,
"antifraudAffiliationId": null,
"channel": "COSMETICS2",
"salesChannel": "1",
"urn": null,
"softDescriptor": "company_name_description_code",
"markedForRecurrence": false,
"buyer": {
"firstName": "HUXXXXX",
"lastName": "PERXXXX",
"documentType": "cpf",
"document": "169XXXXX718",
"email": "test@test.com",
"address": "BRA 2163XXXXXXXXzile 58",
"phone": "219XXXX695"
}
}
}
]
}