VTEX · Schema

Delivery Service Object

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
deliveryServiceType	string
idExternalShipperCustomer	string
shipperCustomer	object
invoiceOrderOfService	string
invoiceOrderOfServiceSerie	string
description	string
sender	string
cnpjShipperPartner	string
orderNumber	string
deliveryServiceHighLighter	string
latitude	number
longitude	number
deliveryServiceScheduling	object
cnpjcarrier	string
cnpjbranch	string
idExternal	string
idShippingCompany	integer
packingList	string
packingListDateTime	string
integrationDateTime	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DeliveryServiceObject",
  "title": "Delivery Service Object",
  "required": [
    "deliveryServiceType",
    "shipperCustomer"
  ],
  "type": "object",
  "properties": {
    "deliveryServiceType": {
      "maxLength": 11,
      "minLength": 0,
      "type": "string"
    },
    "idExternalShipperCustomer": {
      "maxLength": 30,
      "minLength": 0,
      "type": "string"
    },
    "shipperCustomer": {
      "$ref": "#/components/schemas/ShipperCustomer"
    },
    "invoiceOrderOfService": {
      "type": "string"
    },
    "invoiceOrderOfServiceSerie": {
      "maxLength": 3,
      "minLength": 0,
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "sender": {
      "type": "string"
    },
    "cnpjShipperPartner": {
      "type": "string"
    },
    "orderNumber": {
      "maxLength": 200,
      "minLength": 0,
      "type": "string"
    },
    "deliveryServiceHighLighter": {
      "maxLength": 11,
      "minLength": 0,
      "type": "string"
    },
    "latitude": {
      "type": "number"
    },
    "longitude": {
      "type": "number"
    },
    "deliveryServiceScheduling": {
      "$ref": "#/components/schemas/Scheduling"
    },
    "cnpjcarrier": {
      "type": "string"
    },
    "cnpjbranch": {
      "type": "string"
    },
    "idExternal": {
      "maxLength": 30,
      "minLength": 0,
      "type": "string"
    },
    "idShippingCompany": {
      "type": "integer",
      "format": "int32"
    },
    "packingList": {
      "maxLength": 50,
      "minLength": 0,
      "type": "string"
    },
    "packingListDateTime": {
      "type": "string",
      "format": "date-time"
    },
    "integrationDateTime": {
      "type": "string",
      "format": "date-time"
    }
  }
}

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

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.