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

The Addresses API from VTEX — 6 operation(s) for addresses.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 9 operations across 6 paths, and defines 7 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 6 paths 7 schemas 1 DELETE6 GET1 PATCH1 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 Addresses 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 6 paths, the API surfaces 9 operations — 1 DELETE, 6 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Addresses 9
POST
/api/storage/profile-system/profiles/{profileId}/addresses
VTex Create client address
CreateClientAddress 4 params body → 201
GET
/api/storage/profile-system/profiles/{profileId}/addresses
VTex Get client addresses
GetClientAddresses 4 params → 200
GET
/api/storage/profile-system/profiles/{profileId}/addresses/unmask
VTex Get unmasked client addresses
GetUnmaskedClientAddresses 4 params → 200
GET
/api/storage/profile-system/profiles/{profileId}/addresses/{addressId}
VTex Get address
GetAddress 5 params → 200
PATCH
/api/storage/profile-system/profiles/{profileId}/addresses/{addressId}
VTex Update client address
UpdateClientAddress 5 params body → 200
DELETE
/api/storage/profile-system/profiles/{profileId}/addresses/{addressId}
VTex Delete address
DeleteAddress 5 params → 204
GET
/api/storage/profile-system/profiles/{profileId}/addresses/{addressId}/unmask
VTex Get unmasked address
GetUnmaskedAddress 6 params → 200
GET
/api/storage/profile-system/profiles/{profileId}/addresses/{addressId}/versions/{addressVersionId}
VTex Get address by version
GetAddressByVersion 7 params → 200
GET
/api/storage/profile-system/profiles/{profileId}/addresses/{addressId}/versions/{addressVersionId}/unmask
VTex Get unmasked address by version
GetUnmaskedAddressByVersion 7 params → 200

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Address (10 properties), CreateAddress (9 properties), AddressMeta (4 properties), MaskedAddressResponse (3 properties). Each schema is shown below with its type and property counts.

AddressId
string
ID of a client's address.
CreateAddress
object
Address request body.
9 properties 7 required
ProfileId
string
ID of the client's profile.
UnmaskedAddressResponse
object
Unmasked address information.
3 properties
Address
object
Address information.
10 properties 8 required
MaskedAddressResponse
object
3 properties
AddressMeta
object
Address metadata.
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vtex-addresses-api-openapi.yml Raw ↑

Other APIs VTEX publishes across the network.

VTEX Account 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
VTEX Category Specification API
AE Profile APIs.io
#Addresses
← Back to V APIs
API Details
ID
vtex:vtex-addresses-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-addresses-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/vtex-addresses-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 Addresses 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.