How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

VTEX Delivery Services API

The Delivery Services API from VTEX — 4 operation(s) for delivery services.

VTEX Delivery Services API is one of 142 APIs that VTEX publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Delivery Services. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 4 paths, and defines 34 schemas. It is described by OpenAPI 3.0.0, at version 1.0.

Requests are made against a single base URL, https://{providerApiEndpoint}.

7 operations 4 paths 34 schemas 4 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0
Base URL
https://{providerApiEndpoint}
Authentication
API Key
Resource Areas
1

Authentication & Security 1

VTEX Delivery Services API declares 1 security scheme for authenticating requests. An API key is passed in the header as VtexIdclientAutCookie (VtexIdclientAutCookie).

  • VtexIdclientAutCookie — [User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 4 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Delivery Services 7
PUT
/services
VTex Remove Packing List
2 params body → 200
POST
/services
VTex Post Delivery Service
2 params body → 200400
GET
/services
VTex Get Delivery Services List
7 params → 200400404
GET
/services/{idDeliveryService}
VTex Get Delivery Service by ID
3 params → 200
POST
/services/routes
VTex Post Delivery Service With Route Scheduling
PostDeliveryServiceWithRouteAsync 2 params body → 200
GET
/services/routes
VTex Get Delivery Services List by Route
7 params → 200400404
GET
/services/invoice
VTex Get Delivery Service by Invoice
3 params → 200400404

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are DeliveryServiceResponse_v1_1 (49 properties), DeliveryServiceObject (20 properties), ShipperCustomerResponse (20 properties), DeliveryServiceRouteItemResponse (20 properties). Each schema is shown below with its type and property counts.

DeliveryServiceResponse_v1_1
object
49 properties
PostWithRoute
object
2 properties 1 required
DeliveryServiceRouteStatusResponse
object
1 property
ShipperTypeResponse
object
1 property
DeliveryServiceStatusResponse
object
1 property
Carrier
object
13 properties 1 required
ShippingCompanyResponse
object
9 properties
DeliveryService
array
DeliveryReasonResponse
object
1 property
StateResponse
object
2 properties
DeliveryServiceTypeResponse
object
1 property
DisplacementTypeResponse
object
2 properties
CarrierResponse
object
15 properties
DeliveryServiceRoute
object
8 properties 3 required
ShipperBranchResponse
object
10 properties
Vehicle
object
1 property
DeliveryServiceRouteItemResponse
object
20 properties
BillingInfoResponse
object
8 properties
NonDeliveryReasonResponse
object
1 property
LegalTypeResponse
object
1 property
ShipperCustomer
object
17 properties 3 required
InvoiceFilter
object
2 properties
DeliveryServiceRouteResponse
object
7 properties
DeliveryServiceObject
object
20 properties 2 required
Scheduling
object
6 properties
CountryResponse
object
2 properties
ShipperPartnerResponse
object
2 properties
ShipperCustomerResponse
object
20 properties
DeliveryServiceRouteItemStatusResponse
object
1 property
ShipperResponse
object
1 property
AddressStart
object
5 properties
FreightPriceResponse
object
5 properties
PaginationResultDeliveryServiceResponsev11
object
4 properties
VehicleTypeResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vtex-delivery-services-api-openapi.yml Raw ↑

Other APIs VTEX publishes across the network.

VTEX Account API
VTEX Addresses API
VTEX Anti-Fraud Flow API
VTEX App Keys API
VTEX Attachment API
VTEX Authentication API
VTEX Autocomplete API
VTEX Brand API
VTEX Bulk Import API
VTEX Carriers API
VTEX Cart Attachments API
VTEX Category API
Where this information came from

This is an independent, third-party profile of VTEX Delivery Services API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.