Skip to main content
POST
/
api
/
logistics
/
getShipments
Get shipments
curl --request POST \
  --url https://api2.rhombussystems.com/api/logistics/getShipments \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "endTimeSec": 1641081600,
  "startTimeSec": 1640995200
}
'
{
  "customerShipmentList": [
    {
      "ait-aitTrackingNumber": "<string>",
      "ait-carrierTrackingNumber": "<string>",
      "ait-depositorOrderNumber": "<string>",
      "ait-destinationAddress": "<string>",
      "ait-isIngramDistributorShipment": true,
      "ait-shipmentDate": "2023-11-07T05:31:56Z",
      "ait-shippedItems": [
        {
          "partNumber": "<string>",
          "quantityShipped": 123,
          "serialNumber": "<string>"
        }
      ],
      "interchangeControlNumber": "<string>",
      "lastStateUpdateSec": 123,
      "rhombus-additionalEmails": "<string>",
      "rhombus-chosenCarrierName": "<string>",
      "rhombus-claimKeyToLicenseMap": {},
      "rhombus-claimKeyToLicenseMapV2": {},
      "rhombus-customerEmails": "<string>",
      "rhombus-customerName": "<string>",
      "rhombus-orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "rhombus-partnerOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "rhombus-purchaseOrderNumber": "<string>",
      "rhombus-rmaReturnTrackingNumber": "<string>",
      "rhombus-rmaUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "rhombus-rmaUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "rhombus-salesForceOpportunityId": "<string>",
      "rhombus-zendeskTicketNumber": "<string>",
      "shipmentCategory": "RMA",
      "shipmentEmailState": "SHIPPING_CONFIRMATION_SUCCESS",
      "shipmentState": "CREATED",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for getting shipments within a time range.

endTimeSec
integer<int64> | null

End time in seconds (Unix timestamp)

Example:

1641081600

startTimeSec
integer<int64> | null

Start time in seconds (Unix timestamp)

Example:

1640995200

Response

200 - application/json

OK

Response object containing shipments within the specified time range.

customerShipmentList
object[] | null

List of customer shipments within the specified time range

error
boolean | null
errorMsg
string | null
warningMsg
string | null