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

Using this API Reference

Introduction
- Using Postman

Antifraud Provider

Antifraud Provider Protocol - Overview
Antifraud Flow
OAuth Flow

Catalog API

Checkout API

Checkout API - Overview
- orderForm
Shopping cart
Cart attachments
Custom data
Configuration
Fulfillment
- List pickup points by locationget
- Get address by postal codeget
Order placement
Region
- Get sellers by regionget

CMS API

Change URI Schema
- Change entire account (all websites)put
- Change specific websiteput

Customer Credit API

Customer Credit API - Overview
Invoices
Account
Store Configuration
- Retrieve store configurationget
- Create or change store configurationput

GiftCard API

GiftCard API - Overview
Gift Card
Transaction

GiftCard Hub API

GiftCard Hub API - Overview
Provider
Transaction

Giftcard Provider Protocol

Giftcard Provider Protocol - Overview
Gift Cards
Transactions

License Manager API

License Manager API - Overview
User
Roles
App Keys
Store
- Get Storesget
Account
- Get information about accountget

Logistics API

Logistics API - Overview
Shipping Policies
Freight Values
- Create/update freight valuespost
- List freight valuesget
Scheduled Delivery
Docks
Warehouses
Inventory
Holidays
Reservations
SLA
- Calculate SLApost
Pickup points
Polygons

Marketplace API

Marketplace API overview
Notification
- Notify marketplace of price updatepost
- Notify marketplace of inventory updatepost
SKU Approval Settings
Get Suggestions
- Get all SKU suggestionsget
- Get SKU Suggestion by IDget
Manage Suggestions
- Send SKU Suggestionput
- Delete SKU Suggestiondelete
Get Versions
- Get all Versionsget
- Get Version by IDget
Match Received SKUs
- Match Received SKUs individuallyput
- Match Multiple Received SKUsput
Matched Offers
Seller Invite
Seller Commissions
Sellers
Sent Offers

Marketplace Protocol

External Seller
External Marketplace

MasterData API - v1

MasterData API - v1 - Overview
Attachments
- Retrieve attachmentget
- Save attachmentpost
Clusters
- Validate Document by Clusterspost
Data Entities
- List data entitiesget
- Get data entity structureget
Documents
Score
Scroll
- Scroll documentsget
Search
- Search documentsget
Versions

Master Data API - v2

Master Data API - v2 - Overview
Documents
Search
- Search documentsget
Scroll
- Scroll documentsget
Schemas
Indices
Clusters
- Validate document by clusterspost
Versions

Message Center API

DKIM Configuration
- Generate DKIM keyspost

Orders API

Orders API - Overview
Orders
Invoice
- Order invoice notificationpost
- Update order's partial invoice (send tracking number)patch
Tracking
- Update order tracking statusput
Conversation
- Retrieve order conversationget
Payment
- Retrieve payment transactionget
- Send payment notificationpost
Feed v3
Order hook
User orders
- Retrieve user's ordersget
- Retrieve user order detailsget
Change seller
- Get window to change sellerget
- Update window to change sellerpost

Payment Provider Protocol

Payment Provider Protocol - Overview
Payment Flow
Configuration Flow

Payments Gateway API

Payments Gateway API - Overview
Installments
- Installments optionsget
Configuration
Transaction Process
Transaction Flow

Price Simulations API

Price Simulations API - Overview
Custom Prices
- Get custom prices schemaget
- Create or Update custom prices schemapost
Session Management
- Update Order Configurationpost
Price Association

Pricing API

Pricing API - Overview
Price Tables
Prices and Fixed Prices
Pricing Config
- Get Pricing Configget
- Gets Pricing v2 Active Statusget

Promotions & Taxes API

Promotions & Taxes API - Overview
Coupons
Promotions and Taxes
Campaign Audiences
- Get campaign audience configurationget
- Create campaign audiencepost

Search API

Search API - Overview
CrossSelling
Search
Offers
- Search Product offersget
- Search SKU offersget
Facets
- Get Category Facetsget
- Search by Store Facetsget
Autocomplete
- Product Search Autocompleteget

Session Manager API

Session Manager API - Overview
Sessions
Segment
- Get Segmentget

Subscriptions API (v2 - DEPRECATED)

Subscriptions API - v2 - Overview
Subscriptions
Subscription Group
Report
Settings
- Get Subscriptions Settingsget
- Edit Subscriptions settingspost

Subscriptions API (v3)

Subscriptions API - v3 - Overview
Cycles
Plans
- List plansget
- Get plan detailsget
Reports
Subscriptions
Settings
- Get Subscription Settingsget
- Edit Subscriptions settingspost

VTEX Do API

VTEX Do API - Overview
Note
Task

VTEX Tracking APIs

VTEX Tracking - Overview
Authentication
- Asynchronous Loginpost
Delivery Services

VTEX Shipping Network - Hubs

VTEX Shipping Network - Overview
Notification
- Notify Carrier with Apppost
Tracking
- Tracking Events with Apppost

Pricing Hub

Pricing Hub - Overview
Pricing Hub Prices
- Get Pricespost
- Configure External Price Sourceput

Policies System API

Policy Engine API - Overview
Policy

Intelligent Search API

Intelligent Search API - Overview
Autocomplete
- Get list of the 10 most searched termsget
- Get list of suggested terms and attributes similar to the search termget
Product List Page

Reviews and Ratings API

Reviews and Ratings API - Overview
Rating
- Get Product Ratingget
Review

Using this API Reference

Introduction
- Using Postman

Antifraud Provider

