VTEX · Example Payload

Vtex Getunmaskedprospect Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Getunmaskedprospect 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": "GetUnmaskedProspect",
  "method": "GET",
  "path": "/api/storage/profile-system/prospects/{prospectId}/unmask",
  "summary": "VTex Get unmasked prospect",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "id": "98478f6b-d025-4f35-a560-dd1ee7a6f26e",
        "document": {
          "availableAddresses": [
            {
              "disposable": true,
              "userId": "98478f6b-d025-4f35-a560-dd1ee7a6f26e",
              "addressName": "customerAddressId",
              "addressType": "residential",
              "postalCode": "32137",
              "city": "Palm Coast",
              "country": "USA",
              "street": "Fifth St.",
              "number": "9538",
              "complement": "",
              "receiverName": "Jane Doe",
              "geoCoordinate": []
            }
          ],
          "paymentData": {
            "availableAccounts": [],
            "availableTokens": [],
            "transactions": null,
            "giftCards": [],
            "giftCardMessages": [],
            "numberOfPaymentErrors": 0,
            "numberOfDeniedTransactions": 0,
            "lastDeniedTransaction": null
          },
          "contacts": [
            {
              "contactId": "0",
              "email": "",
              "firstName": "Jane",
              "lastName": "Doe",
              "phone": "",
              "document": "",
              "documentType": ""
            }
          ],
          "invoiceSubject": {
            "invoiceSubjectId": "0",
            "email": "jane@mail.com",
            "firstName": "Jane",
            "lastName": "Doe",
            "phone": "12345678910"
          },
          "email": "jane@mail.com",
          "firstName": "Jane",
          "lastName": "Doe",
          "document": "5397eefef23741d4976ebdf772cc42e0",
          "cellPhone": "12345678910",
          "isPJ": false,
          "customerCode": "5397eefe-f237-41d4-976e-bdf772cc42e0"
        },
        "meta": {
          "version": "af9117e9-4169-46ee-ab4b-d4b17b881488",
          "author": "d6d8269f-e7cc-4e4b-8b89-3b46a1407937",
          "creationDate": "2023-10-25T13:59:52.7633627+00:00",
          "lastUpdateDate": "2023-10-25T14:02:45.7277154+00:00",
          "expirationDate": null
        }
      }
    }
  ]
}