Skip to main content
POST
Get client shipments

Authorizations

x-auth-apikey
string
header
required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme
enum<string>
default:partner-api-token
required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options:
api-token,
api,
partner-api-token,
partner-api

Body

application/json

Request object for getting client shipments within a time range.

clientOrgUuid
string<RUUID> | null
RUUID

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

endTimeSec
integer<int64> | null
int64

End time for shipment search (seconds since epoch)

Example:

1640995200

startTimeSec
integer<int64> | null
int64

Start time for shipment search (seconds since epoch)

Example:

1640908800

Response

200 - application/json

OK

Response object containing client shipments within the specified time range.

customerShipmentList
object[] | null

List of customer shipments

error
boolean | null
errorMsg
string | null
warningMsg
string | null
Last modified on August 21, 2026