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

The Notification API from VTEX — 3 operation(s) for notification.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

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

3 operations 3 paths 11 schemas 3 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 Notification 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 3

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

Notification 3
POST
/notificator/{sellerId}/changenotification/{skuId}/price
VTex Notify marketplace of price update
PriceNotification 6 params → 202
POST
/notificator/{sellerId}/changenotification/{skuId}/inventory
VTex Notify marketplace of inventory update
InventoryNotification 6 params → 202
POST
/{app_name}/v{app_version}/{account}/{workspace}/notify
VTex Notify carrier with app
NotifyCarrierwithApp 4 params body → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are Account (16 properties), Address (9 properties), Sender (8 properties), Carrier (8 properties). Each schema is shown below with its type and property counts.

DispatchOrder
object
Information about the dispatched order.
4 properties 4 required
Sender
object
User's logged account in the VTEX store.
8 properties 8 required
Location
object
Recipient's address geocoordinates.
2 properties 2 required
Subregion3
object
Recipient's address neighborhood's information.
2 properties 2 required
Subregion1
object
Recipient's address state's information.
2 properties 2 required
Address
object
Address of the VTEX account responsible for sending the package.
9 properties 9 required
Account
object
Account information.
16 properties 16 required
NotifyCarrierwithAppRequest
object
Object containing email, account, and dispatched order information.
3 properties 3 required
Carrier
object
Carrier responsible for delivering the dispatched order.
8 properties 8 required
Subregion2
object
Recipient's address city's information.
2 properties 2 required
Country
object
Recipient's country.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vtex-notification-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
#Notification
← Back to V APIs
API Details
ID
vtex:vtex-notification-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-notification-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/vtex-notification-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 Notification 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.