VTEX · Example Payload

Vtex Searchallinvoices Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Searchallinvoices 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": "Searchallinvoices",
  "method": "GET",
  "path": "/api/creditcontrol/invoices",
  "summary": "VTex Search all invoices",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "data": [
          {
            "id": "A424887D0F2D45028FE5C96E9B0E1A2D-01",
            "friendlyId": "u8KFsGDk-1",
            "status": "Paid",
            "value": 5.01,
            "accountId": "fcba59e0-7f26-11ee-ba3c-511336e1518b",
            "creditValue": 0,
            "createdAt": "2023-11-09T18:26:43.2112234Z",
            "resolvedAt": "2023-11-13T19:12:17.2778233Z",
            "updatedAt": "2023-11-13T19:12:17.3403115Z",
            "paymentLink": "https://www.teste.com.br",
            "originalDueDate": "2023-12-09T18:26:43.2112234Z",
            "dueDate": "2023-12-09T18:26:43.2112234Z",
            "installment": 1,
            "orderId": "1375060513100-01",
            "observation": "Open test",
            "transactionId": "A424887D0F2D45028FE5C96E9B0E1A2D",
            "numberOfInstallments": 1,
            "creditAccountId": "fcba59e0-7f26-11ee-ba3c-511336e1518b"
          },
          {
            "id": "742F1758D81F4E93BC2A3F8A382D44A8-01",
            "friendlyId": "8UfrLSCc-1",
            "status": "Opened",
            "value": 0.91,
            "accountId": "fcba59e0-7f26-11ee-ba3c-511336e1518b",
            "creditValue": 0,
            "createdAt": "2023-11-10T19:46:50.551354Z",
            "updatedAt": "2023-11-14T12:07:21.9823956Z",
            "originalDueDate": "2023-12-10T19:46:50.551354Z",
            "dueDate": "2023-12-18T19:46:50.551354Z",
            "installment": 1,
            "orderId": "1375070513102-01",
            "transactionId": "742F1758D81F4E93BC2A3F8A382D44A8",
            "numberOfInstallments": 1,
            "creditAccountId": "fcba59e0-7f26-11ee-ba3c-511336e1518b"
          },
          {
            "id": "742235D7E5E840798EC28A02EBA9E855-01",
            "friendlyId": "mvOEfmdk-1",
            "status": "Cancelled",
            "value": 1.21,
            "accountId": "fcba59e0-7f26-11ee-ba3c-511336e1518b",
            "creditValue": 0,
            "createdAt": "2023-11-13T18:05:39.1334296Z",
            "resolvedAt": "2023-11-13T19:25:22.1919688Z",
            "updatedAt": "2023-11-13T19:25:22.3326219Z",
            "originalDueDate": "2023-12-13T18:05:39.1334296Z",
            "dueDate": "2023-12-13T18:05:39.1334296Z",
            "installment": 1,
            "orderId": "1376020513104-01",
            "transactionId": "742235D7E5E840798EC28A02EBA9E855",
            "numberOfInstallments": 1,
            "creditAccountId": "fcba59e0-7f26-11ee-ba3c-511336e1518b"
          }
        ],
        "summary": {
          "total": 0.91,
          "count": 3,
          "totalPaid": 5.01,
          "totalCancelled": 1.21
        }
      }
    }
  ]
}

Work with this as data

Every example here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for examples

4 MCP tools reach this

find_examplesBrowse and filter every example in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools

Call it yourself

curl for this page

This example

curl "https://apis.io/api/v1/examples/vtex-searchallinvoices-example"

All examples

curl "https://apis.io/api/v1/examples?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.