{"openapi":"3.1.0","info":{"title":"ShipStation Carrier Services, Packages and Stores (your keys) API","version":"0.1.0","description":"ShipStation Carrier Services, Packages and Stores (your keys) lets an AI assistant read your own ShipStation Setup data through the ShipStation Setup API with a key you supply (API Key (ShipStation V1 API)). Read-only: 6 tools (list_carrier_services, list_carrier_packages, get_carrier, list_marketplaces, list_tags, get_store). The BYOK key travels with each request, is used for that one call only...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-shipstation-setup.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-shipstation-setup/docs"},"termsOfService":"https://connectorbay.com/byok-shipstation-setup/terms"},"servers":[{"url":"https://byok-shipstation-setup.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-shipstation-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_carrier_services":{"post":{"operationId":"list_carrier_services","summary":"List the shipping services a connected carrier offers with service code, name and whether each is domestic and internati","description":"List the shipping services a connected carrier offers with service code, name and whether each is domestic and international. Use for \"Which services can I use with my Stamps.com carrier in ShipStation\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"carrier_code":{"description":"Carrier code from list_carriers, for example stamps_com or ups.","maxLength":60,"title":"Carrier Code","type":"string"}},"required":["carrier_code"],"title":"list_carrier_servicesArguments","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_carrier_packages":{"post":{"operationId":"list_carrier_packages","summary":"List the package types a connected carrier supports with package code, name and whether each is domestic and internation","description":"List the package types a connected carrier supports with package code, name and whether each is domestic and international. Use for \"Which package types does my UPS account support in ShipStation\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"carrier_code":{"description":"Carrier code from list_carriers, for example stamps_com or ups.","maxLength":60,"title":"Carrier Code","type":"string"}},"required":["carrier_code"],"title":"list_carrier_packagesArguments","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_carrier":{"post":{"operationId":"get_carrier","summary":"Get one connected carrier account by code: name, whether it needs a funded account, balance, nickname and whether it is ","description":"Get one connected carrier account by code: name, whether it needs a funded account, balance, nickname and whether it is the primary carrier (account number is left out). Use for \"What is the balance of my Stamps.com carrier account in ShipStation\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"carrier_code":{"description":"Carrier code from list_carriers, for example stamps_com or ups.","maxLength":60,"title":"Carrier Code","type":"string"}},"required":["carrier_code"],"title":"get_carrierArguments","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_marketplaces":{"post":{"operationId":"list_marketplaces","summary":"List the marketplace and shopping cart types ShipStation can connect to, with marketplace id and whether each supports r","description":"List the marketplace and shopping cart types ShipStation can connect to, with marketplace id and whether each supports refresh, custom mappings, custom statuses and shipment confirmation. Use for \"Which marketplaces can ShipStation connect to\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_marketplacesArguments","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_tags":{"post":{"operationId":"list_tags","summary":"List the order tags defined on the account with tag id, name and color. Use for \"Which order tags exist in my ShipStatio","description":"List the order tags defined on the account with tag id, name and color. Use for \"Which order tags exist in my ShipStation account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_tagsArguments","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_store":{"post":{"operationId":"get_store","summary":"Get one connected store by id: name, marketplace, active flag, creation and modification dates and auto-refresh setting ","description":"Get one connected store by id: name, marketplace, active flag, creation and modification dates and auto-refresh setting (contact details are left out). Use for \"Show ShipStation store 12345\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"store_id":{"description":"Numeric store id from list_stores.","minimum":1,"title":"Store Id","type":"integer"}},"required":["store_id"],"title":"get_storeArguments","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}}}}