Delete delivery legs for a given tracking identifier

Delete the delivery legs that have been created with the given tracking identifier.

This method is used to remove delivery legs no longer needed in a parcel journey.

This happens when the tracking identifier in the delivery leg will never be used for tracking a parcel, which means that no tracking events will ever be received for the given tracking identifier.

SecurityBasicAuth
Request
query Parameters
trackingIdentifier
required
string

Use the tracking identifier of the delivery legs that need to be deleted.

Note: This parameter is case sensitive.

Example: trackingIdentifier=REPLACE-WITH-YOUR-TRACKING-IDENTIFIER
header Parameters
User-Agent
string

The name of the client that interacts with the API.

Example: REPLACE-WITH-YOUR-USER-AGENT
Responses
200

All delivery legs for the specified tracking identifier have been deleted

400

Bad request.

The request failed validation due to missing required information in the parameters or the body of the request.

Error code: PS-0400.

401

Unauthorized.

The request did not provide the credentials required to authorize access to the API.

Error code: PS-0401.

403

Forbidden.

The API user is not authorized to proceed with the processing of the request.

Error code: PS-0403.

500

Internal Server Error.

The processing of the request failed due to an internal problem. The request needs to be retried.

Error code: PS-0500.

delete/delivery-legs
Request samples 
Response samples 
application/json
{
  • "message": "Deleted 2 delivery legs"
}