🚧 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/report/getEnvoyDeliveries \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"endTimestampMs": 123,
"locationIds": [
"<string>"
],
"startTimestampMs": 123
}
'{
"collectedDeliveries": [
{
"carrier": {
"name": "<string>"
},
"carrierInfo": {
"name": "<string>"
},
"deliveryArea": {
"name": "<string>"
},
"deliveryAreaInfo": {
"name": "<string>"
},
"locationId": "<string>",
"pickedUpAt": "<string>",
"pickedUpBy": {
"email": "<string>",
"id": "<string>",
"locationIds": [
"<string>"
],
"locations": [
"<string>"
],
"name": "<string>",
"type": "<string>"
},
"receivedTimestampMs": 123,
"recipient": {
"email": "<string>",
"id": "<string>",
"locationIds": [
"<string>"
],
"locations": [
"<string>"
],
"name": "<string>",
"type": "<string>"
},
"status": "<string>"
}
],
"error": true,
"errorMsg": "<string>",
"pendingDeliveries": [
{
"carrier": {
"name": "<string>"
},
"carrierInfo": {
"name": "<string>"
},
"deliveryArea": {
"name": "<string>"
},
"deliveryAreaInfo": {
"name": "<string>"
},
"locationId": "<string>",
"pickedUpAt": "<string>",
"pickedUpBy": {
"email": "<string>",
"id": "<string>",
"locationIds": [
"<string>"
],
"locations": [
"<string>"
],
"name": "<string>",
"type": "<string>"
},
"receivedTimestampMs": 123,
"recipient": {
"email": "<string>",
"id": "<string>",
"locationIds": [
"<string>"
],
"locations": [
"<string>"
],
"name": "<string>",
"type": "<string>"
},
"status": "<string>"
}
],
"warningMsg": "<string>"
}Get a list of deliveries from Envoy to populate reporting logs
curl --request POST \
--url https://api2.rhombussystems.com/api/report/getEnvoyDeliveries \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"endTimestampMs": 123,
"locationIds": [
"<string>"
],
"startTimestampMs": 123
}
'{
"collectedDeliveries": [
{
"carrier": {
"name": "<string>"
},
"carrierInfo": {
"name": "<string>"
},
"deliveryArea": {
"name": "<string>"
},
"deliveryAreaInfo": {
"name": "<string>"
},
"locationId": "<string>",
"pickedUpAt": "<string>",
"pickedUpBy": {
"email": "<string>",
"id": "<string>",
"locationIds": [
"<string>"
],
"locations": [
"<string>"
],
"name": "<string>",
"type": "<string>"
},
"receivedTimestampMs": 123,
"recipient": {
"email": "<string>",
"id": "<string>",
"locationIds": [
"<string>"
],
"locations": [
"<string>"
],
"name": "<string>",
"type": "<string>"
},
"status": "<string>"
}
],
"error": true,
"errorMsg": "<string>",
"pendingDeliveries": [
{
"carrier": {
"name": "<string>"
},
"carrierInfo": {
"name": "<string>"
},
"deliveryArea": {
"name": "<string>"
},
"deliveryAreaInfo": {
"name": "<string>"
},
"locationId": "<string>",
"pickedUpAt": "<string>",
"pickedUpBy": {
"email": "<string>",
"id": "<string>",
"locationIds": [
"<string>"
],
"locations": [
"<string>"
],
"name": "<string>",
"type": "<string>"
},
"receivedTimestampMs": 123,
"recipient": {
"email": "<string>",
"id": "<string>",
"locationIds": [
"<string>"
],
"locations": [
"<string>"
],
"name": "<string>",
"type": "<string>"
},
"status": "<string>"
}
],
"warningMsg": "<string>"
}Your API key for Rhombus.
Authentication scheme indicator ("api-token").
9Was this page helpful?