Partner Webservice

Get client shipments

Get client shipments

post/api/partner/getShipments

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/partner/getShipments
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' 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.

Request body

clientOrgUuidstring RUUID nullable

base 64 (url-safe) uuid string

endTimeSecinteger nullable

End time for shipment search (seconds since epoch)

startTimeSecinteger nullable

Start time for shipment search (seconds since epoch)

Example request

{
  "clientOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "endTimeSec": 1640995200,
  "startTimeSec": 1640908800
}

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
warningMsgstring nullable

Example response

{
  "customerShipmentList": [
    {
      "rhombus-orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "rhombus-partnerOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "rhombus-rmaUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "rhombus-rmaUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.