🚧 The Rhombus Developer Documentation is currently in beta. For the official documentation, please visit docs.rhombus.com.
curl --request POST \
--url https://api2.rhombussystems.com/api/partner/getShipments \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"clientOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"endTimeSec": 1640995200,
"startTimeSec": 1640908800
}
'{
"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>"
}Get client shipments
curl --request POST \
--url https://api2.rhombussystems.com/api/partner/getShipments \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"clientOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"endTimeSec": 1640995200,
"startTimeSec": 1640908800
}
'{
"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>"
}Your API key for Rhombus.
Authentication scheme indicator ("partner-api-token").
17Request object for getting client shipments within a time range.
base 64 (url-safe) uuid string
"AAAAAAAAAAAAAAAAAAAAAA"
End time for shipment search (seconds since epoch)
1640995200
Start time for shipment search (seconds since epoch)
1640908800
Was this page helpful?