{"openapi":"3.1.0","info":{"title":"Trackid API","version":"0.1.0","description":"A fully local carrier tracking-number format identifier: pattern-matches length, prefix and (for UPS and international postal S10 numbers) checksum against publicly documented formats for USPS, FedEx, UPS, DHL, Amazon Logistics, OnTrac, Canada Post, Royal Mail and other UPU postal services. Pure pattern-matching — no live tracking lookup.\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://trackid.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"hr@unifydynamics.com","url":"https://connectorbay.com/trackid/docs"},"termsOfService":"https://connectorbay.com/trackid/terms"},"servers":[{"url":"https://trackid.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/trackid/docs"},"security":[{},{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/identify_carrier":{"post":{"operationId":"identify_carrier","summary":"Identifies which carrier(s) a tracking number's FORMAT most likely belongs to, ranked by confidence","description":"Identifies which carrier(s) a tracking number's FORMAT most likely belongs to, ranked by confidence\n    (definite/likely/possible), including a real checksum check for UPS 1Z and international postal (UPU S10)\n    numbers. Pure pattern-matching — never looks up the actual shipment. Use for \"what carrier is this tracking\n    number from\", \"1Z999AA10123456784 what carrier\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"tracking_number":{"description":"A tracking number string, exactly as given to you (spaces/dashes are ignored).","examples":["1Z999AA10123456784","9400111899223197428490","TBA123456789012"],"minLength":4,"title":"Tracking Number","type":"string"}},"required":["tracking_number"],"title":"identify_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/batch_identify_carriers":{"post":{"operationId":"batch_identify_carriers","summary":"Runs identify_carrier over a list of tracking numbers at once. Use for \"identify all these tracking","description":"Runs identify_carrier over a list of tracking numbers at once. Use for \"identify all these tracking\n    numbers\", when someone pastes a batch from an order history export.","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"tracking_numbers":{"description":"Up to 25 tracking numbers to identify at once.","items":{"type":"string"},"maxItems":25,"minItems":1,"title":"Tracking Numbers","type":"array"}},"required":["tracking_numbers"],"title":"batch_identify_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/is_valid_tracking_format":{"post":{"operationId":"is_valid_tracking_format","summary":"A quick yes/no on whether a string is shaped like ANY known carrier tracking number, without naming which","description":"A quick yes/no on whether a string is shaped like ANY known carrier tracking number, without naming which\n    one. Use for \"does this look like a real tracking number\", validating input before someone pastes it into a\n    tracking site.","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"tracking_number":{"description":"A tracking number string to sanity-check.","minLength":1,"title":"Tracking Number","type":"string"}},"required":["tracking_number"],"title":"is_valid_tracking_formatArguments","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/explain_tracking_number":{"post":{"operationId":"explain_tracking_number","summary":"Breaks a tracking number down into its known components (shipper/service code, serial, check digit,","description":"Breaks a tracking number down into its known components (shipper/service code, serial, check digit,\n    origin-country code for international postal numbers) for its best-matching format, and verifies the\n    checksum when one applies. Use for \"what do the parts of this UPS tracking number mean\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"tracking_number":{"description":"A tracking number to break down into its components.","minLength":4,"title":"Tracking Number","type":"string"}},"required":["tracking_number"],"title":"explain_tracking_numberArguments","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/carrier_format_info":{"post":{"operationId":"carrier_format_info","summary":"Full detail on one carrier's tracking-number format(s): pattern, length, checksum type, confidence and a","description":"Full detail on one carrier's tracking-number format(s): pattern, length, checksum type, confidence and a\n    sample. Use list_carriers to see valid names. Use for \"what does a FedEx tracking number look like\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"carrier":{"description":"A carrier name or id.","examples":["UPS","usps","DHL Express"],"title":"Carrier","type":"string"}},"required":["carrier"],"title":"carrier_format_infoArguments","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":"Every carrier this reference covers, with how many distinct formats each has. Use for \"what carriers can","description":"Every carrier this reference covers, with how many distinct formats each has. Use for \"what carriers can\n    you identify\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"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/generate_example_tracking_number":{"post":{"operationId":"generate_example_tracking_number","summary":"Generates a synthetic, correctly-formatted example tracking number for a named carrier (with a genuinely","description":"Generates a synthetic, correctly-formatted example tracking number for a named carrier (with a genuinely\n    valid checksum where that carrier's format has one) — NOT a real, traceable shipment. Use for \"give me an\n    example UPS tracking number to test with\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"carrier":{"description":"A carrier name or id to generate a synthetic example for.","title":"Carrier","type":"string"}},"required":["carrier"],"title":"generate_example_tracking_numberArguments","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/disambiguation_tips":{"post":{"operationId":"disambiguation_tips","summary":"Explains how to tell apart carriers whose tracking numbers share an identical length/shape (e.g. plain","description":"Explains how to tell apart carriers whose tracking numbers share an identical length/shape (e.g. plain\n    12-digit numbers used by both FedEx and UPS Mail Innovations). Use for \"this could be FedEx or UPS, how do I\n    tell which\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"disambiguation_tipsArguments","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/checksum_algorithms":{"post":{"operationId":"checksum_algorithms","summary":"Documents the two real, verifiable checksum algorithms this tool implements: UPS's 1Z modulus-10 check","description":"Documents the two real, verifiable checksum algorithms this tool implements: UPS's 1Z modulus-10 check\n    digit, and the UPU S10 international postal check digit used by USPS/Canada Post/Royal Mail/most national\n    posts. Use for \"how does the UPS tracking number checksum work\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"checksum_algorithmsArguments","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}}}}