Close shipment

Closes a shipment and marks it as completed. Device reports and alerts will no longer be processed for this shipment. Sets status to Completed (including from CompletedWithAlerts), healthStatus to Closed and closingTime (if not already set), and closes the shipment's open alerts. Calling it on a shipment that is already Completed does nothing. No request body; returns 200 with an empty body.

Path Params
string
required

The account ID.

string
required

The shipment ID.

Responses
200

Success (empty body).

401

Missing, invalid or expired access token. Returned by the gateway with an empty body.

403

The token lacks the required permission, the account is not accessible to it, or the tenant is inactive. Returned by the gateway with an empty body.

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