GuidesAPI Reference
API Reference

Deletes all shipments

delete
https://tracking.hereapi.com/shipments/v4

Deletes all the shipments of the project.

Note that one needs to supply an HTTP header x-confirm with the value true to force the deletion. If the header is not provided, the request will fail.

If the project has many shipments, deleting them all can take a while. This operation returns 202 as long as the shipments deletion is in progress and 204 after all shipments have been deleted.

Query Params
string
length between 1 and 50

Project ID. Any HERE Tracking user must be a member of a Tracking project. The project ID can be implicitly resolved if the user calling the API is a member of a single project. If the user is a member of multiple projects, the projectId query parameter needs to be specified explicitly.

Headers
string
enum
required

A safety measure that prevents one from accidentally deleting data.

To confirm that all entries should be deleted, set the value to true.

Allowed:
uuid

ID used for correlating requests within HERE Tracking. Used for logging and error reporting.

Must be a valid UUIDv4.

Responses
202

Accepted

Shipments deletion is in progress.

204

Successful (no content).

All shipments were successfully deleted.

Updated 2 months ago

Language
Credentials
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 2 months ago