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 Carriers API

The Carriers API from VTEX — 2 operation(s) for carriers.

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

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

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

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

2 operations 2 paths 22 schemas 2 POST

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 Carriers 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 2

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

Carriers 2
POST
/rates
VTex Calculate rates
Createservice 3 params body → 200400401404500
POST
/list-carriers
VTex List carriers
Createservice 3 params body → 200400401404500

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are Data (24 properties), CreateServiceBody (13 properties), MetaData (12 properties), Item (9 properties). Each schema is shown below with its type and property counts.

MetaData1
object
Metadata about the Carrier.
2 properties 2 required
Data
object
24 properties 24 required
ShippingPrice1
object
Shipping cost information.
2 properties 2 required
Carrier
object
Object containing information about a carrier.
5 properties 5 required
Rate
object
Rate cost information.
2 properties 2 required
Dimensions
object
3 properties 3 required
Note
object
Notes with delivery information.
4 properties 4 required
Item
object
9 properties 9 required
ListRequest
object
1 property 1 required
Rate1
object
Rate cost information.
2 properties 2 required
Label
object
4 properties 4 required
InsurancePrice
object
Insurance cost information.
2 properties 2 required
ResponseService
object
6 properties 6 required
Type
object
9 properties 9 required
ShippingPrice
object
Shipping cost information.
2 properties 2 required
MetaData
object
12 properties
Timeline
object
8 properties 8 required
generatedObject
object
3 properties 3 required
CreateServiceBody
object
13 properties
Timezone
object
Time zone information.
3 properties 3 required
Package
object
Package information.
9 properties 9 required
ServiceBody
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vtex-carriers-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 Cart Attachments API
VTEX Category API
VTEX Category Specification API
Where this information came from

This is an independent, third-party profile of VTEX Carriers 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.