Get Envoy deliveries
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
}
'import requests
url = "https://api2.rhombussystems.com/api/report/getEnvoyDeliveries"
payload = {
"endTimestampMs": 123,
"locationIds": ["<string>"],
"startTimestampMs": 123
}
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({endTimestampMs: 123, locationIds: ['<string>'], startTimestampMs: 123})
};
fetch('https://api2.rhombussystems.com/api/report/getEnvoyDeliveries', 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/report/getEnvoyDeliveries")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"endTimestampMs\": 123,\n \"locationIds\": [\n \"<string>\"\n ],\n \"startTimestampMs\": 123\n}")
.asString();{
"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>"
}Integrations Webservice
Get Envoy deliveries
Get a list of deliveries from Envoy to populate reporting logs
POST
/
api
/
report
/
getEnvoyDeliveries
Get Envoy deliveries
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
}
'import requests
url = "https://api2.rhombussystems.com/api/report/getEnvoyDeliveries"
payload = {
"endTimestampMs": 123,
"locationIds": ["<string>"],
"startTimestampMs": 123
}
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({endTimestampMs: 123, locationIds: ['<string>'], startTimestampMs: 123})
};
fetch('https://api2.rhombussystems.com/api/report/getEnvoyDeliveries', 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/report/getEnvoyDeliveries")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"endTimestampMs\": 123,\n \"locationIds\": [\n \"<string>\"\n ],\n \"startTimestampMs\": 123\n}")
.asString();{
"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>"
}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
Last modified on August 10, 2026
⌘I