Vtex Searchallaccounts 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": "Searchallaccounts",
"method": "GET",
"path": "/api/creditcontrol/accounts",
"summary": "VTex Search all accounts",
"requestExamples": [],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"example": {
"data": [
{
"id": "39f5f920-149f-11ha-b5b0-2vb896d3212f",
"balance": 0,
"document": "4354353453454",
"status": "Open",
"documentType": "CPF",
"creditLimit": 2000,
"updatedAt": "2020-01-02T15:26:40.3425717Z",
"createdAt": "2019-12-04T14:06:02.7905117Z",
"description": "",
"availableCredit": 2000,
"preAuthorizedCredit": 0,
"email": "wtest@gmail.com",
"tolerance": 20,
"availableBalance": 2000
},
{
"id": "71d3f4e5-9164-11ea-918f-93b2a93cb9ba",
"balance": 0,
"document": "10120312",
"status": "Open",
"documentType": "CPF",
"creditLimit": 1,
"updatedAt": "2020-05-08T19:16:40.7202156Z",
"createdAt": "2020-05-08T19:16:40.5951631Z",
"description": "",
"availableCredit": 1,
"preAuthorizedCredit": 0,
"email": "etest@yahoo.com",
"tolerance": 0,
"availableBalance": 1
},
{
"id": "111111111_CPF",
"balance": 0,
"document": "111111111",
"status": "Open",
"documentType": "CPF",
"creditLimit": 500,
"updatedAt": "2020-06-30T18:35:25.5793275Z",
"createdAt": "2020-06-30T18:35:25.5011788Z",
"description": "",
"availableCredit": 500,
"preAuthorizedCredit": 0,
"email": "atest@test.com",
"tolerance": 1,
"availableBalance": 500
},
{
"id": "2222222222_CPF",
"balance": 0,
"document": "2222222222",
"status": "Open",
"documentType": "CPF",
"creditLimit": 100,
"updatedAt": "2020-07-07T21:08:07.1796362Z",
"createdAt": "2020-06-30T19:57:50.4832597Z",
"description": "",
"availableCredit": 100,
"preAuthorizedCredit": 0,
"email": "dtest@hotmail.com",
"tolerance": 0,
"availableBalance": 100
},
{
"id": "91d1f2e5-8169-11ea-728f-53b2a03cb8bc",
"balance": 0,
"document": "0000000000",
"status": "Open",
"documentType": "CPF",
"creditLimit": 5000,
"updatedAt": "2020-07-28T18:50:46.7315579Z",
"createdAt": "2020-06-30T18:49:35.424369Z",
"description": "",
"availableCredit": 5000,
"preAuthorizedCredit": 0,
"email": "test@test.com",
"tolerance": 0,
"availableBalance": 5000
}
],
"summary": {
"count": 5
}
}
}
]
}