VTEX API: what it can do and how to use it with AI agents
VTEX exposes REST APIs for almost every module of the e-commerce platform: catalog, orders, logistics, prices and customers. Mid-size and large retailers and manufacturers use it, along with their integrators. Access is through an application key and token generated in the account.
What the VTEX API offers
Catalog
Products, SKUs, categories, brands and specifications.
Orders (OMS)
Look up, track and change the status of orders, including cancellation.
Logistics and inventory
Stock by warehouse, loading docks and delivery settings.
Prices
Price tables and rules by SKU and trade policy.
Promotions
Create and look up promotions and coupons.
Master Data
Customer data and custom entities of the store.
How to access the VTEX API
- With your company’s credentialsIt uses an App Key and App Token pair created in the VTEX admin, linked to access profiles that define what the key can do.
- Some APIs have request limits: bulk integrations must respect them.
- Broad access profiles give the key too much power: create a dedicated profile for the agent.
- Customer data in Master Data is covered by data-protection law such as GDPR.
Official documentation: developers.vtex.com
What an iTeam agent does with the VTEX API
Support with the order at hand
The agent checks the order in the OMS and the tracking, answers the customer and opens a case with the team when a parcel is lost or late.
Stock-outs
The agent compares sales with stock by warehouse and warns purchasing about SKUs that will run out in the next few days.
Stuck orders
Orders held in one status for too long are listed, with the likely reason, for the operations team.
Promotion review
Before a campaign, the agent checks active promotions and flags discount conflicts or SKUs without a price.
From the credential to the agent at work, with approval
Create the application key
In the VTEX admin, generate an App Key and App Token and link them to an access profile with minimum permissions.
Store it in the iTeam vault
The credentials stay in the vault, and each agent gets only the actions it needs, such as reading orders or adjusting stock.
Validate in a staging setup
Test in a development environment or VTEX workspace and keep approval for cancellations and prices.
Ready-made AI teams that use VTEX
Questions about the VTEX API
Is the VTEX API free?
Use of the APIs is part of the VTEX platform contract. In general there is no separate per-call charge for your own store.
Do I need to code to use the VTEX API with iTeam?
Not necessarily. iTeam's HTTP tool learns the endpoints from the VTEX documentation, and the deployment team sets up the flows.
Can the agent cancel orders?
Yes, if the access profile allows it, but we recommend that cancellations go through human approval.
