Vtex Updateprospect 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": "UpdateProspect",
"method": "PATCH",
"path": "/api/storage/profile-system/prospects/{prospectId}",
"summary": "VTex Update prospect",
"requestExamples": [],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"example": {
"id": "c2cbebba-214e-40b2-b68f-98f862e755d5",
"document": {
"availableAddresses": [
{
"disposable": true,
"userId": "98478f6b-d025-4f35-a560-dd1ee7a6f26e",
"addressName": "Home",
"addressType": "residential",
"postalCode": "32137",
"city": "Palm Coast",
"country": "USA",
"street": "Fifth St.",
"number": "9538",
"complement": "Apartment 2B",
"geoCoordinate": [
"string"
]
}
],
"paymentData": {
"availableAccounts": [
{
"accountId": "D09F5E3F01054C959CFC4CB357961ADE",
"paymentSystem": "2",
"paymentSystemName": "Visa",
"cardNumber": "************1111",
"bin": "44443334",
"availableAddresses": [
"db267dcc53c14fb2b9a985532dd287bc"
],
"expirationDate": "01/2032",
"isExpired": false,
"accountStatus": null
}
],
"availableTokens": [
"12345"
],
"transactions": [
{
"isActive": true,
"transactionId": "418213DE29634837A63DD693A937A696",
"merchantName": "luxstore",
"payments": [
{
"id": "D3DEECAB3C6C4B9EAF8EF4C1FE062FF3",
"paymentSystem": "6",
"paymentSystemName": "Boleto Banc\u00e1rio",
"value": 4450,
"installments": 1,
"referenceValue": 4450,
"cardHolder": null,
"cardNumber": null,
"firstDigits": null,
"lastDigits": null,
"cvv2": null,
"expireMonth": null,
"expireYear": null,
"url": "https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment}",
"giftCardId": null,
"giftCardName": null,
"giftCardCaption": null,
"redemptionCode": null,
"group": "bankInvoice",
"tid": null,
"dueDate": "2019-02-02",
"connectorResponses": {}
}
]
}
],
"giftCards": [
"12345"
],
"giftCardMessages": [
"Message."
],
"numberOfPaymentErrors": 0,
"numberOfDeniedTransactions": 0,
"lastDeniedTransaction": null
},
"contacts": [
{
"contactId": "0",
"email": "jane@mail.com",
"firstName": "Jane",
"lastName": "Doe",
"phone": "12345678910",
"document": "12345678910"
}
],
"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": "27112371-a71b-45d6-b3bc-93436a3a0b4f",
"author": "82a2b53d-39be-4f49-bb7c-8971b58cb7dc",
"creationDate": "2022-01-05T15:41:37.5009471+00:00",
"lastUpdateDate": "2022-01-05T15:41:37.5009471+00:00",
"expirationDate": "2022-01-05T15:41:37.5009471+00:00"
}
}
}
]
}