Logistics

Get RMAs

POST/api/logistics/getRMAs

Authorizations

x-auth-apikeystringheaderrequired

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Authorizationstringheader

Instead of an API key, an OAuth access token: Bearer <token>, with the read scope.

OAuth explains tokens and scopes.

Headers

x-auth-schemeenum<string>headerdefault: api-token

Authentication scheme identifier. Use api-token or partner-api-token with the x-auth-apikey header, api or partner-api with x-auth-apikey plus a client certificate, api-oauth-token or partner-api-oauth-token with x-auth-access-token, and federated-token with x-auth-ft. A request with Authorization: Bearer <token> and no x-auth-scheme is treated as OAuth, and federated-token may also be sent as the x-auth-scheme and x-auth-ft query parameters.

Available options: api-token, api, api-oauth-token, federated-token, partner-api-token, partner-api, partner-api-oauth-token

x-auth-orgstring<RUUID>header

Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry Deprecation and Sunset: Tue, 05 Jan 2027 00:00:00 GMT). A malformed value returns 400 INVALID_AUTH_ORG; a client organization the partner cannot access returns 403 PARTNER_CLIENT_ACCESS_DENIED.

Length: 22 to 22

Body

application/json · object

Request object for getting RMAs (Return Merchandise Authorizations).

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/logistics/getRMAs' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://api2.rhombussystems.com/api/logistics/getRMAs"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

