Tracking Requests
Cancel a tracking request
Cancel a pending or awaiting_manifest tracking request in the Terminal49 API so Terminal49 stops trying to find the shipment.
PATCH
Cancel a tracking request
Cancels a tracking request whose
status is pending or awaiting_manifest. The request moves to status cancelled, and failed_reason becomes Cancelled by user.
- A request in any other status returns
422. Theerrorsvalue in that response is a string, not a JSON:API errors array. - A request that belongs to another account also returns
422, not404. - An unknown tracking request ID currently returns a
500server error, not404. This differs from other lookups by ID, which return404. A401comes only from authentication. It means your API token is missing or invalid, or your account may not use the API. - A request that has already created a shipment cannot be cancelled. To stop tracking that shipment, use Stop tracking a shipment.
- To find cancelled requests, filter the list with
filter[status]=cancelled.
Authorizations
Use a Terminal49 API key in the Authorization header with the Token prefix.
Authorization: Token YOUR_API_KEY
Path Parameters
Tracking Request ID
Response
Cancelled. The response body is an empty JSON object.
The response is of type object.