VTEX · Schema

ResponseService

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
status	string	Status of the service.
serviceId	string	Service ID.
shippingPrice	number	Service shipping price.
metaData	object
shippingEstimatedDate	string	Shipping estimated date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.
labels	array	Shipping labels, there may be more than one per order due to breakage in packages.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ResponseService",
  "title": "ResponseService",
  "type": "object",
  "required": [
    "status",
    "serviceId",
    "shippingPrice",
    "metaData",
    "shippingEstimatedDate",
    "labels"
  ],
  "properties": {
    "status": {
      "type": "string",
      "example": "PENDING",
      "description": "Status of the service.",
      "enum": [
        "PENDING",
        "ASSIGNED",
        "PICKED",
        "ON_ROUTE",
        "INCIDENT",
        "RETURNED",
        "DELIVERED",
        "CANCELED",
        "ON_HOLD"
      ]
    },
    "serviceId": {
      "type": "string",
      "example": "ASDF23324KDSF2",
      "description": "Service ID."
    },
    "shippingPrice": {
      "type": "number",
      "example": 20000.09,
      "description": "Service shipping price."
    },
    "metaData": {
      "type": "object",
      "properties": {
        "{keyValue}": {
          "description": "Carrier additional information.",
          "type": "string"
        }
      },
      "example": {
        "anyKey": "anyValue"
      }
    },
    "shippingEstimatedDate": {
      "type": "string",
      "example": "2024-05-29T22:36:37.589Z",
      "description": "Shipping estimated date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`."
    },
    "labels": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Label"
      },
      "description": "Shipping labels, there may be more than one per order due to breakage in packages."
    }
  }
}

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

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.