{"openapi":"3.1.0","info":{"title":"Veeqo (BYOK) API","version":"0.1.0","description":"Veeqo (BYOK) lets an AI assistant read your own Veeqo data through the Veeqo API with a key you supply (Veeqo API key). Read-only: 12 tools (list_orders, get_order, list_products, get_product, get_stock_entry, list_customers, get_customer, list_purchase_orders, list_suppliers, list_warehouses, list_stores, get_tracking_events). 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-veeqo.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-veeqo/docs"},"termsOfService":"https://connectorbay.com/byok-veeqo/terms"},"servers":[{"url":"https://byok-veeqo.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-veeqo/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_orders":{"post":{"operationId":"list_orders","summary":"List orders newest first with status, totals, line items, delivery address and dates; filter by status, tag, date range ","description":"List orders newest first with status, totals, line items, delivery address and dates; filter by status, tag, date range or free text. Use for \"Which orders are waiting to be fulfilled right now\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"status":{"anyOf":[{"enum":["awaiting_payment","awaiting_stock","awaiting_fulfillment","shipped","on_hold","cancelled","refunded"],"type":"string"},{"type":"null"}],"default":null,"description":"Order status.","title":"Status"},"query":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Free-text search across orders (for example order number or customer name).","title":"Query"},"tags":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only orders with a tag of exactly this name.","title":"Tags"},"created_after":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Only orders created on or after this date (YYYY-MM-DD).","title":"Created After"},"created_before":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Only orders created on or before this date (YYYY-MM-DD; the whole day counts).","title":"Created Before"},"due_after":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Only orders due on or after this date (YYYY-MM-DD).","title":"Due After"},"due_before":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Only orders due on or before this date (YYYY-MM-DD).","title":"Due Before"},"allocated_at":{"anyOf":[{"maximum":2000000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only orders allocated at this warehouse ID.","title":"Allocated At"},"since_id":{"anyOf":[{"maximum":2000000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only records with an ID greater than this.","title":"Since Id"},"created_at_min":{"anyOf":[{"maxLength":19,"type":"string"},{"type":"null"}],"default":null,"description":"Only records created after this time, formatted YYYY-MM-DD HH:MM:SS.","title":"Created At Min"},"updated_at_min":{"anyOf":[{"maxLength":19,"type":"string"},{"type":"null"}],"default":null,"description":"Only records updated after this time, formatted YYYY-MM-DD HH:MM:SS.","title":"Updated At Min"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":12,"description":"Results per page (1 to 100).","title":"Page Size"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"list_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/get_order":{"post":{"operationId":"get_order","summary":"Get one order by ID with status, totals, line items, delivery address, allocations and returns. Use for \"What is in orde","description":"Get one order by ID with status, totals, line items, delivery address, allocations and returns. Use for \"What is in order 4455667 and where is it going\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"order_id":{"description":"Order ID from list_orders.","maximum":2000000000,"minimum":0,"title":"Order Id","type":"integer"}},"required":["order_id"],"title":"get_orderArguments","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_products":{"post":{"operationId":"list_products","summary":"List products with title, total and available stock, units sold and variants (sellables with SKU and price); filter by w","description":"List products with title, total and available stock, units sold and variants (sellables with SKU and price); filter by warehouse, date or text. Use for \"Which products are low on stock\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Search by product name or SKU code.","title":"Query"},"warehouse_id":{"anyOf":[{"maximum":2000000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only products with stock in this warehouse ID.","title":"Warehouse Id"},"since_id":{"anyOf":[{"maximum":2000000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only records with an ID greater than this.","title":"Since Id"},"created_at_min":{"anyOf":[{"maxLength":19,"type":"string"},{"type":"null"}],"default":null,"description":"Only records created after this time, formatted YYYY-MM-DD HH:MM:SS.","title":"Created At Min"},"updated_at_min":{"anyOf":[{"maxLength":19,"type":"string"},{"type":"null"}],"default":null,"description":"Only records updated after this time, formatted YYYY-MM-DD HH:MM:SS.","title":"Updated At Min"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":12,"description":"Results per page (1 to 100).","title":"Page Size"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"list_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/get_product":{"post":{"operationId":"get_product","summary":"Get one product by ID with description, stock totals and all its variants (sellables). Use for \"What variants and prices","description":"Get one product by ID with description, stock totals and all its variants (sellables). Use for \"What variants and prices does product 99887 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"product_id":{"description":"Product ID from list_products.","maximum":2000000000,"minimum":0,"title":"Product Id","type":"integer"}},"required":["product_id"],"title":"get_productArguments","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_stock_entry":{"post":{"operationId":"get_stock_entry","summary":"Get the stock of one variant (sellable) in one warehouse: physical, available, allocated and incoming quantities. Use fo","description":"Get the stock of one variant (sellable) in one warehouse: physical, available, allocated and incoming quantities. Use for \"How many units of this variant are available in the main warehouse\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"sellable_id":{"description":"Variant (sellable) ID, found in a product's sellables.","maximum":2000000000,"minimum":0,"title":"Sellable Id","type":"integer"},"warehouse_id":{"description":"Warehouse ID from list_warehouses.","maximum":2000000000,"minimum":0,"title":"Warehouse Id","type":"integer"}},"required":["sellable_id","warehouse_id"],"title":"get_stock_entryArguments","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_customers":{"post":{"operationId":"list_customers","summary":"List customers with contact details and addresses; filter by type or free text such as an email address. Use for \"Find t","description":"List customers with contact details and addresses; filter by type or free text such as an email address. Use for \"Find the customer with email joebloggs@example.com\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Free-text search, for example an email address or name.","title":"Query"},"customer_type":{"anyOf":[{"enum":["retail","business"],"type":"string"},{"type":"null"}],"default":null,"description":"Customer type.","title":"Customer Type"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":12,"description":"Results per page (1 to 100).","title":"Page Size"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"list_customersArguments","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_customer":{"post":{"operationId":"get_customer","summary":"Get one customer by ID with type, contact details, billing address and shipping addresses. Use for \"What addresses does ","description":"Get one customer by ID with type, contact details, billing address and shipping addresses. Use for \"What addresses does customer 7788 have on file\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"customer_id":{"description":"Customer ID from list_customers.","maximum":2000000000,"minimum":0,"title":"Customer Id","type":"integer"}},"required":["customer_id"],"title":"get_customerArguments","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_purchase_orders":{"post":{"operationId":"list_purchase_orders","summary":"List purchase orders with state, supplier, warehouse, units ordered and received, totals and line items (paid Veeqo plan","description":"List purchase orders with state, supplier, warehouse, units ordered and received, totals and line items (paid Veeqo plans only). Use for \"Which purchase orders are overdue or partially received\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"state":{"anyOf":[{"enum":["draft","active","completed","not_received","partially_received","fully_received","past_due","all"],"type":"string"},{"type":"null"}],"default":null,"description":"State or received-status filter.","title":"State"},"query":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Free-text search across supplier name, order number, reference and line-item SKU.","title":"Query"},"supplier_id":{"anyOf":[{"maximum":2000000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only purchase orders of this supplier ID.","title":"Supplier Id"},"destination_warehouse_id":{"anyOf":[{"maximum":2000000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only purchase orders delivering to this warehouse ID.","title":"Destination Warehouse Id"},"created_after":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Only orders created on or after this date (YYYY-MM-DD).","title":"Created After"},"created_before":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Only orders created on or before this date (YYYY-MM-DD).","title":"Created Before"},"sort_by":{"anyOf":[{"enum":["supplier_name","created_at","expected_date","estimated_delivery_days","sort_by_received_percent"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort field: supplier_name, created_at, expected_date, estimated_delivery_days or sort_by_received_percent.","title":"Sort By"},"order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction.","title":"Order"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"Results per page (1 to 100).","title":"Page Size"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"list_purchase_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_suppliers":{"post":{"operationId":"list_suppliers","summary":"List suppliers with contact names, currency and counts of active and completed purchase orders (paid Veeqo plans only). ","description":"List suppliers with contact names, currency and counts of active and completed purchase orders (paid Veeqo plans only). Use for \"Which suppliers do I have and how many open purchase orders does each have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":12,"description":"Results per page (1 to 100).","title":"Page Size"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"list_suppliersArguments","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_warehouses":{"post":{"operationId":"list_warehouses","summary":"List warehouses with name, address and phone; use the IDs in stock and order filters. Use for \"What warehouses does my V","description":"List warehouses with name, address and phone; use the IDs in stock and order filters. Use for \"What warehouses does my Veeqo account have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"external_id":{"anyOf":[{"maxLength":80,"type":"string"},{"type":"null"}],"default":null,"description":"Only warehouses with this external ID.","title":"External Id"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"Results per page (1 to 100).","title":"Page Size"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"list_warehousesArguments","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_stores":{"post":{"operationId":"list_stores","summary":"List the sales channels (stores) connected to Veeqo with name, type, currency, state and country. Use for \"Which sales c","description":"List the sales channels (stores) connected to Veeqo with name, type, currency, state and country. Use for \"Which sales channels are connected to my Veeqo account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":12,"description":"Results per page (1 to 100).","title":"Page Size"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"list_storesArguments","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_tracking_events":{"post":{"operationId":"get_tracking_events","summary":"Get the tracking events (status, description, location, time) of a shipment whose label was bought in Veeqo. Use for \"Wh","description":"Get the tracking events (status, description, location, time) of a shipment whose label was bought in Veeqo. Use for \"Where is the parcel of shipment 3344556 right now\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"shipment_id":{"description":"Shipment ID, found in an order's allocations.","maximum":2000000000,"minimum":0,"title":"Shipment Id","type":"integer"}},"required":["shipment_id"],"title":"get_tracking_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}}}}