VTEX · Example Payload

Vtex Getprospects Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Getprospects 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": "GetProspects",
  "method": "GET",
  "path": "/api/storage/profile-system/prospects",
  "summary": "VTex Get prospects",
  "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": "3*****",
                "city": "P*****",
                "country": "USA",
                "street": "F*****",
                "number": "9****",
                "complement": "",
                "receiverName": "J*** D**",
                "geoCoordinate": []
              }
            ],
            "paymentData": {
              "availableAccounts": [],
              "availableTokens": [],
              "transactions": null,
              "giftCards": [],
              "giftCardMessages": [],
              "numberOfPaymentErrors": 0,
              "numberOfDeniedTransactions": 0,
              "lastDeniedTransaction": null
            },
            "contacts": [
              {
                "contactId": "0",
                "email": "",
                "firstName": "J***",
                "lastName": "D**",
                "phone": "",
                "document": "",
                "documentType": ""
              }
            ],
            "invoiceSubject": {
              "invoiceSubjectId": "0",
              "email": "j***@m***.c**",
              "firstName": "J***",
              "lastName": "D**",
              "phone": "1**********"
            },
            "email": "j***@m***.c**",
            "firstName": "J***",
            "lastName": "D**",
            "document": "1**********",
            "cellPhone": "1**********",
            "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
          }
        }
      ]
    }
  ]
}