{"openapi":"3.1.0","info":{"title":"BigCommerce (BYOK) API","version":"0.1.0","description":"BigCommerce (BYOK) lets an AI assistant read your own BigCommerce data through the BigCommerce API with a key you supply (API account access token (create it with read-only scopes)). Read-only: 7 tools (get_store_information, list_products, get_product, list_categories, list_orders, get_order, list_customers). The BYOK key travels with each request, is used for that one call only and is never...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-bigcommerce.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-bigcommerce/docs"},"termsOfService":"https://connectorbay.com/byok-bigcommerce/terms"},"servers":[{"url":"https://byok-bigcommerce.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-bigcommerce/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_store_information":{"post":{"operationId":"get_store_information","summary":"Show the store's name, domain, plan, currency, time zone, country and status. Needs the store information read scope. Us","description":"Show the store's name, domain, plan, currency, time zone, country and status. Needs the store information read scope. Use for \"What are the details of my BigCommerce store\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"store_hash":{"description":"The store's permanent hash: the part after 'store-' in the API path shown when you create the API account, for example 'abc123xyz'.","maxLength":30,"title":"Store Hash","type":"string"}},"required":["store_hash"],"title":"get_store_informationArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_products":{"post":{"operationId":"list_products","summary":"List catalog products with price, stock level, visibility and sales count, filtered by name or keyword, SKU, availabilit","description":"List catalog products with price, stock level, visibility and sales count, filtered by name or keyword, SKU, availability or visibility. Needs the products read scope. Use for \"Which of my BigCommerce products are out of stock\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"store_hash":{"description":"The store's permanent hash: the part after 'store-' in the API path shown when you create the API account, for example 'abc123xyz'.","maxLength":30,"title":"Store Hash","type":"string"},"keyword":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Text matched against product name, description, SKU and brand name.","title":"Keyword"},"name":{"anyOf":[{"maxLength":250,"type":"string"},{"type":"null"}],"default":null,"description":"Exact product name.","title":"Name"},"sku":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Main product SKU.","title":"Sku"},"availability":{"anyOf":[{"enum":["available","disabled","preorder"],"type":"string"},{"type":"null"}],"default":null,"description":"Only available, disabled or preorder products.","title":"Availability"},"is_visible":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for visible products only, false for hidden ones.","title":"Is Visible"},"out_of_stock":{"anyOf":[{"maximum":1,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Pass 1 to list only products that are out of stock.","title":"Out Of Stock"},"sort":{"anyOf":[{"enum":["id","name","sku","price","date_modified","inventory_level","total_sold","is_visible"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort field.","title":"Sort"},"direction":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction.","title":"Direction"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Results per page (1 to 100; provider default 50).","title":"Limit"}},"required":["store_hash"],"title":"list_productsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_product":{"post":{"operationId":"get_product","summary":"Get one catalog product with price, cost, stock, dimensions, availability and dates. Use for \"Show BigCommerce product 1","description":"Get one catalog product with price, cost, stock, dimensions, availability and dates. Use for \"Show BigCommerce product 123\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"store_hash":{"description":"The store's permanent hash: the part after 'store-' in the API path shown when you create the API account, for example 'abc123xyz'.","maxLength":30,"title":"Store Hash","type":"string"},"product_id":{"description":"Numeric product ID.","title":"Product Id","type":"integer"}},"required":["store_hash","product_id"],"title":"get_productArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_categories":{"post":{"operationId":"list_categories","summary":"List catalog categories with parent, visibility and storefront URL. Needs the products read scope. Use for \"What product","description":"List catalog categories with parent, visibility and storefront URL. Needs the products read scope. Use for \"What product categories does my BigCommerce store have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"store_hash":{"description":"The store's permanent hash: the part after 'store-' in the API path shown when you create the API account, for example 'abc123xyz'.","maxLength":30,"title":"Store Hash","type":"string"},"name":{"anyOf":[{"maxLength":250,"type":"string"},{"type":"null"}],"default":null,"description":"Exact category name.","title":"Name"},"parent_id":{"anyOf":[{"maximum":2000000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only children of this category ID (0 for top level).","title":"Parent Id"},"is_visible":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for visible categories only, false for hidden ones.","title":"Is Visible"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Results per page (1 to 100; provider default 50).","title":"Limit"}},"required":["store_hash"],"title":"list_categoriesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_orders":{"post":{"operationId":"list_orders","summary":"List orders (API v2) with status, payment status, totals, customer and dates. Returns a plain list; page with page and l","description":"List orders (API v2) with status, payment status, totals, customer and dates. Returns a plain list; page with page and limit. Needs the orders read scope. Use for \"What orders came in this week in my BigCommerce store\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"store_hash":{"description":"The store's permanent hash: the part after 'store-' in the API path shown when you create the API account, for example 'abc123xyz'.","maxLength":30,"title":"Store Hash","type":"string"},"status_id":{"anyOf":[{"maximum":1000,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only orders with this numeric status ID (the order's status_id field shows the ID in use).","title":"Status Id"},"customer_id":{"anyOf":[{"maximum":2000000000,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only orders of this customer ID.","title":"Customer Id"},"email":{"anyOf":[{"maxLength":250,"type":"string"},{"type":"null"}],"default":null,"description":"Only orders of this customer email.","title":"Email"},"min_date_created":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only orders created at or after this ISO 8601 or RFC 2822 time, for example 2026-10-01T00:00:00Z.","title":"Min Date Created"},"max_date_created":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only orders created at or before this time.","title":"Max Date Created"},"sort":{"anyOf":[{"enum":["id:asc","id:desc","date_created:asc","date_created:desc","date_modified:asc","date_modified:desc","status_id:asc","status_id:desc"],"type":"string"},{"type":"null"}],"default":"date_created:desc","description":"Sort field with optional direction, for example 'date_created:desc'.","title":"Sort"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Results per page (1 to 100; provider default 50).","title":"Limit"}},"required":["store_hash"],"title":"list_ordersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_order":{"post":{"operationId":"get_order","summary":"Get one order (API v2) with status, totals, taxes, payment method and billing contact name. Use for \"Show BigCommerce or","description":"Get one order (API v2) with status, totals, taxes, payment method and billing contact name. Use for \"Show BigCommerce order 100\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"store_hash":{"description":"The store's permanent hash: the part after 'store-' in the API path shown when you create the API account, for example 'abc123xyz'.","maxLength":30,"title":"Store Hash","type":"string"},"order_id":{"description":"Numeric order ID.","title":"Order Id","type":"integer"}},"required":["store_hash","order_id"],"title":"get_orderArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_customers":{"post":{"operationId":"list_customers","summary":"List customers (API v3) with name, email, company, group and creation date, filtered by email, name or date. Needs the c","description":"List customers (API v3) with name, email, company, group and creation date, filtered by email, name or date. Needs the customers read scope. Use for \"Find the BigCommerce customer jo@example.com\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"store_hash":{"description":"The store's permanent hash: the part after 'store-' in the API path shown when you create the API account, for example 'abc123xyz'.","maxLength":30,"title":"Store Hash","type":"string"},"email_in":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated email addresses to match exactly.","title":"Email In"},"name_like":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Substring of first plus last name.","title":"Name Like"},"date_created_min":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only customers created after this ISO 8601 time.","title":"Date Created Min"},"sort":{"anyOf":[{"enum":["date_created:asc","date_created:desc","last_name:asc","last_name:desc","date_modified:asc","date_modified:desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort order.","title":"Sort"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Results per page (1 to 100; provider default 50).","title":"Limit"}},"required":["store_hash"],"title":"list_customersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}