VTEX · Schema

List

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
orderId	string
creationDate	string
clientName	string
items	string
totalValue	integer
paymentNames	string
status	string
statusDescription	string	`Deprecated`. Status description which is displayed on the Admin panel. This field is obsolete and may not return any value.
marketPlaceOrderId	string
sequence	string
salesChannel	string
affiliateId	string
origin	string
workflowInErrorState	boolean
workflowInRetry	boolean
lastMessageUnread	string
ShippingEstimatedDate	string
ShippingEstimatedDateMax	string
ShippingEstimatedDateMin	string
orderIsComplete	boolean
listId	string
listType	string
authorizedDate	string
callCenterOperatorName	string
totalItems	integer
currencyCode	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/List",
  "title": "List",
  "required": [
    "orderId",
    "creationDate",
    "clientName",
    "items",
    "totalValue",
    "paymentNames",
    "status",
    "statusDescription",
    "marketPlaceOrderId",
    "sequence",
    "salesChannel",
    "affiliateId",
    "origin",
    "workflowInErrorState",
    "workflowInRetry",
    "lastMessageUnread",
    "ShippingEstimatedDate",
    "ShippingEstimatedDateMax",
    "ShippingEstimatedDateMin",
    "orderIsComplete",
    "listId",
    "listType",
    "authorizedDate",
    "callCenterOperatorName",
    "totalItems",
    "currencyCode"
  ],
  "type": "object",
  "properties": {
    "orderId": {
      "type": "string"
    },
    "creationDate": {
      "type": "string"
    },
    "clientName": {
      "type": "string"
    },
    "items": {
      "type": "string",
      "nullable": true
    },
    "totalValue": {
      "type": "integer"
    },
    "paymentNames": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "statusDescription": {
      "type": "string",
      "description": "`Deprecated`. Status description which is displayed on the Admin panel. This field is obsolete and may not return any value."
    },
    "marketPlaceOrderId": {
      "type": "string",
      "nullable": true
    },
    "sequence": {
      "type": "string"
    },
    "salesChannel": {
      "type": "string"
    },
    "affiliateId": {
      "type": "string"
    },
    "origin": {
      "type": "string"
    },
    "workflowInErrorState": {
      "type": "boolean"
    },
    "workflowInRetry": {
      "type": "boolean"
    },
    "lastMessageUnread": {
      "type": "string",
      "nullable": true
    },
    "ShippingEstimatedDate": {
      "type": "string",
      "nullable": true
    },
    "ShippingEstimatedDateMax": {
      "type": "string",
      "nullable": true
    },
    "ShippingEstimatedDateMin": {
      "type": "string",
      "nullable": true
    },
    "orderIsComplete": {
      "type": "boolean"
    },
    "listId": {
      "type": "string",
      "nullable": true
    },
    "listType": {
      "type": "string",
      "nullable": true
    },
    "authorizedDate": {
      "type": "string",
      "nullable": true
    },
    "callCenterOperatorName": {
      "type": "string",
      "nullable": true
    },
    "totalItems": {
      "type": "integer"
    },
    "currencyCode": {
      "type": "string"
    }
  },
  "example": {
    "orderId": "v502559llux-01",
    "creationDate": "2019-02-04T10:29:11+00:00",
    "clientName": "J C",
    "items": null,
    "totalValue": 7453,
    "paymentNames": "Boleto Banc\u00e1rio",
    "status": "invoiced",
    "statusDescription": "Faturado",
    "marketPlaceOrderId": null,
    "sequence": "502559",
    "salesChannel": "1",
    "affiliateId": "",
    "origin": "Marketplace",
    "workflowInErrorState": false,
    "workflowInRetry": false,
    "lastMessageUnread": " Lux Store 96 Sua Nota Fiscal foi emitida. Referente ao Pedido #v502559llux-01 Ol\u00e1, J. Estamos empacotando seu produto para providenci",
    "ShippingEstimatedDate": null,
    "ShippingEstimatedDateMax": null,
    "ShippingEstimatedDateMin": null,
    "orderIsComplete": true,
    "listId": null,
    "listType": null,
    "authorizedDate": "2019-02-07T21:29:54+00:00",
    "callCenterOperatorName": null,
    "totalItems": 1,
    "currencyCode": "BRL"
  }
}

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-list"

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 form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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