VTEX · Schema

List1

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
orderId	string	Order ID is a unique code that identifies an order.
creationDate	string	Order's creation date.
clientName	string	Order's customer name.
items	array	Information about order's items.
totalValue	integer	Total value amount.
paymentNames	string	Payment system name.
status	string	Order [status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196).
statusDescription	string	Status description which is displayed on the Admin panel. This field is deprecated and may not return any value.
marketPlaceOrderId	string	Marketplace order ID.
sequence	string	Six-digit string that follows the order ID. For example, in order `1268540501456-01 (501456)`, the sequence is `501456`.
salesChannel	string	Sales channel (or [trade policy](https://help.vtex.com/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) ID related to the order.
affiliateId	string	Corresponds to the three-digits [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) identification code of the seller responsible for the order.
origin	string	Order's [origin in the order flow](https://developers.vtex.com/docs/guides/orders-overview#understanding-order-flow-types), which can be `Marketplace`, `Fulfillment` or `Chain`.
workflowInErrorState	boolean	If there is a work flow error (`true`) or not (`false`).
workflowInRetry	boolean	If the order is in a work flow retry (`true`) or not (`false`).
lastMessageUnread	string	Last sent transactional message.
ShippingEstimatedDate	string	Estimate shipping date.
ShippingEstimatedDateMax	string	The most extended shipping estimation possible.
ShippingEstimatedDateMin	string	The least extended shipping estimation possible.
orderIsComplete	boolean	If it is a completed order (`true`) or not (`false`). For more information, see [Order flow and status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196).
listId	string	Related Gift List ID.
listType	string	Related Gift list type.
authorizedDate	string	Authorized order date.
callCenterOperatorName	string	Call center operator responsible for the order.
totalItems	integer	Order's total amount of items.
currencyCode	string	Currency code in ISO 4217. For example, `BRL`.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/List1",
  "title": "List1",
  "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",
      "description": "Order ID is a unique code that identifies an order."
    },
    "creationDate": {
      "type": "string",
      "description": "Order's creation date."
    },
    "clientName": {
      "type": "string",
      "description": "Order's customer name."
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Item2"
      },
      "description": "Information about order's items.",
      "nullable": true,
      "deprecated": true
    },
    "totalValue": {
      "type": "integer",
      "description": "Total value amount."
    },
    "paymentNames": {
      "type": "string",
      "nullable": true,
      "description": "Payment system name."
    },
    "status": {
      "type": "string",
      "description": "Order [status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196)."
    },
    "statusDescription": {
      "type": "string",
      "description": "Status description which is displayed on the Admin panel. This field is deprecated and may not return any value.",
      "deprecated": true
    },
    "marketPlaceOrderId": {
      "type": "string",
      "nullable": true,
      "description": "Marketplace order ID."
    },
    "sequence": {
      "type": "string",
      "description": "Six-digit string that follows the order ID. For example, in order `1268540501456-01 (501456)`, the sequence is `501456`."
    },
    "salesChannel": {
      "type": "string",
      "description": "Sales channel (or [trade policy](https://help.vtex.com/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) ID related to the order."
    },
    "affiliateId": {
      "type": "string",
      "description": "Corresponds to the three-digits [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) identification code of the seller responsible for the order."
    },
    "origin": {
      "type": "string",
      "description": "Order's [origin in the order flow](https://developers.vtex.com/docs/guides/orders-overview#understanding-order-flow-types), which can be `Marketplace`, `Fulfillment` or `Chain`."
    },
    "workflowInErrorState": {
      "type": "boolean",
      "description": "If there is a work flow error (`true`) or not (`false`)."
    },
    "workflowInRetry": {
      "type": "boolean",
      "description": "If the order is in a work flow retry (`true`) or not (`false`)."
    },
    "lastMessageUnread": {
      "type": "string",
      "nullable": true,
      "description": "Last sent transactional message."
    },
    "ShippingEstimatedDate": {
      "type": "string",
      "nullable": true,
      "description": "Estimate shipping date."
    },
    "ShippingEstimatedDateMax": {
      "type": "string",
      "nullable": true,
      "description": "The most extended shipping estimation possible."
    },
    "ShippingEstimatedDateMin": {
      "type": "string",
      "nullable": true,
      "description": "The least extended shipping estimation possible."
    },
    "orderIsComplete": {
      "type": "boolean",
      "description": "If it is a completed order (`true`) or not (`false`). For more information, see [Order flow and status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196)."
    },
    "listId": {
      "type": "string",
      "nullable": true,
      "description": "Related Gift List ID."
    },
    "listType": {
      "type": "string",
      "nullable": true,
      "description": "Related Gift list type."
    },
    "authorizedDate": {
      "type": "string",
      "nullable": true,
      "description": "Authorized order date."
    },
    "callCenterOperatorName": {
      "type": "string",
      "nullable": true,
      "description": "Call center operator responsible for the order."
    },
    "totalItems": {
      "type": "integer",
      "description": "Order's total amount of items."
    },
    "currencyCode": {
      "type": "string",
      "nullable": true,
      "description": "Currency code in ISO 4217. For example, `BRL`."
    }
  },
  "example": {
    "orderId": "1172452900788-01",
    "creationDate": "2019-01-28T20:09:43+00:00",
    "clientName": "Cunha VTEX",
    "items": [
      {
        "seller": "1",
        "quantity": 1,
        "description": "Reservoir hose",
        "ean": null,
        "refId": "TE3121110",
        "id": "195",
        "productId": "134",
        "sellingPrice": 7390,
        "price": 7390
      },
      {
        "seller": "1",
        "quantity": 1,
        "description": "Reservoir filter",
        "ean": null,
        "refId": "XC459N610CA",
        "id": "238",
        "productId": "162",
        "sellingPrice": 5190,
        "price": 5190
      }
    ],
    "totalValue": 1160,
    "paymentNames": "Boleto Banc\u00e1rio",
    "status": "handling",
    "statusDescription": "Preparing for delivery",
    "marketPlaceOrderId": null,
    "sequence": "502556",
    "salesChannel": "1",
    "affiliateId": "GTB",
    "origin": "Marketplace",
    "workflowInErrorState": false,
    "workflowInRetry": false,
    "lastMessageUnread": " Lux Store Seu pedido foi alterado! Pedido realizado em: 28/01/2019 Ol\u00e1, Rodrigo. Seu pedido foi alterado. Seguem informa\u00e7\u00f5es abaixo: ",
    "ShippingEstimatedDate": "2019-02-04T20:33:46+00:00",
    "ShippingEstimatedDateMax": null,
    "ShippingEstimatedDateMin": null,
    "orderIsComplete": true,
    "listId": null,
    "listType": null,
    "authorizedDate": "2019-01-28T20:33:04+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-list1"

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.

GitHub Google LinkedIn

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