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
}
'import requests
url = "https://api2.rhombussystems.com/api/partner/getShipments"
payload = {
"clientOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"endTimeSec": 1640995200,
"startTimeSec": 1640908800
}
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
clientOrgUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
endTimeSec: 1640995200,
startTimeSec: 1640908800
})
};
fetch('https://api2.rhombussystems.com/api/partner/getShipments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/partner/getShipments")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"clientOrgUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"endTimeSec\": 1640995200,\n \"startTimeSec\": 1640908800\n}")
.asString();{
"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>"
}Partner Webservice
Get client shipments
Get client shipments
POST
/
api
/
partner
/
getShipments
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
}
'import requests
url = "https://api2.rhombussystems.com/api/partner/getShipments"
payload = {
"clientOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"endTimeSec": 1640995200,
"startTimeSec": 1640908800
}
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
clientOrgUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
endTimeSec: 1640995200,
startTimeSec: 1640908800
})
};
fetch('https://api2.rhombussystems.com/api/partner/getShipments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/partner/getShipments")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"clientOrgUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"endTimeSec\": 1640995200,\n \"startTimeSec\": 1640908800\n}")
.asString();{
"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
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
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.
base 64 (url-safe) uuid string
Example:
"AAAAAAAAAAAAAAAAAAAAAA"
End time for shipment search (seconds since epoch)
Example:
1640995200
Start time for shipment search (seconds since epoch)
Example:
1640908800
Last modified on October 5, 2026