{"openapi":"3.1.0","info":{"title":"Shippo Tracking and Parcel Catalog (your token) API","version":"0.1.0","description":"Shippo Tracking and Parcel Catalog (your token) lets an AI assistant read your own Shippo Reference data through the Shippo Reference API with a key you supply (API token (live or test)). Read-only: 6 tools (get_tracking_status, list_carrier_parcel_templates, get_carrier_parcel_template, list_user_parcel_templates, list_service_groups, list_parcels). The BYOK key travels with each request, is...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-shippo-reference.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-shippo-reference/docs"},"termsOfService":"https://connectorbay.com/byok-shippo-reference/terms"},"servers":[{"url":"https://byok-shippo-reference.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-shippo-reference/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_tracking_status":{"post":{"operationId":"get_tracking_status","summary":"Get the tracking status of a package by carrier token and tracking number: current status and substatus, estimated deliv","description":"Get the tracking status of a package by carrier token and tracking number: current status and substatus, estimated delivery, service level and the history of scans (city level locations only). Use for \"Where is my USPS package 9205590164917312751089\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"carrier":{"description":"Carrier token such as 'usps', 'ups', 'fedex', 'dhl_express' or 'dhl_ecommerce' (see Shippo's tracking carriers list).","maxLength":60,"title":"Carrier","type":"string"},"tracking_number":{"description":"The carrier's tracking number.","maxLength":100,"title":"Tracking Number","type":"string"}},"required":["carrier","tracking_number"],"title":"get_tracking_statusArguments","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_parcel_templates":{"post":{"operationId":"list_carrier_parcel_templates","summary":"List the carriers' standard parcel templates (flat rate boxes, envelopes) with dimensions, optionally for one carrier or","description":"List the carriers' standard parcel templates (flat rate boxes, envelopes) with dimensions, optionally for one carrier or only carriers you enabled. Use for \"Which parcel templates does USPS offer\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"include":{"anyOf":[{"enum":["all","user","enabled"],"type":"string"},{"type":"null"}],"default":"all","description":"all carriers (default), user (carriers you added) or enabled (carriers you added and enabled).","title":"Include"},"carrier":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only this carrier token, for example 'usps' or 'fedex'.","title":"Carrier"}},"title":"list_carrier_parcel_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/get_carrier_parcel_template":{"post":{"operationId":"get_carrier_parcel_template","summary":"Get one carrier parcel template by token: carrier, name, dimensions and whether the dimensions vary. Use for \"What are t","description":"Get one carrier parcel template by token: carrier, name, dimensions and whether the dimensions vary. Use for \"What are the dimensions of the USPS_FlatRateEnvelope template\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"template_token":{"description":"Template token such as 'USPS_FlatRateEnvelope' (from list_carrier_parcel_templates).","maxLength":100,"title":"Template Token","type":"string"}},"required":["template_token"],"title":"get_carrier_parcel_templateArguments","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_user_parcel_templates":{"post":{"operationId":"list_user_parcel_templates","summary":"List your own saved parcel templates with name, dimensions, weight and the carrier template they are based on. Use for \"","description":"List your own saved parcel templates with name, dimensions, weight and the carrier template they are based on. Use for \"Which parcel templates have I saved in Shippo\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_user_parcel_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_service_groups":{"post":{"operationId":"list_service_groups","summary":"List your service groups (live rates, flat rate or free shipping groups used for checkout rates) with type, flat rate, t","description":"List your service groups (live rates, flat rate or free shipping groups used for checkout rates) with type, flat rate, thresholds and the service levels in each. Use for \"How are my Shippo checkout service groups configured\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_service_groupsArguments","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_parcels":{"post":{"operationId":"list_parcels","summary":"List the parcel objects created in your account with dimensions, weight and units; 25 per page by default, up to 100. Us","description":"List the parcel objects created in your account with dimensions, weight and units; 25 per page by default, up to 100. Use for \"What parcels have I created in Shippo\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"results":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many parcels per page (1 to 100).","title":"Results"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"list_parcelsArguments","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}}}}