VTEX · Schema

Delivery Service Response body _v1_1

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
pictures array
idDeliveryService integer
deliveryServiceType object
deliveryServiceStatus object
shipper object
shipperCustomer object
carrier object
displacementType object
state object
country object
nonDeliveryReason object
shipperPartner object
shipperBranch object
freightPrice object
shippingCompany object
invoiceOrderOfService string
description string
addressStreet string
addressNumber string
addressComplement string
addressNeighborhood string
addressCity string
postalCode string
estimateDeliveryHour string
created string
initialEstimateDeliveryHour string
deliveryDateTime string
estimateDeliveryDistance integer
travelledDeliveryDistance integer
orderNumber string
cteNumber string
cteDate string
sender string
senderCity string
senderState integer
weight number
cubicMeter number
cubicMeterWeight number
value number
freightPriceReceived number
deliveryAttempts integer
serviceTime integer
invoiceOrderOfServiceSerie string
leadTime string
cnpjcarrier string
cnpjbranch string
idExternal string
billingInfo array
deliveryServiceRouteItem array
View JSON Schema on GitHub

JSON Schema

vtex-deliveryserviceresponse-v1-1-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DeliveryServiceResponse_v1_1",
  "title": "Delivery Service Response body _v1_1",
  "type": "object",
  "properties": {
    "pictures": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    },
    "idDeliveryService": {
      "type": "integer",
      "format": "int32"
    },
    "deliveryServiceType": {
      "$ref": "#/components/schemas/DeliveryServiceTypeResponse"
    },
    "deliveryServiceStatus": {
      "$ref": "#/components/schemas/DeliveryServiceStatusResponse"
    },
    "shipper": {
      "$ref": "#/components/schemas/ShipperResponse"
    },
    "shipperCustomer": {
      "$ref": "#/components/schemas/ShipperCustomerResponse"
    },
    "carrier": {
      "$ref": "#/components/schemas/CarrierResponse"
    },
    "displacementType": {
      "$ref": "#/components/schemas/DisplacementTypeResponse"
    },
    "state": {
      "$ref": "#/components/schemas/StateResponse"
    },
    "country": {
      "$ref": "#/components/schemas/CountryResponse"
    },
    "nonDeliveryReason": {
      "$ref": "#/components/schemas/NonDeliveryReasonResponse"
    },
    "shipperPartner": {
      "$ref": "#/components/schemas/ShipperPartnerResponse"
    },
    "shipperBranch": {
      "$ref": "#/components/schemas/ShipperBranchResponse"
    },
    "freightPrice": {
      "$ref": "#/components/schemas/FreightPriceResponse"
    },
    "shippingCompany": {
      "$ref": "#/components/schemas/ShippingCompanyResponse"
    },
    "invoiceOrderOfService": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "addressStreet": {
      "type": "string"
    },
    "addressNumber": {
      "type": "string"
    },
    "addressComplement": {
      "type": "string"
    },
    "addressNeighborhood": {
      "type": "string"
    },
    "addressCity": {
      "type": "string"
    },
    "postalCode": {
      "type": "string"
    },
    "estimateDeliveryHour": {
      "type": "string",
      "format": "date-time"
    },
    "created": {
      "type": "string",
      "format": "date-time"
    },
    "initialEstimateDeliveryHour": {
      "type": "string",
      "format": "date-time"
    },
    "deliveryDateTime": {
      "type": "string",
      "format": "date-time"
    },
    "estimateDeliveryDistance": {
      "type": "integer",
      "format": "int32"
    },
    "travelledDeliveryDistance": {
      "type": "integer",
      "format": "int32"
    },
    "orderNumber": {
      "type": "string"
    },
    "cteNumber": {
      "type": "string"
    },
    "cteDate": {
      "type": "string",
      "format": "date-time"
    },
    "sender": {
      "type": "string"
    },
    "senderCity": {
      "type": "string"
    },
    "senderState": {
      "type": "integer",
      "format": "int32"
    },
    "weight": {
      "type": "number"
    },
    "cubicMeter": {
      "type": "number"
    },
    "cubicMeterWeight": {
      "type": "number"
    },
    "value": {
      "type": "number"
    },
    "freightPriceReceived": {
      "type": "number"
    },
    "deliveryAttempts": {
      "type": "integer",
      "format": "int32"
    },
    "serviceTime": {
      "type": "integer",
      "format": "int32"
    },
    "invoiceOrderOfServiceSerie": {
      "type": "string"
    },
    "leadTime": {
      "type": "string",
      "format": "date-time"
    },
    "cnpjcarrier": {
      "type": "string"
    },
    "cnpjbranch": {
      "type": "string"
    },
    "idExternal": {
      "type": "string"
    },
    "billingInfo": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/BillingInfoResponse"
      },
      "description": ""
    },
    "deliveryServiceRouteItem": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DeliveryServiceRouteItemResponse"
      },
      "description": ""
    }
  }
}

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-deliveryserviceresponse-v1-1"
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.