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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
VTEX

VTEX Shipping Updates API

This endpoint will allow the carriers to update an ongoing shipping service.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

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

9 operations 8 paths 43 schemas 1 GET1 PATCH7 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 Shipping Updates 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 9

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

Shipping Updates 9

This endpoint will allow the carriers to update an ongoing shipping service.

GET
/{carrierId}/{serviceId}
VTex Get service
Getservice 5 params → 200401403404
PATCH
/{carrierId}/{serviceId}
VTex Update service
Updateservice 5 params body → 200401403404
POST
/notes/{carrierId}/{serviceId}
VTex Create notes
Createnotes 5 params body → 200401403404
POST
/evidences/{carrierId}/{serviceId}
VTex Create evidence
Createevidence 5 params body → 200401403404
POST
/labels/{carrierId}/{serviceId}
VTex Create label
Createlabels 5 params body → 200401403404
POST
/cancel/{carrierId}/{serviceId}
VTex Cancel ongoing service
PostCancelservice 5 params body → 200401403404
POST
/cancel-service
VTex Cancel service
Createservice 3 params body → 200400401404500
POST
/pause-service
VTex Pause and resume service
Createservice 3 params body → 200400401404500
POST
/on-hold/{carrierId}/{serviceId}
VTex Create on hold service
Onholdservice 5 params body → 200401403404

Schemas 43

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

CancelOngoingServiceRequest
object
2 properties 2 required
MetaData1
object
Metadata about the Carrier.
2 properties 2 required
Data1
object
Request data.
3 properties 3 required
ServiceBody3
object
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
CancelServiceResponse
object
2 properties 2 required
m4041
object
Request information.
6 properties 6 required
Rate
object
Rate cost information.
2 properties 2 required
PauseResumeServiceResponse
object
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
Data15
object
4 properties 4 required
Rate1
object
Rate cost information.
2 properties 2 required
m4031
object
Request information.
2 properties 2 required
CreatelabelsRequest
object
4 properties 4 required
Label
object
4 properties 4 required
InsurancePrice
object
Insurance cost information.
2 properties 2 required
OnholdserviceRequest
object
2 properties 2 required
Data9
object
3 properties 3 required
CancelServiceRequest
object
5 properties 5 required
ServiceBody1
object
2 properties 2 required
Type
object
9 properties 9 required
Data18
object
2 properties 2 required
ShippingPrice
object
Shipping cost information.
2 properties 2 required
MetaData
object
12 properties
ServiceBody4
object
2 properties 2 required
UpdateserviceRequest
object
7 properties 7 required
Data3
object
7 properties 7 required
Timeline
object
8 properties 8 required
Agent
object
6 properties 6 required
CreateevidenceRequest
object
3 properties 3 required
Data12
object
3 properties 3 required
generatedObject
object
3 properties 3 required
CreatenotesRequest
object
3 properties 3 required
ServiceBody6
object
2 properties 2 required
Timezone
object
Time zone information.
3 properties 3 required
Package
object
Package information.
9 properties 9 required
ServiceBody5
object
2 properties 2 required
ServiceBody
object
2 properties 2 required
PauseResumeServiceRequest
object
6 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vtex-shipping-updates-api-openapi.yml Raw ↑

Other APIs VTEX publishes across the network.

VTEX Account API
AE Profile APIs.io
VTEX Addresses API
AE Profile APIs.io
VTEX Anti-Fraud Flow API
AE Profile APIs.io
VTEX App Keys API
AE Profile APIs.io
VTEX Attachment API
AE Profile APIs.io
VTEX Authentication API
AE Profile APIs.io
VTEX Autocomplete API
AE Profile APIs.io
VTEX Brand API
AE Profile APIs.io
VTEX Bulk Import API
AE Profile APIs.io
VTEX Carriers API
AE Profile APIs.io
VTEX Cart Attachments API
AE Profile APIs.io
VTEX Category API
AE Profile APIs.io
#Shipping Updates
← Back to V APIs
API Details
ID
vtex:vtex-shipping-updates-api
Base URL
https://{providerApiEndpoint}
Docs
https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works
Provider
VTEX
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=vtex-shipping-updates-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/vtex-shipping-updates-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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