Jump to Content
VTEX Rest APIAPP STOREBECOME A PARTNERRELEASESHELP CENTERLEARNING CENTERFEEDBACKCOMMUNITY
API GuidesAPI Reference
APP STOREBECOME A PARTNERRELEASESHELP CENTERLEARNING CENTERFEEDBACKCOMMUNITYLog InVTEX Rest API
Log In
API GuidesAPI Reference

Getting Started

  • Introduction
    • Platform overview
    • List of REST APIs
    • Authentication
    • Making your first request
  • Catalog
    • Create a category
    • How to activate an SKU
    • How to create a specification
    • Updating SKU Specifications with Catalog API
  • Checkout
    • Using Checkout API to set a discount
    • Creating customizable fields in the cart with Checkout API
    • Using APIs to place a regular order
    • Checkout customization guide
    • Enabling Manual Price in my store
    • Save user data opt-in on Checkout
    • How to configure the Region feature for SKU
    • Why are the UTMs not being applied to the cart?
    • Identifying whether marketing UTMs are being sent to Checkout
    • Enabling an Observation field on the Checkout page
    • Customizing the Checkout Confirmation pages
    • Setting up the Global Checkout
    • Changing the names of payment methods at the Checkout
    • How to add and handle custom information in the order (B2B)
  • Orders
    • Fetching marketplace information with the Orders API
    • Fetching payment details from a Mercado Libre order with Orders API
    • Feed v3
  • Subscriptions
    • Subscriptions v3 migration guide
    • Enabling Manual Prices for Subscriptions v3
  • Promotions
    • Using Policy Engine API on Promotion Alerts
    • Creating and managing coupons with Promotions API
  • Search
  • Payments
  • Pricing
    • Scheduling prices for a range of hours
  • Account management
    • Checking which user is currently authenticated

Integration Guides

  • API Guides
    • Setting up DKIM for transactional emails
    • Setting up the SPF
  • Back office (ERP/PIM/WMS)
    • Set up catalog
    • Import products
    • Import prices
    • Import inventory
    • Import customer data
    • Set up order integration
    • Set up order processing
    • Change seller
    • Change order
    • Updating / deleting information
    • FAQ: ERP Integration
    • Webservice (deprecated)
  • External Marketplace
    • Marketplace / Seller architecture
    • Store setup for VTEX Seller
    • Creating an integration app from a Template
    • Catalog Integration
    • Catalog logs
    • Get product list for an initial load
    • How to get a new product to offer in the marketplace
    • How to get product updates
    • Product and Category Mappings
    • How to keep prices updated
    • How to keep stock updated
    • Order Integration overview
    • Recommendations
    • New Order Integration
    • Update Order Status
    • How to validate if items are available for delivery
    • Sending invoice and tracking code to the marketplace
    • How to update a canceled order’s status in VTEX
  • External Seller
    • Marketplace / Seller architecture
    • Store setup for VTEX Marketplace
    • External seller processing payments
    • External seller connector
    • Catalog management for VTEX Marketplace
  • Gift Card
    • Gift Card system architecture
  • Login (SSO)
    • Admin (SAML 2.0)
    • Webstore (OAuth 2.0)
  • Offer Management Integration Guide
    • Offer Management SDK
  • Payments
    • Payment Provider Protocol
    • PCI - DSS Compliance
    • Payment Methods
    • Purchase Flows
    • Implementing a Payment Provider
    • Payment Provider Homologation
    • Pix: Instant Payments in Brazil
    • Installing Affirm Payment App
    • Payment App
    • Split Payouts on Payment Provider Protocol
    • Custom Auto Capture Feature
    • Layout Development Guide for payment methods in Smart Checkout VTEX
    • Secure Proxy
    • Payment Provider Framework
  • Search Protocol
    • Overview
    • Specification
    • Recipe
    • Reference Implementations
  • Session Manager
    • Session data aggregation: create and transform calls
    • Session data available from VTEX apps
    • Adding telesales impersonated email using the Session Manager
  • Tax Service
    • Overview
    • Specification
    • Recipe
    • Reference Implementations
  • Pricing Hub
  • VTEX Shipping Network
    • Getting started with VTEX IO for VTEX Shipping Network
    • Integration flow
    • Notification
    • Tracking
  • VTEX Tracking
    • Integrating external orders via API to be used with VTEX Tracking
  • reCAPTCHA
    • Applicable cases
    • Implementing reCAPTCHA in integrations
  • Catalog
    • Categories
    • Brands
    • Products
    • Specifications
    • Product specifications
    • SKU specifications
    • SKUs
    • Images
    • Alternative API requests
    • How to implement product color variation

Master Data

  • Introduction
  • How it works
    • Components
    • Architecture
    • API
    • Consistency Level
    • Schema Lifecycle
    • VTable
  • Getting started
    • Master Data v2 basics
    • Starting to work on Master Data v2 with JSON Schemas
    • Setting up triggers in Master Data v2
    • Avoiding CORS in your MasterData requests
  • v2 Guides
    • Use v2 triggers to interact with orders
    • Creating relationships between data entities using API
    • Setting up an A/B test with Master Data v2 trigger
    • Sending emails with triggers in Master Data v2
    • Dynamic expressions in Master Data v2
    • Search by geocoordinates
    • Setting up alternate keys
    • Master Data v2 document saving flow
  • v1 Guides
    • How the queries in Master Data v1 work

Payments

  • Configuration Guides
    • Setting up the type of interest rate
    • Setting up Merchant ID in Apple Pay
    • Cardholder document configuration

VTEX inStore

  • How to customize inStore
    • Customize inStore login options
    • Change inStore language
    • Hide anonymous customer option
    • Define payment methods displayed on inStore
    • Enable the Observation field in the order screen
    • Enable the sales associate code
    • Enable cart transfer and capture between devices
    • Enable order filter by sales associate
    • Force stock availability
    • Set up the order summary printing
    • Add extra text to the order summary print
    • Hide Print order and Reprint receipt buttons
    • Enable partial cancellation for Debit or Credit Direct sales
    • Hide cancellation buttons
    • Allow manual prices on inStore
  • How to manage inStore data
    • Create and manage physical stores and sales associates in Master Data
  • Get invoiced orders placed in inStore
  • Create a middleware to issue tax coupons for inStore

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

Infrastructure

  • Store availability
    • How to load test a store

Account management

Suggest Edits

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

  • Checking which user is currently authenticated

Updated 6 days ago


Did this page help you?