VTEX · Example Payload

Vtex Updatepurchaseinformation Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Updatepurchaseinformation 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

Raw ↑ 
{
  "operationId": "UpdatePurchaseInformation",
  "method": "PATCH",
  "path": "/api/storage/profile-system/profiles/{profileId}/purchase-info",
  "summary": "VTex Update purchase information",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "paymentData": {
          "availableAccounts": [
            {
              "accountId": "D09F5E3F01054C959CFC4CB357961ADE",
              "paymentSystem": "2",
              "paymentSystemName": "Visa",
              "cardNumber": "************1111",
              "bin": "44443334",
              "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"
      }
    }
  ],
  "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": "44443334",
                "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": "6f693feb-7354-4a44-af96-3693ed282a2e",
          "author": "7b95bb3d-b567-48b2-b6fa-48b0b6c7f112",
          "creationDate": "2023-10-23T19:22:23.6716469+00:00",
          "lastUpdateDate": "2023-10-24T16:18:25.7338837+00:00",
          "expirationDate": null
        }
      }
    }
  ]
}