{"openapi":"3.1.0","info":{"title":"Lightspeed X Store Setup (BYOK) API","version":"0.1.0","description":"Lightspeed X Store Setup (BYOK) lets an AI assistant read your own Lightspeed X Store Setup data through the Lightspeed X Store Setup API with a key you supply (Lightspeed Retail (X-Series) personal token). Read-only: 5 tools (get_store_settings, list_sales_channels, list_button_layouts, list_custom_fields, list_product_types). The BYOK key travels with each request, is used for that one call...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-lightspeed-x-store-config.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-lightspeed-x-store-config/docs"},"termsOfService":"https://connectorbay.com/byok-lightspeed-x-store-config/terms"},"servers":[{"url":"https://byok-lightspeed-x-store-config.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-lightspeed-x-store-config/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_settings":{"post":{"operationId":"get_store_settings","summary":"Get the retailer account settings: name, country, currency, time zone, tax mode, loyalty and gift card options and accou","description":"Get the retailer account settings: name, country, currency, time zone, tax mode, loyalty and gift card options and account status. Use for \"What are the settings of my Lightspeed Retail account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"domain_prefix":{"description":"Your Lightspeed Retail (X-Series) domain prefix: the part before .retail.lightspeed.app in your store address.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Domain Prefix","type":"string"}},"required":["domain_prefix"],"title":"get_store_settingsArguments","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_sales_channels":{"post":{"operationId":"list_sales_channels","summary":"List connected online sales channels (Shopify, WooCommerce, BigCommerce, Ecwid) with the register, payment type, outlets","description":"List connected online sales channels (Shopify, WooCommerce, BigCommerce, Ecwid) with the register, payment type, outlets and last import times. Use for \"Which online stores are connected to my Lightspeed Retail account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"domain_prefix":{"description":"Your Lightspeed Retail (X-Series) domain prefix: the part before .retail.lightspeed.app in your store address.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Domain Prefix","type":"string"}},"required":["domain_prefix"],"title":"list_sales_channelsArguments","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_button_layouts":{"post":{"operationId":"list_button_layouts","summary":"List register quick-key button layouts with their names and nodes. Needs a token with button_layouts:read. Use for \"What","description":"List register quick-key button layouts with their names and nodes. Needs a token with button_layouts:read. Use for \"What register button layouts does my Lightspeed Retail store have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"domain_prefix":{"description":"Your Lightspeed Retail (X-Series) domain prefix: the part before .retail.lightspeed.app in your store address.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Domain Prefix","type":"string"},"before":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only records with a version below this number (rarely needed).","title":"Before"},"deleted":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to include deleted records.","title":"Deleted"},"after":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Version cursor: pass version.max from the previous answer to get the next page; leave empty for the first page.","title":"After"},"page_size":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"Maximum number of records to return (1 to 1000).","title":"Page Size"}},"required":["domain_prefix"],"title":"list_button_layoutsArguments","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_custom_fields":{"post":{"operationId":"list_custom_fields","summary":"List custom field definitions for sales, line items, customers or products with name, title, value type and UI visibilit","description":"List custom field definitions for sales, line items, customers or products with name, title, value type and UI visibility. Use for \"What custom fields are defined in my Lightspeed Retail store\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"domain_prefix":{"description":"Your Lightspeed Retail (X-Series) domain prefix: the part before .retail.lightspeed.app in your store address.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Domain Prefix","type":"string"},"entity":{"anyOf":[{"enum":["sale","line_item","customer","product"],"type":"string"},{"type":"null"}],"default":null,"description":"Which records the fields belong to: sale, line_item, customer or product.","title":"Entity"}},"required":["domain_prefix"],"title":"list_custom_fieldsArguments","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_product_types":{"post":{"operationId":"list_product_types","summary":"List the older product type classification with each type's category path (superseded by product categories). Use for \"W","description":"List the older product type classification with each type's category path (superseded by product categories). Use for \"What product types does my Lightspeed Retail store use\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"domain_prefix":{"description":"Your Lightspeed Retail (X-Series) domain prefix: the part before .retail.lightspeed.app in your store address.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Domain Prefix","type":"string"},"before":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only records with a version below this number (rarely needed).","title":"Before"},"deleted":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to include deleted records.","title":"Deleted"},"after":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Version cursor: pass version.max from the previous answer to get the next page; leave empty for the first page.","title":"After"},"page_size":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"Maximum number of records to return (1 to 1000).","title":"Page Size"}},"required":["domain_prefix"],"title":"list_product_typesArguments","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}}}}