Jump to Content

APP STORE BECOME A PARTNER RELEASES HELP CENTER LEARNING CENTER FEEDBACK COMMUNITY

API Guides API Reference

APP STORE BECOME A PARTNER RELEASES HELP CENTER LEARNING CENTER FEEDBACK COMMUNITY Log In

API Guides API Reference

Getting Started

Introduction
Catalog
Orders
Checkout
Payments
Search
Promotions
Pricing
Account management
- Checking which user is currently authenticated

Integration Guides

API Guides
- Setting up DKIM for transactional emails
- Setting up the SPF
Back office integration guide (ERP/PIM/WMS)
External Marketplace
External Seller
Multilevel Omnichannel Inventory
- API Integration
Gift Card
- Gift Card system architecture
Login (SSO)
Offer Management Integration Guide
- Offer Management SDK
Payments
Search Protocol
Session Manager
Tax Service
Pricing Hub
VTEX Shipping Network
VTEX Tracking
- Integrating external orders via API to be used with VTEX Tracking
reCAPTCHA
- Applicable cases
- Implementing reCAPTCHA in integrations
Catalog

Checkout

Custom Data
- Add and handle custom information in the order
Customization
Discounts
- Set a discount using the Checkout API
Features
Marketing UTMs
- Check marketing UTMs used at Checkout
Orders
- Create a regular order using the Checkout API
Security
- SSL/TLS Security Protocols and Ciphers at Checkout
Shopping Cart

Master Data

Introduction
How it works
Getting started
v2 Guides
v1 Guides

Payments

Configuration Guides

Orders

Actions in orders
Feed v3

VTEX inStore

How to customize inStore
How to manage inStore data
- Create and manage physical stores and sales associates in Master Data
Invoiced orders

UI Customization

My Account
- My Authentication
portal-plugins
vtex.js
- vtex.js for Checkout
- vtex.js for Catalog

Message Center

Templates
- How to set up functions in the Message Center templates
- Including order variables in the transactional email template

Promotions

Using Policy Engine API on Promotion Alerts
Creating and managing coupons with Promotions API

Infrastructure

Store availability
- How to load test a store

Conversational Commerce

Create Zendesk integration

Subscriptions

Enabling Manual Prices for Subscriptions v3
Subscriptions v3 migration guide

Search

How search parameters work
Search Control – fulltextSearchBox
Consult store search terms information

Pricing

Scheduling prices for a range of hours

VTEX Session

Sessions System Overview

Account management

Learn more about account management in VTEX with the following guides:

Checking which user is currently authenticated

Updated 4 months ago