VTEX · Example Payload

Vtex Getpurchaseinformation Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Getpurchaseinformation 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": "GetPurchaseInformation",
  "method": "GET",
  "path": "/api/storage/profile-system/profiles/{profileId}/purchase-info",
  "summary": "VTex Get purchase information",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": [
        {
          "id": "d9b946b8-9524-4b2d-96ec-b35d0625c0a7",
          "document": {
            "paymentData": {
              "availableAccounts": [
                {
                  "accountId": "D09F5E3F01054C959CFC4CB357961ADE",
                  "paymentSystem": "2",
                  "paymentSystemName": "Visa",
                  "cardNumber": "************1111",
                  "bin": "44443333",
                  "availableAddresses": [
                    "db267dcc53c14fb2b9a985532dd287bc"
                  ],
                  "expirationDate": "01/2032",
                  "isExpired": false,
                  "accountStatus": null
                }
              ],
              "availableTokens": [],
              "transactions": null,
              "giftCards": [],
              "giftCardMessages": [],
              "numberOfPaymentErrors": 0,
              "numberOfDeniedTransactions": 0,
              "lastDeniedTransaction": null
            },
            "clientPreferences": {
              "userId": "d9b946b8-9524-4b2d-96ec-b35d0625c0a7",
              "localeDefault": "pt-BR",
              "isNewsletterOptIn": true
            },
            "isToSavePersonalData": true,
            "lastUserPurchases": [
              {
                "creationDate": "2023-10-23T19:22:12.8989883Z",
                "orderId": "1370990595750-01",
                "orderGroup": "1370990595750",
                "value": 3498
              }
            ],
            "lastPurchasesAddressId": "db267dcc53c14fb2b9a985532dd287bc"
          },
          "meta": {
            "version": "3117771f-8ea6-4297-a487-07e9b5497bc5",
            "author": "6fd337ba-1e6c-4d3e-aceb-1d8993432193",
            "creationDate": "2023-10-23T19:22:23.6716469+00:00",
            "lastUpdateDate": "2023-10-23T19:22:25.5466348+00:00",
            "expirationDate": null
          }
        }
      ]
    }
  ]
}