This API is used to delete cargo entries that are either incorrectly registered or should be excluded from tracking. Once deleted, the cargo is removed from the system and cannot be retrieved unless it is re-registered.
Even if a cargo is deleted, it will still count toward the contractual usage quota once it has been successfully registered.
Authentication
The Cargo API uses Basic Authorization on Swagger UI.
Authentication Steps
1.
Click the [Authorize] button in the top right corner.
2.
Enter the provided username and password in the popup window.
3.
Click [Authorize] again to proceed with authentication.
4.
After successful login, click [Close] to close the window.
All API requests from Swagger UI will automatically include the authorization token.
Cargo Deletion Request
Request URL
[DELETE] https://insight.seavantage.com/api/cargo/{documentId}
Execution Steps
1.
2.
Navigate to /cargo/{documentId}.
3.
Click [Try it Out] to activate the input fields.
4.
Enter the required parameters, especially the documentId.
•
5.
Click [Execute] to send the request.
6.
Check the response area at the bottom for the result.
Response Field Descriptions
Whether the request succeeds or fails can be identified using the HTTP status code.
Response Codes
Code | Description |
204 | Deleted |
400 | Bad request |
401 | Unauthorized |
403 | Forbidden |
422 | Unprocessable entity |
429 | Too many requests |