Skip to navigation
CargoExtra Gateway API Copydelivery_admin

List All Deliveries

View as Markdown

Lists deliveries across customers.

Query filters: common list params, customerId/customer, q, approve, type, archived, date range.

Response fields: message, data[], pagination. Each delivery contains delivery model fields described in User Deliveries.

Possible errors:

  • 400: Invalid customer Id - admin customer filter is not a valid ObjectId.
  • 404: Delivery not found - delivery number was not found.
  • 400: Invalid Price/Value - delivery model value failed validation.
  • 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.

customerIdstringOptional

Query parameter supported by the gateway/downstream service.

approvestringOptional

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