E CommerceInventoryapiKey16 EndpointsREST
For Agents
Programmatically get autoapprove status in account settings, activate autoapprove in marketplace's account. Covers 16 operations with apiKey authentication.
Use for: I need to autoapprove status in account settings, I want to activate autoapprove in marketplace's account, Search for account's approval settings, Find all save account's approval settings
Not supported: Does not handle payments, communications, or crm - use for e-commerce only.
The **Marketplace API** enables marketplaces and sellers hosted on VTEX to perform their collaborative operations. >⚠️ The marketplace must [create an appKey and appToken](https://developers.vtex.com/docs/guides/getting-started-authentication) for each non-VTEX seller that will use this API. Index Notification Endpoints used by sellers to notify marketplaces that the price or inventory language ha. The API exposes 16 endpoints secured with apiKey authentication.
Install Jentic One Beta
Connect the Suggestions to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Suggestions, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fvtex.local%2Fsuggestions" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fvtex.local%2Fsuggestions" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Suggestions API.
Get autoApprove status in account settings
Activate autoApprove in marketplace's account
Save account's approval settings
Query and filter Suggestions records by parameters
Monitor Suggestions operational status and events
Use Cases
Patterns agents use Suggestions API for, with concrete tasks.
★ E-Commerce Operations
Use the Suggestions to perform e commerce operations programmatically. The API provides 16 endpoints covering core functionality including get autoapprove status in account settings, activate autoapprove in marketplace's account, get account's approval settings.
Call GET /suggestions/configuration/autoapproval/toggle to get autoapprove status in account settings
Automated Get suggestions Management
Automate get suggestions operations by combining multiple Suggestions endpoints. Agents can activate autoapprove in marketplace's account and then get account's approval settings in a single workflow.
Call PUT /suggestions/configuration/autoapproval/toggle to activate autoapprove in marketplace's account, then verify the result
AI Agent Integration via Jentic
AI agents discover and call Suggestions endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.
Search Jentic for 'get autoapprove status in account settings', load the operation schema, and execute with Jentic-managed credentials
Key Endpoints
16 endpoints — the **marketplace api** enables marketplaces and sellers hosted on vtex to perform their collaborative operations.
METHOD
PATH
DESCRIPTION
GET
/suggestions/configuration/autoapproval/toggle
Get autoApprove status in account settings
PUT
/suggestions/configuration/autoapproval/toggle
Activate autoApprove in marketplace's account
GET
/suggestions/configuration
Get account's approval settings
PUT
/suggestions/configuration
Save account's approval settings
GET
/suggestions/configuration/account/config
Get account's matcher settings
GET
/suggestions/configuration/seller/{sellerId}
Get seller's approval settings
PUT
/suggestions/configuration/seller/{sellerId}
Save seller's approval settings
PUT
/suggestions/configuration/autoapproval/toggle/seller/{sellerId}
Activate autoApprove setting for a seller
GET
/suggestions/configuration/autoapproval/toggle
Get autoApprove status in account settings
PUT
/suggestions/configuration/autoapproval/toggle
Activate autoApprove in marketplace's account
GET
/suggestions/configuration
Get account's approval settings
PUT
/suggestions/configuration
Save account's approval settings
GET
/suggestions/configuration/account/config
Get account's matcher settings
GET
/suggestions/configuration/seller/{sellerId}
Get seller's approval settings
PUT
/suggestions/configuration/seller/{sellerId}
Save seller's approval settings
PUT
/suggestions/configuration/autoapproval/toggle/seller/{sellerId}
Activate autoApprove setting for a seller
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
S
Suggestions
- AI-Aware (B)63/100
51
Foundational Compliance66
Developer Experience & Jentic Compatibility59
AI-Readiness & Agent Experience94
Agent Usability50
Security78
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
51
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: C-Signals: 4
82%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
0%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
21%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
66
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: BSignals: 4
45%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
25%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
93%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
59
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: C+Signals: 4
76%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
59%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
50
Security
Trust, risk posture, and security compliance.
Grade: C-Signals: 1
50%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
78
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A-Signals: 1
78%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the VTEX Suggestions API by hand means pairing an App Key with an App Token in the X-VTEX-API-AppKey and X-VTEX-API-AppToken headers, and templating the api.vtex.com/{accountName} host into every call. Through Jentic you install once, import Suggestions from the API Directory, store the App Key and App Token once, and your agent calls it.
Permission scoping
The Suggestions API puts the seller id in the URL path (/suggestions/configuration/seller/{sellerId}), so a rule can pin your agent to one seller's configuration. You choose the operations it may call, so writes like toggling auto-approval are not included unless you add them.
Credential isolation
Your VTEX App Key and App Token are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'get the auto-approval toggle status' or 'read a seller's suggestion configuration', and Jentic returns the matching Suggestions operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
Alternative
Stripe
Alternative e commerce API
Choose Stripe when you need a different approach to e commerce operations
FAQs
Specific to using Suggestions API through Jentic.
What authentication does the Suggestions use?
The Suggestions uses an API key passed in the `X-VTEX-API-AppKey` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.
Can I get autoapprove status in account settings with the Suggestions?
Yes. Use the GET /suggestions/configuration/autoapproval/toggle endpoint. The API returns structured JSON responses that agents can parse and act on directly.
What are the rate limits for the Suggestions?
Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.
How do I get autoapprove status in account settings through Jentic?
Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'get autoapprove status in account settings'. Jentic returns the matching Suggestions operation with its input schema. Load the schema and execute the call - credentials are injected automatically.
How many endpoints does the Suggestions have?
The Suggestions exposes 16 endpoints covering get suggestions, manage suggestions, get versions operations.
Can I limit what my agent is allowed to do with the Suggestions API?
Yes. Because you run Jentic One yourself, your own rules decide which Suggestions operations and credentials the agent may use. The seller id sits in the URL path, as in GET /suggestions/configuration/seller/{sellerId}, so you can pin the agent to a single seller's configuration. You also choose the specific operations it may call, so write actions like PUT /suggestions/configuration/autoapproval/toggle stay out of reach unless you explicitly add them.
GET STARTED