canonical: https://jentic.com/apis/vtex.local/suggestions # Vtex Suggestions 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. ## For AI agents Programmatically get autoapprove status in account settings, activate autoapprove in marketplace's account. Covers 16 operations with apiKey authentication. ## Scope Does not handle payments, communications, or crm - use for e-commerce only. ## Capabilities - 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 ### 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. Example prompt: 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. Example prompt: 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. Example prompt: Search Jentic for 'get autoapprove status in account settings', load the operation schema, and execute with Jentic-managed credentials ## Key endpoints | 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 | ## Key resources - **Get suggestions** — Search and filter all suggestions using specific criteria. - **Manage suggestions** — Send or delete SKU suggestions from the seller to marketplace. - **Get versions** — Search and filter all versions of suggestions, using specific criteria. - **SKU approval settings** — Operations related to SKU approval settings - **Match received SKUs** — Match SKU suggestions received in the marketplace. ## Why Jentic - **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 handling:** 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. - **Discovery method:** 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 - **Shopify** — Alternative e commerce API - **Stripe** — Alternative e commerce API ## FAQ ### 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.