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 Cart Attachments API

The Cart Attachments API from VTEX — 7 operation(s) for cart attachments.

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

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

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

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

7 operations 7 paths 1 schemas 1 GET6 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 Cart Attachments 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 7 paths, the API surfaces 7 operations — 1 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Cart Attachments 7
GET
/api/checkout/pub/profiles
VTex Get client profile by email
GetClientProfileByEmail 4 params → 200
POST
/api/checkout/pub/orderForm/{orderFormId}/attachments/clientProfileData
VTex Add client profile
AddClientProfile 3 params body → 200
POST
/api/checkout/pub/orderForm/{orderFormId}/attachments/shippingData
VTex Add shipping address and select delivery option
AddShippingAddress 3 params body → 200
POST
/api/checkout/pub/orderForm/{orderFormId}/attachments/clientPreferencesData
VTex Add client preferences
AddClientPreferences 3 params body → 200
POST
/api/checkout/pub/orderForm/{orderFormId}/attachments/marketingData
VTex Add marketing data
AddMarketingData 3 params body → 200
POST
/api/checkout/pub/orderForm/{orderFormId}/attachments/paymentData
VTex Add payment data
AddPaymentData 3 params body → 200
POST
/api/checkout/pub/orderForm/{orderFormId}/attachments/merchantContextData
VTex Add merchant context data
AddMerchantContextData 3 params body → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is orderForm (35 properties). Each schema is shown below with its type and property counts.

orderForm
object
35 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vtex-cart-attachments-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 Category API
VTEX Category Specification API
Where this information came from

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