Delete Shipment Admin Note
Deletes an admin note from a shipment. The downstream service expects Mongo shipment `_id` and note `_id`.
Path parameter: `shipmentId` shipment Mongo ObjectId. Required body field: `noteId`.
Response: HTTP 204 on success.
Possible errors:
- 400: Missing One or More Required Parameters - `note` or `noteId` missing.
- 400: Invalid Update - shipment id/note id is invalid or note is not an admin note.
- 400: Bad Shipment - archived shipment cannot be updated.
- 404: Shipment not found - shipment id was not found.
- 400: Invalid customer Id - admin customer filter is not a valid ObjectId.
- 404: Shipment not found - shipment number/id was not found.
- 400: Invalid Type/Status/Value - shipment filters or model values are outside allowed ranges.
- 400: Missing One or More Required Parameters - required body/query fields were not supplied.
- 401: Unauthorized - token is missing, expired, invalid, or the account/token pair was not found.
- 403: Access denied - gateway traffic guard/rate policy blocked the request.
- 429: Too many requests - gateway rate limit exceeded.
- 500: Unexpected Error - unhandled gateway or downstream service failure.
Path parameters
shipmentId
ShipmentId path parameter.
Request
This endpoint expects an object.
noteId
Response
No Content
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error