VTEX · Schema

importResult

Object containing information about bulk import state.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
accountName string Name of your VTEX account.
importId string Unique identifier of the import.
importState string Current state of the import. The possible values are: - `Uploaded`: The file was successfully uploaded. - `InValidation`: File validation is in progress. - `ReadyToImport`: File validation completed,
percentage string Completion percentage of the import.
lastUpdateDate string Date and time of the last update of the import, in `yyyy-mm-ddTHH:MM:SS+00:00` format.
fileName string Name of the file being imported.
importedAt string Date and time when the import was completed, in `yyyy-mm-ddTHH:MM:SS+00:00` format.
importedUserEmail string Email address of the user who performed the import.
importedUserName string Name of the user who performed the import.
importResult object Information about the outcome of the bulk import operation.
View JSON Schema on GitHub

JSON Schema

vtex-importresult-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/importResult",
  "title": "importResult",
  "type": "object",
  "description": "Object containing information about bulk import state.",
  "required": [
    "accountName",
    "importId",
    "importState",
    "percentage",
    "lastUpdateDate",
    "fileName",
    "importResult",
    "importedAt",
    "importedUserEmail",
    "importedUserName"
  ],
  "properties": {
    "accountName": {
      "type": "string",
      "description": "Name of your VTEX account."
    },
    "importId": {
      "type": "string",
      "description": "Unique identifier of the import."
    },
    "importState": {
      "type": "string",
      "description": "Current state of the import. The possible values are:\n- `Uploaded`: The file was successfully uploaded.\n- `InValidation`: File validation is in progress.\n- `ReadyToImport`: File validation completed, ready for import.\n- `Completed`: File successfully imported.\n- `ValidationFailed`: File validation failed.\n- `CompletedWithError`: File import failed."
    },
    "percentage": {
      "type": "string",
      "description": "Completion percentage of the import."
    },
    "lastUpdateDate": {
      "type": "string",
      "description": "Date and time of the last update of the import, in `yyyy-mm-ddTHH:MM:SS+00:00` format."
    },
    "fileName": {
      "type": "string",
      "description": "Name of the file being imported."
    },
    "importedAt": {
      "type": "string",
      "description": "Date and time when the import was completed, in `yyyy-mm-ddTHH:MM:SS+00:00` format."
    },
    "importedUserEmail": {
      "type": "string",
      "description": "Email address of the user who performed the import."
    },
    "importedUserName": {
      "type": "string",
      "description": "Name of the user who performed the import."
    },
    "importResult": {
      "type": "object",
      "description": "Information about the outcome of the bulk import operation.",
      "properties": {
        "reportDownloadLink": {
          "type": "string",
          "description": "A link to download a detailed report on the outcome of the bulk import."
        },
        "imports": {
          "type": "array",
          "description": "Detailed information about the imported items.",
          "items": {
            "type": "object",
            "description": "Object with detailed information.",
            "properties": {
              "name": {
                "type": "string",
                "description": "Unique identifier associated with the imported item."
              },
              "importedRows": {
                "type": "integer",
                "description": "Total number of lines successfully imported."
              },
              "rowsWithError": {
                "type": "integer",
                "description": "Total number of lines that encountered errors during import."
              }
            }
          }
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema 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 JSON Schema
curl "https://apis.io/api/v1/json-schemas/vtex-importresult"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

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

Get an API key

Free tier, no email required.

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