{"openapi":"3.1.0","info":{"title":"Wix Stores Catalog Setup (your key) API","version":"0.1.0","description":"Wix Stores Catalog Setup (your key) lets an AI assistant read your own Wix Stores Catalog data through the Wix Stores Catalog API with a key you supply (Wix API key). Read-only: 9 tools (get_catalog_version, query_brands, get_brand, query_ribbons, get_ribbon, query_customizations, query_categories, list_site_currencies, list_supported_currencies). The BYOK key travels with each request, is used...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-wix-stores-catalog.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-wix-stores-catalog/docs"},"termsOfService":"https://connectorbay.com/byok-wix-stores-catalog/terms"},"servers":[{"url":"https://byok-wix-stores-catalog.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-wix-stores-catalog/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_catalog_version":{"post":{"operationId":"get_catalog_version","summary":"Check which Wix Stores catalog version the site runs (V1, V3, or stores not installed). Use for \"Is my Wix store on the ","description":"Check which Wix Stores catalog version the site runs (V1, V3, or stores not installed). Use for \"Is my Wix store on the V3 catalog\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_catalog_versionArguments","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/query_brands":{"post":{"operationId":"query_brands","summary":"List the store's product brands (up to 100 per page, newest first) with how many products each is assigned to. Use for \"","description":"List the store's product brands (up to 100 per page, newest first) with how many products each is assigned to. Use for \"Which brands does my Wix store have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many results to return (1 to 100).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":2000,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from the previous answer's next-page value; leave out for the first page.","title":"Cursor"}},"title":"query_brandsArguments","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_brand":{"post":{"operationId":"get_brand","summary":"Get one brand by id with its name and number of assigned products. Use for \"Show Wix brand 8046df3c-7575-4098-a5ab-c91ad","description":"Get one brand by id with its name and number of assigned products. Use for \"Show Wix brand 8046df3c-7575-4098-a5ab-c91ad8f33c47\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"brand_id":{"description":"Brand id (a GUID from query_brands).","maxLength":64,"title":"Brand Id","type":"string"}},"required":["brand_id"],"title":"get_brandArguments","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/query_ribbons":{"post":{"operationId":"query_ribbons","summary":"List the product ribbons (badges such as New or Sale) with how many products carry each. Use for \"Which ribbons are defi","description":"List the product ribbons (badges such as New or Sale) with how many products carry each. Use for \"Which ribbons are defined in my Wix store\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many results to return (1 to 100).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":2000,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from the previous answer's next-page value; leave out for the first page.","title":"Cursor"}},"title":"query_ribbonsArguments","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_ribbon":{"post":{"operationId":"get_ribbon","summary":"Get one product ribbon by id. Use for \"Show Wix ribbon 8046df3c-7575-4098-a5ab-c91ad8f33c47\".","description":"Get one product ribbon by id. Use for \"Show Wix ribbon 8046df3c-7575-4098-a5ab-c91ad8f33c47\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"ribbon_id":{"description":"Ribbon id (a GUID from query_ribbons).","maxLength":64,"title":"Ribbon Id","type":"string"}},"required":["ribbon_id"],"title":"get_ribbonArguments","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/query_customizations":{"post":{"operationId":"query_customizations","summary":"List the reusable product customizations (option sets, free-text inputs, choice lists) with type, render type and assign","description":"List the reusable product customizations (option sets, free-text inputs, choice lists) with type, render type and assigned product count. Use for \"Which product customizations does my Wix store define\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many results to return (1 to 100).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":2000,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from the previous answer's next-page value; leave out for the first page.","title":"Cursor"}},"title":"query_customizationsArguments","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/query_categories":{"post":{"operationId":"query_categories","summary":"List the store's product categories (name, slug, item count, visibility, parent) from the Wix Stores category tree. Use ","description":"List the store's product categories (name, slug, item count, visibility, parent) from the Wix Stores category tree. Use for \"Which product categories does my Wix store have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many results to return (1 to 100).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":2000,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from the previous answer's next-page value; leave out for the first page.","title":"Cursor"}},"title":"query_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_site_currencies":{"post":{"operationId":"list_site_currencies","summary":"List the currencies enabled for display on the site (three-letter codes). Use for \"Which currencies can visitors view pr","description":"List the currencies enabled for display on the site (three-letter codes). Use for \"Which currencies can visitors view prices in on my Wix site\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_site_currenciesArguments","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_supported_currencies":{"post":{"operationId":"list_supported_currencies","summary":"List all currencies Wix supports with code and symbol. Use for \"Which currencies does Wix support\".","description":"List all currencies Wix supports with code and symbol. Use for \"Which currencies does Wix support\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_supported_currenciesArguments","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}}}}