VTEX · Example Payload

Vtex Checkprogress Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Checkprogress 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": "CheckProgress",
  "method": "GET",
  "path": "/api/b2b/import/buyer-orgs/{importId}",
  "summary": "VTex Check progress",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "ValidationDetails",
      "example": {
        "accountName": "accountName",
        "importId": "3c3cba0a-8355-4812-ad4d-f4c0b32e2613",
        "importState": "InValidation",
        "percentage": "0",
        "lastUpdateDate": "2023-10-05T16:40:11+00:00",
        "fileName": "file.xlsx"
      }
    },
    {
      "status": "200",
      "contentType": "application/json",
      "name": "ImportDetails",
      "example": {
        "accountName": "accountName",
        "importId": "3c3cba0a-8355-4812-ad4d-f4c0b32e2613",
        "importState": "Completed",
        "percentage": "100",
        "lastUpdateDate": "2023-10-05T16:41:11+00:00",
        "fileName": "file.xlsx"
      }
    },
    {
      "status": "200",
      "contentType": "application/json",
      "name": "ValidationErrorsDetails",
      "example": {
        "accountName": "accountName",
        "importId": "71411025-c7d9-4c9d-92b5-9bc70a1acdb7",
        "importState": "ValidationFailed",
        "percentage": "0",
        "lastUpdateDate": "2024-02-21T17:56:57+00:00",
        "fileName": "file.xlsx",
        "validationResult": {
          "isValid": false,
          "validationResult": [
            {
              "name": "Organizations",
              "validRows": 0,
              "invalidRows": 1
            },
            {
              "name": "Cost Centers",
              "validRows": 0,
              "invalidRows": 0
            },
            {
              "name": "Members",
              "validRows": 0,
              "invalidRows": 0
            }
          ]
        }
      }
    },
    {
      "status": "200",
      "contentType": "application/json",
      "name": "ImportErrorsDetails",
      "example": {
        "accountName": "accountName",
        "importId": "d51b1b09-b4f3-44a3-ad70-53b9c8fe35f4",
        "importState": "CompletedWithError",
        "percentage": "100",
        "lastUpdateDate": "2024-02-26T14:47:10+00:00",
        "fileName": "test-26-fev-bulk-import-error.xlsx",
        "importResult": {
          "imports": [
            {
              "name": "Organizations",
              "importedRows": 2,
              "rowsWithError": 1
            }
          ],
          "reportDownloadLink": "https://host.com/files/accountName/d51b1b09-b4f3-44a3-ad70-53b9c8fe35f4/file-error_Report.xlsx"
        },
        "importedAt": "2024-02-26T14:47:05+00:00",
        "importedUserEmail": "user@host.com",
        "importedUserName": "user"
      }
    }
  ]
}

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-checkprogress-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.