{"openapi":"3.1.0","info":{"title":"Sendcloud v3 Contracts and Shipping Options (your keys) API","version":"0.1.0","description":"Sendcloud v3 Contracts and Shipping Options (your keys) lets an AI assistant read your own Sendcloud V3 Setup data through the Sendcloud V3 Setup API with a key you supply (public API key). Read-only: 5 tools (get_organization, list_contracts, get_contract, list_contract_schemas, list_shipping_options). The BYOK key travels with each request, is used for that one call only and is never stored,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-sendcloud-v3-setup.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-sendcloud-v3-setup/docs"},"termsOfService":"https://connectorbay.com/byok-sendcloud-v3-setup/terms"},"servers":[{"url":"https://byok-sendcloud-v3-setup.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-sendcloud-v3-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/get_organization":{"post":{"operationId":"get_organization","summary":"Get the Sendcloud organization the keys belong to: id, name and registration date. Use for \"Which Sendcloud organization","description":"Get the Sendcloud organization the keys belong to: id, name and registration date. Use for \"Which Sendcloud organization am I connected to\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_organizationArguments","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 on the account (carrier, contract name, country, state, type and any error) with optional fil","description":"List the carrier contracts on the account (carrier, contract name, country, state, type and any error) with optional filters. Use for \"Which carrier contracts do I have in Sendcloud\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"carrier_code":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only contracts of this carrier code, for example postnl.","title":"Carrier Code"},"country_code":{"anyOf":[{"maxLength":2,"type":"string"},{"type":"null"}],"default":null,"description":"Only contracts for this two-letter country code.","title":"Country Code"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for active contracts only, false for inactive.","title":"Is Active"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"How many contracts per page (1 to 100).","title":"Page Size"}},"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. Use for \"Show Sendcloud contract 4\".","description":"Get one carrier contract by id. 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}},"/v1/tools/list_contract_schemas":{"post":{"operationId":"list_contract_schemas","summary":"List the fields each carrier requires to set up a contract (name, description, whether required, type and allowed choice","description":"List the fields each carrier requires to set up a contract (name, description, whether required, type and allowed choices); optionally for one carrier. Use for \"Which fields does Sendcloud need to add a PostNL contract\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"carrier_code":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only the schema of this carrier code, for example postnl.","title":"Carrier Code"}},"title":"list_contract_schemasArguments","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_options":{"post":{"operationId":"list_shipping_options","summary":"List the shipping options (carrier, product, contract and charging type) Sendcloud offers for a route between two countr","description":"List the shipping options (carrier, product, contract and charging type) Sendcloud offers for a route between two countries. Use for \"Which Sendcloud shipping options exist from NL to DE\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"from_country_code":{"description":"Sender country as a two-letter ISO code, for example NL.","maxLength":2,"title":"From Country Code","type":"string"},"to_country_code":{"description":"Recipient country as a two-letter ISO code, for example DE.","maxLength":2,"title":"To Country Code","type":"string"},"carrier_code":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only options of this carrier code, for example postnl; leave out for all carriers.","title":"Carrier Code"}},"required":["from_country_code","to_country_code"],"title":"list_shipping_optionsArguments","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}}}}