List User Shipments

View as Markdown
Lists shipments for the authenticated customer. Query filters: common list params plus shipment filters such as `status`, `type`, `archived`, `paid`, date ranges. Response fields: `message`, `data[]`, `pagination`. Shipment fields include `_id`, `shipmentNo`, `customer`, `warehouse`, `fullName`, `email`, `phone`, `type`, `status`, `paid`, `archived`, `originAddress`, `destinationAddress`, `packages[]`, `notes[]`, `currency`, `createdAt`, `updatedAt`. Possible errors: - 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.

Query parameters

pageintegerOptional

Query parameter supported by the gateway/downstream service.

limitintegerOptional

Query parameter supported by the gateway/downstream service.

sortBystringOptional

Query parameter supported by the gateway/downstream service.

sortOrderstringOptional

Query parameter supported by the gateway/downstream service.

qstringOptional

Query parameter supported by the gateway/downstream service.

statusstringOptional

Query parameter supported by the gateway/downstream service.

typestringOptional

Query parameter supported by the gateway/downstream service.

archivedstringOptional

Query parameter supported by the gateway/downstream service.

Response

OK
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