Add Shipment Admin Note | CargoExtra Global Logistics USA

Adds an admin note to a shipment. The downstream service expects Mongo shipment _id for this note route.

Path parameter: shipmentId shipment Mongo ObjectId. Required body field: note.

Response fields: message. Gateway may also queue an email using downstream data payload.

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.

Adds an admin note to a shipment. The downstream service expects Mongo shipment `_id` for this note route. Path parameter: `shipmentId` shipment Mongo ObjectId. Required body field: `note`. Response fields: `message`. Gateway may also queue an email using downstream `data` payload. 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

shipmentIdstringRequired

ShipmentId path parameter.

Request

This endpoint expects an object.

notestringRequired

Response

key_0integer

key_1string

key_2double

key_3string

key_4boolean

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

Adds an admin note to a shipment. The downstream service expects Mongo shipment _id for this note route.

Path parameter: shipmentId shipment Mongo ObjectId. Required body field: note.

Response fields: message. Gateway may also queue an email using downstream data payload.

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.

$	curl -X POST http://localhost:9000/api/v1/shipment_admin/notes/string \
>	-H "Content-Type: application/json" \
>	-d '{
>	"note": "Shipment inspected and ready for next step."
>	}'

1	{
2	"key_0": 10234,
3	"key_1": "Note added successfully",
4	"key_2": 1587.45,
5	"key_3": "adminUser123",
6	"key_4": true
7	}