List carrier slugs accepted by carrier_hint
Returns the versioned catalog of runtime carrier slugs that can be selected explicitly with shipments[].carrier_hint in POST /trackings. Verified carrier input rules appear as input_requirements: required fields are needed for every lookup, any_of means provide at least one listed field in addition to required fields, and conditional fields may be requested for some shipments. For SEUR, send destination postal_code plus the recipient email or phone registered with SEUR. These names are exact paths in a POST /trackings shipment item, such as postal_code or additional_fields.house_number. A pair of conditional fields may need to be supplied together for a particular lookup, such as Dole container tracking with vessel and voyage. When input_requirements is absent, no complete input rule has been published for that carrier; do not infer that it never needs additional fields. Tracking results and webhooks omit interactive required-field prompt events. This catalog is independent of delivery-estimate transport modes: a carrier can be available here without being eligible for POST /delivery-estimates. Results are localized, searchable, and cursor-paginated.
Request
- Base URLhttps://parcelsapp.com/api-docs/mock/v4
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Optional case-insensitive carrier name or slug search.
Opaque next_cursor returned by the preceding page. A cursor is valid only for its catalog version and query.
Response
A page of manually selectable tracking carriers.
Example response
{
"carriers": [
{
"slug": "yinrui",
"name": "Yinrui"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.