{"openapi":"3.1.0","info":{"title":"Lightspeed Shop Shipping, Payment and Tax Setup (your keys) API","version":"0.1.0","description":"Lightspeed Shop Shipping, Payment and Tax Setup (your keys) lets an AI assistant read your own Lightspeed Ecom Setup data through the Lightspeed Ecom Setup API with a key you supply (API key). Read-only: 8 tools (list_shipping_methods, get_shipping_method, list_shipping_method_countries, list_shipping_method_values, list_payment_methods, list_taxes, list_countries, list_languages). The BYOK key...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-lightspeed-ecom-setup.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-lightspeed-ecom-setup/docs"},"termsOfService":"https://connectorbay.com/byok-lightspeed-ecom-setup/terms"},"servers":[{"url":"https://byok-lightspeed-ecom-setup.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-lightspeed-ecom-setup/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/list_shipping_methods":{"post":{"operationId":"list_shipping_methods","summary":"List the shop's shipping methods with type (default, cash on delivery, pickup), free-shipping threshold, payment fees an","description":"List the shop's shipping methods with type (default, cash on delivery, pickup), free-shipping threshold, payment fees and title. Use for \"Which shipping methods does my Lightspeed eCom shop offer\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"shop_language":{"description":"Two-letter shop language code used in the API path, for example 'en' or 'nl'.","maxLength":5,"title":"Shop Language","type":"string"},"limit":{"anyOf":[{"maximum":250,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many results to return (1 to 250).","title":"Limit"},"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"since_id":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Only records with an id above this value.","title":"Since Id"}},"required":["shop_language"],"title":"list_shipping_methodsArguments","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_shipping_method":{"post":{"operationId":"get_shipping_method","summary":"Get one shipping method by id with type, free-shipping threshold, payment fees and description. Use for \"Show Lightspeed","description":"Get one shipping method by id with type, free-shipping threshold, payment fees and description. Use for \"Show Lightspeed eCom shipping method 33265\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"shop_language":{"description":"Two-letter shop language code used in the API path, for example 'en' or 'nl'.","maxLength":5,"title":"Shop Language","type":"string"},"shippingmethod_id":{"description":"Numeric shipping method id from list_shipping_methods.","maxLength":20,"title":"Shippingmethod Id","type":"string"}},"required":["shop_language","shippingmethod_id"],"title":"get_shipping_methodArguments","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_shipping_method_countries":{"post":{"operationId":"list_shipping_method_countries","summary":"List the countries one shipping method delivers to (id, ISO codes and name). Use for \"Which countries does shipping meth","description":"List the countries one shipping method delivers to (id, ISO codes and name). Use for \"Which countries does shipping method 33265 deliver to\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"shop_language":{"description":"Two-letter shop language code used in the API path, for example 'en' or 'nl'.","maxLength":5,"title":"Shop Language","type":"string"},"shippingmethod_id":{"description":"Numeric shipping method id from list_shipping_methods.","maxLength":20,"title":"Shippingmethod Id","type":"string"}},"required":["shop_language","shippingmethod_id"],"title":"list_shipping_method_countriesArguments","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_shipping_method_values":{"post":{"operationId":"list_shipping_method_values","summary":"List the weight-based price tiers of one shipping method (minimum and maximum weight, price excluding and including tax)","description":"List the weight-based price tiers of one shipping method (minimum and maximum weight, price excluding and including tax). Use for \"What are the weight prices of shipping method 33265\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"shop_language":{"description":"Two-letter shop language code used in the API path, for example 'en' or 'nl'.","maxLength":5,"title":"Shop Language","type":"string"},"shippingmethod_id":{"description":"Numeric shipping method id from list_shipping_methods.","maxLength":20,"title":"Shippingmethod Id","type":"string"}},"required":["shop_language","shippingmethod_id"],"title":"list_shipping_method_valuesArguments","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_payment_methods":{"post":{"operationId":"list_payment_methods","summary":"List the active payment methods of the shop with key and title. Use for \"Which payment methods are active in my Lightspe","description":"List the active payment methods of the shop with key and title. Use for \"Which payment methods are active in my Lightspeed eCom shop\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"shop_language":{"description":"Two-letter shop language code used in the API path, for example 'en' or 'nl'.","maxLength":5,"title":"Shop Language","type":"string"},"limit":{"anyOf":[{"maximum":250,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many results to return (1 to 250).","title":"Limit"},"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["shop_language"],"title":"list_payment_methodsArguments","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_taxes":{"post":{"operationId":"list_taxes","summary":"List the shop's tax rates with title, rate and default flag. Use for \"Which tax rates are set up in my Lightspeed eCom s","description":"List the shop's tax rates with title, rate and default flag. Use for \"Which tax rates are set up in my Lightspeed eCom shop\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"shop_language":{"description":"Two-letter shop language code used in the API path, for example 'en' or 'nl'.","maxLength":5,"title":"Shop Language","type":"string"}},"required":["shop_language"],"title":"list_taxesArguments","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_countries":{"post":{"operationId":"list_countries","summary":"List the countries known to the shop with id, ISO 3166 codes and title. Use for \"Which countries does Lightspeed eCom li","description":"List the countries known to the shop with id, ISO 3166 codes and title. Use for \"Which countries does Lightspeed eCom list\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"shop_language":{"description":"Two-letter shop language code used in the API path, for example 'en' or 'nl'.","maxLength":5,"title":"Shop Language","type":"string"},"limit":{"anyOf":[{"maximum":250,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many results to return (1 to 250).","title":"Limit"},"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["shop_language"],"title":"list_countriesArguments","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_languages":{"post":{"operationId":"list_languages","summary":"List the shop's languages with code, locale, active and default flags. Use for \"Which languages are enabled in my Lights","description":"List the shop's languages with code, locale, active and default flags. Use for \"Which languages are enabled in my Lightspeed eCom shop\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"shop_language":{"description":"Two-letter shop language code used in the API path, for example 'en' or 'nl'.","maxLength":5,"title":"Shop Language","type":"string"},"limit":{"anyOf":[{"maximum":250,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many results to return (1 to 250).","title":"Limit"},"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["shop_language"],"title":"list_languagesArguments","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}}}}