{"openapi":"3.1.0","info":{"title":"Lightspeed X Pricing (BYOK) API","version":"0.1.0","description":"Lightspeed X Pricing (BYOK) lets an AI assistant read your own Lightspeed X Pricing data through the Lightspeed X Pricing API with a key you supply (Lightspeed Retail (X-Series) personal token). Read-only: 7 tools (list_price_books, get_price_book, list_price_book_products, list_promotions, get_promotion, list_tags, list_variant_attributes). The BYOK key travels with each request, is used for...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-lightspeed-x-pricing.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-lightspeed-x-pricing/docs"},"termsOfService":"https://connectorbay.com/byok-lightspeed-x-pricing/terms"},"servers":[{"url":"https://byok-lightspeed-x-pricing.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-lightspeed-x-pricing/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_price_books":{"post":{"operationId":"list_price_books","summary":"List price books (customer-group or outlet specific price lists) with validity dates, outlets and linked customer groups","description":"List price books (customer-group or outlet specific price lists) with validity dates, outlets and linked customer groups. Needs a token with pricebooks:read. Use for \"Which price books exist 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"},"customer_group_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only price books linked to this customer group ID.","title":"Customer Group Id"},"direction":{"anyOf":[{"enum":["ASC","DESC"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction: ASC or DESC.","title":"Direction"},"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_price_booksArguments","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_price_book":{"post":{"operationId":"get_price_book","summary":"Get one price book with its type, validity dates, outlets and linked customer groups. Use for \"Show Lightspeed price boo","description":"Get one price book with its type, validity dates, outlets and linked customer groups. Use for \"Show Lightspeed price book pb1\".","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"},"id":{"description":"Price book ID (from list_price_books).","maxLength":60,"title":"Id","type":"string"}},"required":["domain_prefix","id"],"title":"get_price_bookArguments","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_price_book_products":{"post":{"operationId":"list_price_book_products","summary":"List product prices inside price books: price, discount, adjustment type, minimum and maximum units and tax.  Each recor","description":"List product prices inside price books: price, discount, adjustment type, minimum and maximum units and tax.  Each record names its price_book_id and product_id; pages by version cursor. Use for \"What products have special prices in Lightspeed price books\".","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"},"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_price_book_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/list_promotions":{"post":{"operationId":"list_promotions","summary":"List promotions with status, start and end time, outlets, promo code use and the discount action and condition. Needs a ","description":"List promotions with status, start and end time, outlets, promo code use and the discount action and condition. Needs a token with promotions:read. Use for \"Which promotions are running 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"},"end_time_from":{"anyOf":[{"maxLength":30,"type":"string"},{"type":"null"}],"default":null,"description":"Only promotions ending at or after this UTC time, for example 2026-09-01T00:00:00Z.","title":"End Time From"},"end_time_to":{"anyOf":[{"maxLength":30,"type":"string"},{"type":"null"}],"default":null,"description":"Only promotions ending at or before this UTC time.","title":"End Time To"},"page_size":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"Maximum number of promotions to return (1 to 1000).","title":"Page Size"}},"required":["domain_prefix"],"title":"list_promotionsArguments","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_promotion":{"post":{"operationId":"get_promotion","summary":"Get one promotion with its status, dates, outlets, discount action and condition. Use for \"Show Lightspeed promotion 12\"","description":"Get one promotion with its status, dates, outlets, discount action and condition. Use for \"Show Lightspeed promotion 12\".","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"},"promotion_id":{"description":"Promotion ID (from list_promotions).","title":"Promotion Id","type":"integer"}},"required":["domain_prefix","promotion_id"],"title":"get_promotionArguments","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_tags":{"post":{"operationId":"list_tags","summary":"List product tags used to label products. Use for \"What product tags are defined in my Lightspeed Retail store\".","description":"List product tags used to label products. Use for \"What product tags 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"},"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_tagsArguments","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_variant_attributes":{"post":{"operationId":"list_variant_attributes","summary":"List variant attributes (such as Size or Colour) used to build product variants. Use for \"What variant attributes are se","description":"List variant attributes (such as Size or Colour) used to build product variants. Use for \"What variant attributes are set up 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"},"deleted":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to include deleted records.","title":"Deleted"}},"required":["domain_prefix"],"title":"list_variant_attributesArguments","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}}}}