{"openapi":"3.1.0","info":{"title":"Sendcloud Shipping Methods and Contracts (your keys) API","version":"0.1.0","description":"Sendcloud Shipping Methods and Contracts (your keys) lets an AI assistant read your own Sendcloud Setup data through the Sendcloud Setup API with a key you supply (public API key). Read-only: 5 tools (list_shipping_methods, get_shipping_method, list_shipping_products, list_contracts, get_contract). The BYOK key travels with each request, is used for that one call only and is never stored, logged...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-sendcloud-setup.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-sendcloud-setup/docs"},"termsOfService":"https://connectorbay.com/byok-sendcloud-setup/terms"},"servers":[{"url":"https://byok-sendcloud-setup.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-sendcloud-setup/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_shipping_methods":{"post":{"operationId":"list_shipping_methods","summary":"List the shipping methods the account can use with carrier, weight range, price and per-country price and lead time; fil","description":"List the shipping methods the account can use with carrier, weight range, price and per-country price and lead time; filter by sender address, return use, route postal codes and country. Use for \"Which Sendcloud shipping methods can I use to ship to the Netherlands\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"sender_address":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":null,"description":"Only methods valid for this sender address id.","title":"Sender Address"},"is_return":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to list methods usable for return labels.","title":"Is Return"},"from_postal_code":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":null,"description":"Sender postal code (needed to price zonal carriers).","title":"From Postal Code"},"to_postal_code":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":null,"description":"Recipient postal code (needed to price zonal carriers). A postal code only, no street address.","title":"To Postal Code"},"to_country":{"anyOf":[{"maxLength":2,"type":"string"},{"type":"null"}],"default":null,"description":"Recipient country as a two-letter ISO code, for example NL (needed to price zonal carriers).","title":"To Country"},"limit":{"anyOf":[{"maximum":500,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Page size; if left out every method is returned.","title":"Limit"},"cursor":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Cursor from the previous answer's next link, for the following page.","title":"Cursor"}},"title":"list_shipping_methodsArguments","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_shipping_method":{"post":{"operationId":"get_shipping_method","summary":"Get one shipping method by id with carrier, weight range, price and per-country price and lead time. Use for \"Show Sendc","description":"Get one shipping method by id with carrier, weight range, price and per-country price and lead time. Use for \"Show Sendcloud shipping method 8\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"method_id":{"description":"Numeric shipping method id from list_shipping_methods.","minimum":1,"title":"Method Id","type":"integer"},"from_postal_code":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":null,"description":"Sender postal code (needed to price zonal carriers).","title":"From Postal Code"},"to_postal_code":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":null,"description":"Recipient postal code (needed to price zonal carriers). A postal code only, no street address.","title":"To Postal Code"},"to_country":{"anyOf":[{"maxLength":2,"type":"string"},{"type":"null"}],"default":null,"description":"Recipient country as a two-letter ISO code, for example NL (needed to price zonal carriers).","title":"To Country"},"is_return":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to check the method for returns.","title":"Is Return"}},"required":["method_id"],"title":"get_shipping_methodArguments","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_shipping_products":{"post":{"operationId":"list_shipping_products","summary":"List carrier shipping products for a route (from country is required) with carrier, code, weight range and the methods w","description":"List carrier shipping products for a route (from country is required) with carrier, code, weight range and the methods with their functionalities (B2B/B2C, cash on delivery, insurance and similar). Use for \"Which Sendcloud shipping products go from NL to DE for a 2 kg parcel\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"from_country":{"description":"Sender country as a two-letter ISO code, for example NL.","maxLength":2,"title":"From Country","type":"string"},"to_country":{"anyOf":[{"maxLength":2,"type":"string"},{"type":"null"}],"default":null,"description":"Recipient country as a two-letter ISO code, for example NL (needed to price zonal carriers).","title":"To Country"},"carrier":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only this carrier code, for example postnl.","title":"Carrier"},"contract":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only products usable with this contract id.","title":"Contract"},"weight":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Parcel weight in weight_unit, to keep only products that accept it.","title":"Weight"},"weight_unit":{"anyOf":[{"enum":["gram","kilogram"],"type":"string"},{"type":"null"}],"default":null,"description":"Unit for weight: gram or kilogram (needed when weight is set).","title":"Weight Unit"},"returns":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to list products for return shipments.","title":"Returns"},"from_postal_code":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":null,"description":"Sender postal code (needed to price zonal carriers).","title":"From Postal Code"},"to_postal_code":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":null,"description":"Recipient postal code (needed to price zonal carriers). A postal code only, no street address.","title":"To Postal Code"}},"required":["from_country"],"title":"list_shipping_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_contracts":{"post":{"operationId":"list_contracts","summary":"List the carrier contracts connected to the account with carrier, name, country, active and default flags; filter by car","description":"List the carrier contracts connected to the account with carrier, name, country, active and default flags; filter by carrier, active state, name or country. Use for \"Which carrier contracts do I have in Sendcloud\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"carrier":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only contracts of this carrier code, for example postnl.","title":"Carrier"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for active contracts, false for inactive.","title":"Is Active"},"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only contracts with this name.","title":"Name"},"country":{"anyOf":[{"maxLength":2,"type":"string"},{"type":"null"}],"default":null,"description":"Only contracts for this country (two-letter ISO code).","title":"Country"}},"title":"list_contractsArguments","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_contract":{"post":{"operationId":"get_contract","summary":"Get one carrier contract by id with carrier, name, country and flags. Use for \"Show Sendcloud contract 4\".","description":"Get one carrier contract by id with carrier, name, country and flags. Use for \"Show Sendcloud contract 4\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"contract_id":{"description":"Numeric contract id from list_contracts.","minimum":1,"title":"Contract Id","type":"integer"}},"required":["contract_id"],"title":"get_contractArguments","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}}}}