{"openapi":"3.1.0","info":{"title":"Shipmondo (BYOK) API","version":"0.1.0","description":"Shipmondo (BYOK) lets an AI assistant read your own Shipmondo data through the Shipmondo API with a key you supply (Shipmondo API user). Read-only: 10 tools (get_account, get_account_balance, list_carriers, list_products, list_package_types, list_items, list_payment_gateways, list_return_portals, list_shipment_templates, list_printers). The BYOK key travels with each request, is used for that one...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-shipmondo.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-shipmondo/docs"},"termsOfService":"https://connectorbay.com/byok-shipmondo/terms"},"servers":[{"url":"https://byok-shipmondo.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-shipmondo/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_account":{"post":{"operationId":"get_account","summary":"Show the Shipmondo account company profile: company name, city, country, VAT number, home page and last update. Contact ","description":"Show the Shipmondo account company profile: company name, city, country, VAT number, home page and last update. Contact person, phone and email are left out. Use for \"Which company is my Shipmondo account registered to\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_accountArguments","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_account_balance":{"post":{"operationId":"get_account_balance","summary":"Show the current prepaid balance of the Shipmondo account with currency and time of last update. Use for \"How much balan","description":"Show the current prepaid balance of the Shipmondo account with currency and time of last update. Use for \"How much balance is left on my Shipmondo account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_account_balanceArguments","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_carriers":{"post":{"operationId":"list_carriers","summary":"List the carriers available to the account for a receiver country (and optionally a sender country) with id, code and na","description":"List the carriers available to the account for a receiver country (and optionally a sender country) with id, code and name. Use for \"Which carriers can I ship with from Shipmondo to Denmark\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"receiver_country_code":{"description":"Two letter receiver country code, for example DK.","maxLength":2,"title":"Receiver Country Code","type":"string"},"sender_country_code":{"anyOf":[{"maxLength":2,"type":"string"},{"type":"null"}],"default":null,"description":"Two letter sender country code, for example DK.","title":"Sender Country Code"}},"required":["receiver_country_code"],"title":"list_carriersArguments","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 the shipping products (services of a carrier) with code, name, transit time, required and optional fields, service ","description":"List the shipping products (services of a carrier) with code, name, transit time, required and optional fields, service point flags and countries. Filter by carrier and countries. Use for \"Which Shipmondo shipping products does GLS offer from DK to DK\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"carrier_code":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Carrier code, for example gls.","title":"Carrier Code"},"sender_country_code":{"anyOf":[{"maxLength":2,"type":"string"},{"type":"null"}],"default":null,"description":"Two letter sender country code.","title":"Sender Country Code"},"receiver_country_code":{"anyOf":[{"maxLength":2,"type":"string"},{"type":"null"}],"default":null,"description":"Two letter receiver country code.","title":"Receiver Country Code"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Records per page (1 to 50).","title":"Per 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/list_package_types":{"post":{"operationId":"list_package_types","summary":"List the package types (for example pallets) allowed for a product code and country pair. Use for \"Which package types d","description":"List the package types (for example pallets) allowed for a product code and country pair. Use for \"Which package types does Shipmondo allow for product GLSDK_SD\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"product_code":{"description":"Shipping product code from list_products.","maxLength":60,"title":"Product Code","type":"string"},"sender_country_code":{"description":"Two letter sender country code.","maxLength":2,"title":"Sender Country Code","type":"string"},"receiver_country_code":{"description":"Two letter receiver country code.","maxLength":2,"title":"Receiver Country Code","type":"string"}},"required":["product_code","sender_country_code","receiver_country_code"],"title":"list_package_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}},"/v1/tools/list_items":{"post":{"operationId":"list_items","summary":"List the warehouse items (SKU catalog) with name, variant, barcode, bin location, weight, customs description and commod","description":"List the warehouse items (SKU catalog) with name, variant, barcode, bin location, weight, customs description and commodity code. Optional filters by SKU, name or barcode. Use for \"Which items are in my Shipmondo item catalog\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"sku":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Filter by exact SKU.","title":"Sku"},"name":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Filter by item name.","title":"Name"},"barcode":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Filter by barcode.","title":"Barcode"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Records per page (1 to 50).","title":"Per Page"}},"title":"list_itemsArguments","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_gateways":{"post":{"operationId":"list_payment_gateways","summary":"List the payment gateways connected to the account with id, name and provider. Merchant numbers are left out. Use for \"W","description":"List the payment gateways connected to the account with id, name and provider. Merchant numbers are left out. Use for \"Which payment gateways are set up in Shipmondo\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Records per page (1 to 50).","title":"Per Page"}},"title":"list_payment_gatewaysArguments","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_return_portals":{"post":{"operationId":"list_return_portals","summary":"List the customer return portals with id, portal name, carrier code and active flag. Use for \"Which return portals do I ","description":"List the customer return portals with id, portal name, carrier code and active flag. Use for \"Which return portals do I have in Shipmondo\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"Only active (true) or inactive (false) portals.","title":"Active"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Records per page (1 to 50).","title":"Per Page"}},"title":"list_return_portalsArguments","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_shipment_templates":{"post":{"operationId":"list_shipment_templates","summary":"List saved shipment templates with name, default flag, product code, own agreement flag and service codes. Sender and re","description":"List saved shipment templates with name, default flag, product code, own agreement flag and service codes. Sender and receiver details and customer numbers are left out. Use for \"Which shipment templates are saved in Shipmondo\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Records per page (1 to 50).","title":"Per Page"}},"title":"list_shipment_templatesArguments","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_printers":{"post":{"operationId":"list_printers","summary":"List the label and document printers registered in the account with name, label format and default flags. Use for \"Which","description":"List the label and document printers registered in the account with name, label format and default flags. Use for \"Which printers are registered in Shipmondo\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_printersArguments","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}}}}