{"openapi":"3.1.0","info":{"title":"Logicbroker (BYOK) API","version":"0.1.0","description":"Logicbroker (BYOK) lets an AI assistant read your own Logicbroker data through the Logicbroker API with a key you supply (Logicbroker API subscription key (production portal)). Read-only: 11 tools (list_ready_orders, list_ready_acknowledgements, list_ready_shipments, list_ready_invoices, search_shipments, search_documents, list_activity_events, get_sku_availability, list_webhooks, list_messages,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-logicbroker.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-logicbroker/docs"},"termsOfService":"https://connectorbay.com/byok-logicbroker/terms"},"servers":[{"url":"https://byok-logicbroker.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-logicbroker/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_ready_orders":{"post":{"operationId":"list_ready_orders","summary":"List orders waiting to be processed (status Submitted by default) with order number, partner PO, dates, total, status an","description":"List orders waiting to be processed (status Submitted by default) with order number, partner PO, dates, total, status and lines. Customer names and addresses are left out of the answer. Use for \"Which new drop-ship orders are waiting in Logicbroker\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"sender_company_id":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only documents sent by this partner company ID; leave empty to get documents from all your partners.","title":"Sender Company Id"},"receiver_company_id":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only documents addressed to this company ID; leave empty to default to your own company.","title":"Receiver Company Id"}},"title":"list_ready_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/list_ready_acknowledgements":{"post":{"operationId":"list_ready_acknowledgements","summary":"List order acknowledgements waiting to be processed, with dates, ship dates and lines. Customer names and addresses are ","description":"List order acknowledgements waiting to be processed, with dates, ship dates and lines. Customer names and addresses are left out of the answer. Use for \"Which supplier acknowledgements are waiting in Logicbroker\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"sender_company_id":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only documents sent by this partner company ID; leave empty to get documents from all your partners.","title":"Sender Company Id"},"receiver_company_id":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only documents addressed to this company ID; leave empty to default to your own company.","title":"Receiver Company Id"}},"title":"list_ready_acknowledgementsArguments","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_ready_shipments":{"post":{"operationId":"list_ready_shipments","summary":"List shipments waiting to be processed, with shipment number, ship date, order references, tracking info and lines. Cust","description":"List shipments waiting to be processed, with shipment number, ship date, order references, tracking info and lines. Customer names and addresses are left out of the answer. Use for \"Which new shipments are waiting in Logicbroker\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"sender_company_id":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only documents sent by this partner company ID; leave empty to get documents from all your partners.","title":"Sender Company Id"},"receiver_company_id":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only documents addressed to this company ID; leave empty to default to your own company.","title":"Receiver Company Id"}},"title":"list_ready_shipmentsArguments","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_ready_invoices":{"post":{"operationId":"list_ready_invoices","summary":"List invoices waiting to be processed, with invoice number, date, totals and lines. Customer names and addresses are lef","description":"List invoices waiting to be processed, with invoice number, date, totals and lines. Customer names and addresses are left out of the answer. Use for \"Which invoices are waiting in Logicbroker\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"sender_company_id":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only documents sent by this partner company ID; leave empty to get documents from all your partners.","title":"Sender Company Id"},"receiver_company_id":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only documents addressed to this company ID; leave empty to default to your own company.","title":"Receiver Company Id"}},"title":"list_ready_invoicesArguments","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/search_shipments":{"post":{"operationId":"search_shipments","summary":"Search shipments by status code (for example routing requests), without addresses. Use for \"Which Logicbroker shipments ","description":"Search shipments by status code (for example routing requests), without addresses. Use for \"Which Logicbroker shipments are in status 420\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"status":{"anyOf":[{"maximum":5000,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Document status code, for example 100 submitted, 1200 failed.","title":"Status"},"sender_company_id":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only documents sent by this partner company ID; leave empty to get documents from all your partners.","title":"Sender Company Id"},"receiver_company_id":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only documents addressed to this company ID; leave empty to default to your own company.","title":"Receiver Company Id"}},"title":"search_shipmentsArguments","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/search_documents":{"post":{"operationId":"search_documents","summary":"Search documents of any type (orders, acknowledgements, shipments, invoices, returns) by status, for example 1200 for fa","description":"Search documents of any type (orders, acknowledgements, shipments, invoices, returns) by status, for example 1200 for failed ones. Use for \"Which Logicbroker documents have failed\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"status":{"anyOf":[{"maximum":5000,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Document status code, for example 100 submitted, 1200 failed.","title":"Status"}},"title":"search_documentsArguments","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_activity_events":{"post":{"operationId":"list_activity_events","summary":"List activity events (status changes and errors) for a document, filtered by processed flag and level. Use for \"What err","description":"List activity events (status changes and errors) for a document, filtered by processed flag and level. Use for \"What errors happened for this Logicbroker document\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"logicbroker_key":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"The document's LogicbrokerKey.","title":"Logicbroker Key"},"processed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for events already marked processed, false for the unprocessed ones.","title":"Processed"},"level":{"anyOf":[{"enum":["Alert","Info"],"type":"string"},{"type":"null"}],"default":null,"description":"Event level: Alert for errors, Info for information.","title":"Level"}},"title":"list_activity_eventsArguments","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_sku_availability":{"post":{"operationId":"get_sku_availability","summary":"Get a merchant SKU's availability across all suppliers: supplier, quantity, cost and last update. Use for \"Which supplie","description":"Get a merchant SKU's availability across all suppliers: supplier, quantity, cost and last update. Use for \"Which suppliers have SKU V-123 in stock via Logicbroker\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"sku":{"description":"Merchant SKU shared across your suppliers.","maxLength":200,"title":"Sku","type":"string"}},"required":["sku"],"title":"get_sku_availabilityArguments","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_webhooks":{"post":{"operationId":"list_webhooks","summary":"List the webhooks set up on the account: topic, format and whether enabled (endpoint address and shared secret are left ","description":"List the webhooks set up on the account: topic, format and whether enabled (endpoint address and shared secret are left out). Use for \"Which webhooks do I have in Logicbroker\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_webhooksArguments","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_messages":{"post":{"operationId":"list_messages","summary":"List messages (notifications and document alerts) for the account, with sender, subject, date and acknowledgement status","description":"List messages (notifications and document alerts) for the account, with sender, subject, date and acknowledgement status. Use for \"What messages are waiting in Logicbroker\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Page number, starting at 0.","title":"Page"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many messages per page.","title":"Page Size"}},"title":"list_messagesArguments","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_scheduled_tasks":{"post":{"operationId":"list_scheduled_tasks","summary":"List scheduled tasks (import and export jobs) with partner, last run times and schedule. Use for \"When did Logicbroker's","description":"List scheduled tasks (import and export jobs) with partner, last run times and schedule. Use for \"When did Logicbroker's scheduled jobs last run\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_scheduled_tasksArguments","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}}}}