Skip to main content
POST
/
api
/
logistics
/
getRMAs
Get RMAs
curl --request POST \
  --url https://api2.rhombussystems.com/api/logistics/getRMAs \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '{}'
{
  "error": true,
  "errorMsg": "<string>",
  "rmaList": [
    {
      "address": "<string>",
      "advancedRMAs": {
        "invoiceNeeded": true,
        "knownIssue": true,
        "managerialApproved": true,
        "managerialApprovedRMAs": {
          "falseReport": true,
          "rectified": true,
          "rmauuid": "AAAAAAAAAAAAAAAAAAAAAA"
        },
        "rctpPartnerRequested": true,
        "rctpPartnerUuid": "<string>",
        "rctpRMAs": {
          "falseReport": true,
          "rectified": true,
          "rmauuid": "AAAAAAAAAAAAAAAAAAAAAA"
        }
      },
      "briefDescription": "<string>",
      "city": "<string>",
      "costInDollars": 123,
      "country": "<string>",
      "customerUnresponsive": true,
      "deleted": true,
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "errorCode": "BADGE_READER_UNKNOWN",
      "failureDiagnostics": [
        "<string>"
      ],
      "fedExReturnLabelSent": true,
      "finalNotes": "<string>",
      "hardwareUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "initialFirmwareVersion": "<string>",
      "initiatedBy": "<string>",
      "inventoryNeeded": "<string>",
      "inventoryNeededMap": {},
      "isRefurbished": true,
      "knownIssue": true,
      "lastRecordedFirmwareVersion": "<string>",
      "lastUpdatedAtSec": 123,
      "lastUpdatedBy": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "postalCode": "<string>",
      "prevShippingInfoUsedBy": "<string>",
      "prevShippingInfoUsedByAtSec": 123,
      "proactiveReplacement": true,
      "recipientName": "<string>",
      "recipientPhoneNumber": "<string>",
      "replacementCourier": "<string>",
      "replacementHardwareUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "replacementTrackingNumber": "<string>",
      "requesterEmailAddress": "<string>",
      "returnLabelRequestedUpdatedAtSec": 123,
      "returnLabelSent": true,
      "returnLabelSentUpdatedAtSec": 123,
      "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": 123,
      "shipmentSent": true,
      "shipmentSentUpdatedAtSec": 123,
      "skipAutoRegistration": true,
      "state": "<string>",
      "status": "INITIATED",
      "storageCid": "<string>",
      "street": "<string>",
      "timestampSec": 123,
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "warehouseInventoryNeeded": true,
      "zenDeskTicketAssigneeEmail": "<string>",
      "zenDeskTicketSubject": "<string>",
      "zendeskTicket": 123
    }
  ],
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for getting RMAs (Return Merchandise Authorizations).

Response

200 - application/json

OK

Response object containing RMAs (Return Merchandise Authorizations).

error
boolean | null
errorMsg
string | null
rmaList
object[] | null

List of RMAs (Return Merchandise Authorizations)

warningMsg
string | null