const response = await fetch('https://api2.rhombussystems.com/api/logistics/getRMAs', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {}
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/logistics/getRMAs"))
            .header("x-auth-scheme", "api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

{
  "error": false,
  "errorCode": "<string>",
  "rmaList": [
    {
      "address": "<string>",
      "advancedRMAs": {
        "falseReport": true,
        "invoiceNeeded": true,
        "knownIssue": true,
        "managerialApproved": true,
        "rctpPartnerRequested": true,
        "rctpPartnerUuid": "<string>",
        "rectified": true
      },
      "briefDescription": "<string>",
      "city": "<string>",
      "costInDollars": 0,
      "country": "<string>",
      "customerUnresponsive": true,
      "deleted": false,
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "errorCode": "DOORBELL_BUTTON_ISSUE",
      "failureDiagnostics": [
        "<string>"
      ],
      "fedExReturnLabelSent": true,
      "finalNotes": "<string>",
      "hardwareUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "initialFirmwareVersion": "<string>",
      "initiatedBy": "<string>",
      "inventoryNeeded": "<string>",
      "inventoryNeededMap": {
        "<key>": "<string>"
      },
      "isRefurbished": true,
      "knownIssue": true,
      "lastRecordedFirmwareVersion": "<string>",
      "lastUpdatedAtSec": 0,
      "lastUpdatedBy": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "postalCode": "<string>",
      "prevShippingInfoUsedBy": "<string>",
      "prevShippingInfoUsedByAtSec": 0,
      "proactiveReplacement": true,
      "rctpPartnerOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "recipientName": "<string>",
      "recipientPhoneNumber": "<string>",
      "replacementCourier": "<string>",
      "replacementHardwareUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "replacementTrackingNumber": "<string>",
      "requesterEmailAddress": "<string>",
      "returnLabelRequestedUpdatedAtSec": 0,
      "returnLabelSent": true,
      "returnLabelSentUpdatedAtSec": 0,
      "returnTrackingNumber": "<string>",
      "rmaRequest": {
        "formSubmitted": true,
        "requestUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "rmaOpportunityId": "<string>",
        "salesforceAccountId": "<string>",
        "salesforcePartnerContactId": "<string>",
        "salesforcePartnerId": "<string>"
      },
      "rmaRequestUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "sdCardReplaced": true,
      "shipmentMethod": "GROUND",
      "shipmentRequested": true,
      "shipmentRequestedBy": "<string>",
      "shipmentRequestedUpdatedAtSec": 0,
      "shipmentSent": true,
      "shipmentSentUpdatedAtSec": 0,
      "skipAutoRegistration": true,
      "state": "<string>",
      "status": "INITIATED",
      "storageCid": "<string>",
      "street": "<string>",
      "timestampSec": 0,
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "warehouseInventoryNeeded": true,
      "zenDeskTicketAssigneeEmail": "<string>",
      "zenDeskTicketSubject": "<string>",
      "zendeskTicket": 0
    }
  ]
}

Response

200 OK

application/json · object

Response object containing RMAs (Return Merchandise Authorizations).

errorboolean | null

errorCodestring | null

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring | null

rmaListobject[] | null

List of RMAs (Return Merchandise Authorizations)

Show child attributes

addressstring | null

advancedRMAsobject

Show child attributes

falseReportboolean | null

invoiceNeededboolean | null

knownIssueboolean | null

managerialApprovedboolean | null

rctpPartnerRequestedboolean | null

rctpPartnerUuidstring | null

rectifiedboolean | null

briefDescriptionstring | null

citystring | null

costInDollarsnumber<float> | null

countrystring | null

customerUnresponsiveboolean | null

deletedboolean | null

deviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

errorCodeenum<string>

Available options: BADGE_READER_UNKNOWN, DEAD_OR_MISSING_BATTERY, DOORBELL_BUTTON_ISSUE, ERROR_2, ERROR_4, ERROR_5, ERROR_24, ERROR_28, ERROR_30, ERROR_39, ERROR_74, ERROR_84, FOREIGN_HARDWARE, BAD_SD_BLOCKS, NEVER_LEFT_BUSY_STATE, HARDWARE_DAMAGE, HEAVY_HARDWARE_DAMAGE, WATER_DAMAGE, VIDEO_HARDWARE_FAILURE, ENCRYPTED_CONTAINER_FAILURE_CREATE, ENCRYPTED_CONTAINER_FAILURE_OPEN, ENCRYPTED_CONTAINER_FAILURE_MOUNT, LIGHT_SENSOR, SD_CARD_UNKOWN, SD_CARD_READER_BROKEN, POWER_ISSUES, RS485_ISSUE, CUT_FILTER, QUALITY_OR_PERFORMANCE, NETWORK_ISSUES, UNKNOWN, ILLEGIBLE_SERIAL_COMM, NO_SERIAL_COMM, COSMETIC_DAMAGE, IR_RING_OVERHEATED, REGISTERED_SENSOR, UNDISCOVERED_ISSUE, FOCUS_ISSUES, FIRMWARE_REFLASH_REQUIRED, POTENTIAL_MANUFACTURING_DEFECT, NO_FAULT_FOUND, FDT_COMMAND_LINE_ERROR, KERNEL_PANIC, GET_DTB_FAILED, POTENTIAL_FIRMWARE_ISSUE, BOOTS_TO_AMBOOT

failureDiagnosticsstring[] | null

fedExReturnLabelSentboolean | null

finalNotesstring | null

hardwareUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

initialFirmwareVersionstring | null

initiatedBystring | null

inventoryNeededstring | null

inventoryNeededMapobject | null

isRefurbishedboolean | null

knownIssueboolean | null

lastRecordedFirmwareVersionstring | null

lastUpdatedAtSecinteger<int64> | null

lastUpdatedBystring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

postalCodestring | null

prevShippingInfoUsedBystring | null

prevShippingInfoUsedByAtSecinteger<int64> | null

proactiveReplacementboolean | null

rctpPartnerOrgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

recipientNamestring | null

recipientPhoneNumberstring | null

replacementCourierstring | null

replacementHardwareUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

replacementTrackingNumberstring | null

requesterEmailAddressstring | null

returnLabelRequestedUpdatedAtSecinteger<int64> | null

returnLabelSentboolean | null

returnLabelSentUpdatedAtSecinteger<int64> | null

returnTrackingNumberstring | null

rmaRequestobject

Show child attributes

formSubmittedboolean | null

requestUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

rmaOpportunityIdstring | null

salesforceAccountIdstring | null

salesforcePartnerContactIdstring | null

salesforcePartnerIdstring | null

rmaRequestUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

sdCardReplacedboolean | null

shipmentMethodenum<string>

Available options: GROUND, EXPEDITED, OVERNIGHT

shipmentRequestedboolean | null

shipmentRequestedBystring | null

shipmentRequestedUpdatedAtSecinteger<int64> | null

shipmentSentboolean | null

shipmentSentUpdatedAtSecinteger<int64> | null

skipAutoRegistrationboolean | null

statestring | null

statusenum<string>

Available options: INITIATED, PENDING, APPROVED, INPROGRESS, COMPLETE, RETURN, STOLEN, OPERATIONAL, FULFILLMENT_ERROR

storageCidstring | null

streetstring | null

timestampSecinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

warehouseInventoryNeededboolean | null

zenDeskTicketAssigneeEmailstring | null

zenDeskTicketSubjectstring | null

zendeskTicketinteger<int32> | null

warningMsgstring | null

Errors

Like every operation, this one can also answer with the standard error body (errorCode, errorMsg). Errors explains each status and how to retry.

400 Bad Request. errorCode is one of: BAD_REQUEST, VALIDATION_FAILED, MISSING_REQUIRED_FIELD, INVALID_JSON, INVALID_REQUEST_BODY, FEATURE_NOT_ENABLED, INVALID_AUTH_ORG, LOCATION_NOT_FOUND.
401 Unauthorized. errorCode is one of: UNAUTHENTICATED, INVALID_CREDENTIAL, CREDENTIAL_EXPIRED, CREDENTIAL_REVOKED, CERTIFICATE_MISMATCH.
403 Forbidden. errorCode is one of: FORBIDDEN, DOMAIN_NOT_ALLOWED, DEVICE_SCOPE_MISMATCH, ROLE_NOT_PERMITTED, FUNCTIONALITY_REQUIRED, PARTNER_FUNCTIONALITY_REQUIRED, PERMISSION_REQUIRED, PARTNER_CLIENT_ACCESS_DENIED, HARDWARE_NOT_AVAILABLE, HARDWARE_ALREADY_REGISTERED, PARTNER_PORTAL_NOT_ENABLED, MANAGED_BY_MSP, SUPER_ADMIN_RESTRICTED_BY_MSP, MSP_DESIGNATION_INVALID, NOT_MANAGED_CLIENT.
429 Too Many Requests. errorCode is one of: RATE_LIMITED.
500 Internal Server Error. errorCode is one of: INTERNAL_ERROR.
503 Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE.