VTEX (BYOK)

VTEX (BYOK) — connector documentation

• MCP endpoint: https://byok-vtex.connectorbay.com/mcp
• REST API: POST https://byok-vtex.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-vtex.connectorbay.com/openapi.json
• Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
• Authentication: your own VTEX VTEX app key, sent in the X-Upstream-Key header and the VTEX app token in X-Upstream-Key-2 of every request (never stored, logged or cached)
• Health: https://byok-vtex.connectorbay.com/health · Tool schemas: https://byok-vtex.connectorbay.com/tools.json
• Publisher: Unify Dynamics LLC · connectorbay.com/byok-vtex · agent@connectorbay.com

What VTEX (BYOK) is for

VTEX (BYOK) lets an AI assistant read your own VTEX data through the VTEX API with a key you supply (VTEX app key). Read-only: 11 tools (list_orders, get_order, list_product_and_sku_ids, get_product, get_sku, get_sku_inventory, get_category_tree, get_category, list_brands, list_sales_channels, list_warehouses). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to *.vtexcommercestable.com.br. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by VTEX. VTEX and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

• "Which VTEX orders are waiting for payment approval?"
• "Show VTEX order v502556llux-01"
• "Which products and SKUs exist in my VTEX category 12?"
• "Show VTEX catalog product 1"
• "Show VTEX SKU 2"
• "How much stock does VTEX SKU 2 have in each warehouse?"

What it does

• list_orders: List orders with id, creation date, client name, item count, total value (in cents), payment names, status and sales channel. At most 100 per page and 30 pages per query: narrow with filters.
• get_order: Get one order by id with status, totals, sellers, items (SKU, quantity, price), marketing data and store currency. Buyer documents, addresses and payment details are not returned.
• list_product_and_sku_ids: List product ids with the SKU ids of each, optionally for one category. Returns at most 250 records per call; page with from_index and to_index.
• get_product: Get one catalog product by id with name, category, brand, reference id, visibility, descriptions, release date and stock display rule.
• get_sku: Get one SKU by id with product id, name, reference id, active flag, dimensions, weight, kit flag and creation date.
• get_sku_inventory: Show stock of one SKU per warehouse: total, reserved and unlimited-stock flag.
• get_category_tree: Get the category tree down to a number of levels with id, name, URL and children.
• get_category: Get one category by id with name, parent, title, active flag and tree path.
• list_brands: List catalog brands one page at a time with id, name, active flag and title.
• list_sales_channels: List the store's sales channels (trade policies) with name, active flag, country, currency and time zone.
• list_warehouses: List warehouses with id, name, priority, active flag and linked docks.

BYOK key

You bring your own VTEX VTEX app key (https://developers.vtex.com/docs/guides/api-authentication-using-api-keys). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to *.vtexcommercestable.com.br over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

• https://developers.vtex.com/docs/api-reference/orders-api (the API this connector calls, with a BYOK key)

Live from the VTEX API (*.vtexcommercestable.com.br) with a BYOK key; documentation: https://developers.vtex.com/docs/api-reference/orders-api. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by VTEX. VTEX and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your VTEX account.

Built for: Worldwide. Languages: English.

VTEX (BYOK) — Privacy Policy

Effective 24 October 2026. Unify Dynamics LLC ("we", "us"), Menlo Park, California.

What VTEX (BYOK) is. VTEX (BYOK) is a connector (an MCP server and REST API) that an AI assistant calls on your behalf to read your own VTEX data: Read your VTEX store orders, catalog products, SKUs, categories, brands, sales channels, warehouses and stock with your own app key and app token. You bring your own VTEX VTEX app key; the assistant sends it to us with each request.

BYOK key. The key you supply is used to make the one VTEX call you asked for. Our application does not store it, write it to a log, put it in a cache, or share it. It is sent only to *.vtexcommercestable.com.br, over https, and is removed from any text we return to you or your assistant. We do not follow redirects with your key. If VTEX rejects it, we say so without repeating it.

What we receive. The arguments of each tool call, the BYOK key (for that call only), the technical headers needed to serve the request (an IP address or a client identifier supplied by the assistant) and standard server logs. What VTEX receives. The request we make on your behalf, including the key and the arguments, under VTEX's own terms and privacy policy. VTEX acts at your direction and is the only recipient of the data of your request besides our hosting provider.

What we return. The answer VTEX gives for your request, trimmed to the fields the tool documents. We do not keep it: it is returned to your assistant and not stored, cached or used to train anything.

What we do not do. We do not build a profile, sell or share personal information, or keep your VTEX data. Rate-limit counters (a client identifier and timestamps) are held in memory for at most 24 hours. Hosting access logs (IP addresses, request paths and status codes) are kept for up to 30 days for security and abuse prevention; our application adds no request headers or bodies to them.

Sub-processors. VTEX (the API you call with a BYOK key, at your direction). Hosting: Vercel (United States regions).

Your rights. Because we store no personal data beyond short-lived logs, requests to access, correct or delete data are usually satisfied automatically; you can still contact agent@connectorbay.com and we will respond within 30 days. Revoke your key at VTEX at any time to end all access.

Children. VTEX (BYOK) is a general-audience service operated by the adult using the assistant, under VTEX's own age rules.

Changes. We will post changes here with a new effective date.

VTEX (BYOK) — Terms of Service

Effective 24 October 2026. These terms govern use of the VTEX (BYOK) connector ("the Service") operated by Unify Dynamics LLC ("we", "us").

1. The Service. VTEX (BYOK) provides: Read your VTEX store orders, catalog products, SKUs, categories, brands, sales channels, warehouses and stock with your own app key and app token. It is accessed through an AI assistant or directly over MCP or HTTP, and is read-only.
2. Your own key, your own account. You must use your own VTEX credentials and only access data you are allowed to access. VTEX's terms apply to your use of VTEX; you are responsible for complying with them, including any rate limits and permitted uses. Do not share a key you do not own.
3. Independent. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by VTEX. VTEX and its logos are trademarks of their owners and are used only to say which service the connector works with.
4. No advice, no guarantees. Output is the data VTEX returns, lightly trimmed; it may be incomplete, delayed or changed by VTEX. Check important facts at the source.
5. Read-only. The Service does not create, change, send or delete anything in your VTEX account.
6. Acceptable use. Automated use within the published rate limits is welcome. Do not use the Service to access data you are not entitled to, to circumvent VTEX's controls, or to attack any system.
7. Availability. The Service is provided "as is" without warranty. We may change, limit or discontinue it at any time; VTEX may change or end its API at any time.
8. Data. Our Privacy Policy describes what we process. In short: the BYOK key is used for the one call and not stored or logged.
9. Pro keys. Optional ConnectorBay Pro API keys are issued at our discretion and are separate from your VTEX key.
10. Liability. To the fullest extent permitted by law, Unify Dynamics LLC is not liable for any loss arising from use of or reliance on the Service, including any action VTEX takes on your account. Our total liability is limited to US $100.
11. Governing law. California law; venue in San Mateo County, California.
12. Contact. Unify Dynamics LLC · agent@connectorbay.com · https://connectorbay.com/byok-vtex

VTEX (BYOK) support

Email agent@connectorbay.com. We answer within two business days.

• MCP endpoint: https://byok-vtex.connectorbay.com/mcp
• REST API: https://byok-vtex.connectorbay.com/openapi.json
• Live status: https://byok-vtex.connectorbay.com/health

When you report a problem, include the question you asked your agent, roughly when, and which agent you used (for example Claude, ChatGPT or Gemini). Never send us passwords, account numbers or ID numbers. VTEX (BYOK) never asks for them.