Antifraud Provider Protocol - Overview
Antifraud Flow
OAuth Flow

Catalog API

Checkout API

Checkout API - Overview
- orderForm
Shopping cart
Cart attachments
Custom data
Configuration
Fulfillment
- List pickup points by locationget
- Get address by postal codeget
Order placement
Region
- Get sellers by regionget

CMS API

Change URI Schema
- Change entire account (all websites)put
- Change specific websiteput

Customer Credit API

Customer Credit API - Overview
Invoices
Account
Store Configuration
- Retrieve store configurationget
- Create or change store configurationput

GiftCard API

GiftCard API - Overview
Gift Card
Transaction

GiftCard Hub API

GiftCard Hub API - Overview
Provider
Transaction

Giftcard Provider Protocol

Giftcard Provider Protocol - Overview
Gift Cards
Transactions

License Manager API

License Manager API - Overview
User
Roles
App Keys
Store
- Get Storesget
Account
- Get information about accountget

Logistics API

Logistics API - Overview
Shipping Policies
Freight Values
- Create/update freight valuespost
- List freight valuesget
Scheduled Delivery
Docks
Warehouses
Inventory
Holidays
Reservations
SLA
- Calculate SLApost
Pickup points
Polygons

Marketplace API

Marketplace API overview
Notification
- Notify marketplace of price updatepost
- Notify marketplace of inventory updatepost
SKU Approval Settings
Get Suggestions
- Get all SKU suggestionsget
- Get SKU Suggestion by IDget
Manage Suggestions
- Send SKU Suggestionput
- Delete SKU Suggestiondelete
Get Versions
- Get all Versionsget
- Get Version by IDget
Match Received SKUs
- Match Received SKUs individuallyput
- Match Multiple Received SKUsput
Matched Offers
Seller Invite
Seller Commissions
Sellers
Sent Offers

Marketplace Protocol

External Seller
External Marketplace

MasterData API - v1

MasterData API - v1 - Overview
Attachments
- Retrieve attachmentget
- Save attachmentpost
Clusters
- Validate Document by Clusterspost
Data Entities
- List data entitiesget
- Get data entity structureget
Documents
Score
Scroll
- Scroll documentsget
Search
- Search documentsget
Versions

Master Data API - v2

Master Data API - v2 - Overview
Documents
Search
- Search documentsget
Scroll
- Scroll documentsget
Schemas
Indices
Clusters
- Validate document by clusterspost
Versions

Message Center API

DKIM Configuration
- Generate DKIM keyspost

Orders API

Orders API - Overview
Orders
Invoice
- Order invoice notificationpost
- Update order's partial invoice (send tracking number)patch
Tracking
- Update order tracking statusput
Conversation
- Retrieve order conversationget
Payment
- Retrieve payment transactionget
- Send payment notificationpost
Feed v3
Order hook
User orders
- Retrieve user's ordersget
- Retrieve user order detailsget
Change seller
- Get window to change sellerget
- Update window to change sellerpost

Payment Provider Protocol

Payment Provider Protocol - Overview
Payment Flow
Configuration Flow

Payments Gateway API

Payments Gateway API - Overview
Installments
- Installments optionsget
Configuration
Transaction Process
Transaction Flow

Price Simulations API

Price Simulations API - Overview
Custom Prices
- Get custom prices schemaget
- Create or Update custom prices schemapost
Session Management
- Update Order Configurationpost
Price Association

Pricing API

Pricing API - Overview
Price Tables
Prices and Fixed Prices
Pricing Config
- Get Pricing Configget
- Gets Pricing v2 Active Statusget

Promotions & Taxes API

Promotions & Taxes API - Overview
Coupons
Promotions and Taxes
Campaign Audiences
- Get campaign audience configurationget
- Create campaign audiencepost

Search API

Search API - Overview
CrossSelling
Search
Offers
- Search Product offersget
- Search SKU offersget
Facets
- Get Category Facetsget
- Search by Store Facetsget
Autocomplete
- Product Search Autocompleteget

Session Manager API

Session Manager API - Overview
Sessions
Segment
- Get Segmentget

Subscriptions API (v2 - DEPRECATED)

Subscriptions API - v2 - Overview
Subscriptions
Subscription Group
Report
Settings
- Get Subscriptions Settingsget
- Edit Subscriptions settingspost

Subscriptions API (v3)

Subscriptions API - v3 - Overview
Cycles
Plans
- List plansget
- Get plan detailsget
Reports
Subscriptions
Settings
- Get Subscription Settingsget
- Edit Subscriptions settingspost

VTEX Do API

VTEX Do API - Overview
Note
Task

VTEX Tracking APIs

VTEX Tracking - Overview
Authentication
- Asynchronous Loginpost
Delivery Services

VTEX Shipping Network - Hubs

VTEX Shipping Network - Overview
Notification
- Notify Carrier with Apppost
Tracking
- Tracking Events with Apppost

Pricing Hub

Pricing Hub - Overview
Pricing Hub Prices
- Get Pricespost
- Configure External Price Sourceput

Policies System API

Policy Engine API - Overview
Policy

Intelligent Search API

Intelligent Search API - Overview
Autocomplete
- Get list of the 10 most searched termsget
- Get list of suggested terms and attributes similar to the search termget
Product List Page

Reviews and Ratings API

Reviews and Ratings API - Overview
Rating
- Get Product Ratingget
Review

Schemas

Schemas are used to customize searches, creations and modifications of Documents in Master Data V2. More information on how Schemas work can be found in the article Schema Lifecycle.