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