Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

Yampi (BYOK) — connector documentation

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

What Yampi (BYOK) is for

Yampi (BYOK) lets an AI assistant read your own Yampi data through the Yampi API with a key you supply (Yampi User-Token (Profile > API credentials in the admin)). Read-only: 12 tools (get_store_data, list_products, list_skus, list_categories, list_brands, list_orders, list_order_items, list_order_status_history, list_order_statuses, list_payment_methods, list_product_reviews, list_carriers). 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 api.dooki.com.br. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Yampi. Yampi 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:

  • "What are my Yampi store's basic details?"
  • "Which products are active in my Yampi store?"
  • "Which Yampi SKUs are low on stock?"
  • "What categories does my Yampi store have?"
  • "Which brands are registered in my Yampi store?"
  • "What are the latest orders in my Yampi store?"

What it does

  • get_store_data: Show the store's profile: name, type, description, maintenance flag, city, state, products per page and logo. Owner, tax and billing details are not returned.
  • list_products: List catalog products with name, SKU, active flag, rating, stock total, number of orders, shipping setting and public URL.
  • list_skus: List SKUs with code, barcode, title, cost and sale price, weight, stock total and stock status. Can filter by stock quantity.
  • list_categories: List catalog categories with name, slug, parent, active and featured flags and URL path.
  • list_brands: List catalog brands with name, description, active and featured flags.
  • list_orders: List orders with number, totals, shipping service, delivery days, tracking code and URL, payment authorization and campaign source. Customer, address and IP data are not returned.
  • list_order_items: List the items of one order with product and SKU ids, quantity, price, cost, shipping cost and gift flag.
  • list_order_status_history: List the status changes of one order with status name, alias, details and time.
  • list_order_statuses: List the order statuses configured in the store with name, alias and description.
  • list_payment_methods: List the payment methods created in the store with name, type flags (card, Pix, boleto, wallet) and whether each is configured and active.
  • list_product_reviews: List product reviews with product, rating, approval flag and message. Reviewer name and email are not returned.
  • list_carriers: List the shipping carriers set up in the store with type, active flag, origin ZIP code, price markup and weight limits.

BYOK key

You bring your own Yampi Yampi User-Token (Profile > API credentials in the admin) (https://docs.yampi.com.br/auth/auth-user-token). 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 api.dooki.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

Live from the Yampi API (api.dooki.com.br) with a BYOK key; documentation: https://docs.yampi.com.br/. 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 Yampi. Yampi 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 Yampi account.

Built for: Worldwide. Languages: English.