Get route collection by id (beta)

Beta notice : this endpoint is part of our v3-suite beta testing phase.
Please note that:

  • The behavior and structure may change before public release.
  • Some features or results may still be incomplete or evolving.

Retrieve the full details of a saved route collection by its id.

Notes and considerations

  • id lifetime: the route collection id remains valid for a limited period (at least 1 hour), except when associated with a shipment.
  • This endpoint is useful when you have received a route collection id after searching for routes (via POST /v3/routeCollections`) and need to fetch its full details without re-creating the route collection.
  • it is also useful to retrieve the route collection associated with a shipment (via GET /v3/shipments/{id}).

Support endpoints and resources

  • Search route collections: use /v3/routeCollections to get route collections (id).
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier of the route collection.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json