Get Rma By ID

gethttps://api.flxpoint.com/rma/{id}

Use this when you want to pull rma data through the API.

🔑 X-API-TOKEN⏱ 2 req/sToken: Account · Source · Channel

This page explains the endpoint. To send a live test request, use the interactive tester in Stoplight or your own Postman / HTTP client.

Retrives a `RMA` by provided id

Request

Example request

get/rma/{id}

curl -X GET "https://api.flxpoint.com/rma/{id}" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN"

Responses

200OKapplication/json

idinteger

returnIdinteger

sourceIdinteger

rmaNumberstring

accountIdinteger

returnToAddressobject

idinteger

namestring

Field created real-time by concatenating "firstName" and "lastName"

addressLine1string

addressLine2string

citystring

statestring

countrystring

stateCodestring

countryCodestring

postalstring

Postal / Zip Code of address

emailstring

phonestring

Free form string field, format isn't enforced

companyNamestring

firstNamestring

lastNamestring

redactedboolean

Represents if the address information was related to an Order with a PII (Personably Identifiable Information) retention policy attached. If the Order exceeds the PII retention period, this address will have information redacted.

hashstring

Represents a unique hash of this address.

itemsarray[RmaItem]

idinteger

returnItemIdinteger

rmaIdinteger

skustring

titlestring

costnumber

returnReasonstring

returnConditionstring

notestring

quantityinteger

approvedQuantityinteger

deniedQuantityinteger

creditedAmountnumber

receivedQuantityinteger

voidedQuantityinteger

bundleComponentsarray[OrderItemBundleComponent]

idinteger

orderItemIdinteger

componentVirtualVariantIdinteger

componentQuantityinteger

quantityintegerrequired

skustring

costnumber

shippedQuantityinteger

shippedStatusCompletionStatus

allowedNot StartedPartially CompletedCompleted

allocatedQuantityinteger

allocatedStatusCompletionStatus

allowedNot StartedPartially CompletedCompleted

acknowledgedQuantityinteger

acknowledgedStatusCompletionStatus

allowedNot StartedPartially CompletedCompleted

totalRmaItemsinteger

createdAtstring (date-time)

updatedAtstring (date-time)

rmaStatusRmaStatus

allowedWaitingApprovedVoidedDeniedPartially ApprovedCanceled

rmaShipmentsarray[RmaShipment]

idinteger

rmaIdinteger

accountIdinteger

shipmentobject

idinteger

notestring

trackingUrlstring

trackingNumberstring

carrierstring

methodstring

shippedAtstring (date-time)

insertedAtstring (date-time)

shippingCostnumber

orderIdinteger

purchaseOrderIdinteger

fulfillmentRequestIdinteger

rmaIdinteger

sourceIdinteger

accountIdinteger

partialboolean

suppressedboolean

syncedToChannelboolean

syncErrorstring

crossDockPurchaseOrderIdinteger

shipmentItemsarray[ShipmentItem]

idinteger

skustring

quantityinteger

shipmentIdinteger

inventoryVariantIdinteger (int64)

partialboolean

orderItemIdinteger

purchaseOrderItemIdinteger

this field will soon be deprecated, please start using `fulfillmentRequestItemId` instead. there are basically the same thing, just there has been a terminology change.

fulfillmentRequestItemIdinteger

committedStockReleasedQuantityinteger

rmaItemIdinteger

customFieldsarray[ShipmentCustomField]

idinteger

namestring

valuestring

updatedAtstring (date-time)

accountingSyncedboolean

shippingAddressobject

idinteger

namestring

Field created real-time by concatenating "firstName" and "lastName"

addressLine1string

addressLine2string

citystring

statestring

countrystring

stateCodestring

countryCodestring

postalstring

Postal / Zip Code of address

emailstring

phonestring

Free form string field, format isn't enforced

companyNamestring

firstNamestring

lastNamestring

redactedboolean

hashstring

Represents a unique hash of this address.

attachmentsarray[RmaShipmentAttachment]

idinteger

rmaIdinteger

rmaShipmentIdinteger

attachmentTypestring

attachmentUrlstring

createdAtstring (date-time)

sentAtstring (date-time)

rmaShipmentStatusRmaShipmentStatus

allowedShipment CreatedShipment SentShipment ReceivedShipment Partially ReceivedShipment Voided

creditSubtotalnumber

creditAdjustmentnumber

creditTotalnumber

creditLastSyncedAtstring (date-time)

syncCreditChangesToOrderboolean

shipmentReceivedStatusShipmentReceivedStatus

allowednot_receivedpartially_receivedfully_received

accountingSyncedAtstring (date-time)

accountingErrorstring

Example response

{
  "id": 0,
  "returnId": 0,
  "sourceId": 0,
  "rmaNumber": "string",
  "accountId": 0,
  "returnToAddress": {
    "id": 0,
    "name": "Joe Smith",
    "addressLine1": "120 1st Lane",
    "addressLine2": "Suite 123",
    "city": "Jacksonville",
    "state": "Florida",
    "country": "United States",
    "stateCode": "FL",
    "countryCode": "US",
    "postal": "12345",
    "email": "person@example.com",
    "phone": "1-555-123-4567",
    "companyName": "string",
    "firstName": "Joe",
    "lastName": "Smith",
    "redacted": true,
    "hash": "string"
  },
  "items": [
    {
      "id": 0,
      "returnItemId": 0,
      "rmaId": 0,
      "sku": "string",
      "title": "string",
      "cost": 0,
      "returnReason": "string",
      "returnCondition": "string",
      "note": "string",
      "quantity": 0,
      "approvedQuantity": 0,
      "deniedQuantity": 0,
      "creditedAmount": 0,
      "receivedQuantity": 0,
      "voidedQuantity": 0,
      "bundleComponents": [
        {
          "id": null,
          "orderItemId": null,
          "componentVirtualVariantId": null,
          "componentQuantity": null,
          "quantity": null,
          "sku": null,
          "cost": null,
          "shippedQuantity": null,
          "shippedStatus": null,
          "allocatedQuantity": null,
          "allocatedStatus": null,
          "acknowledgedQuantity": null,
          "acknowledgedStatus": null
        }
      ]
    }
  ],
  "totalRmaItems": 0,
  "createdAt": "2026-04-20T00:00:00Z",
  "updatedAt": "2026-04-20T00:00:00Z",
  "rmaStatus": "Waiting",
  "rmaShipments": [
    {
      "id": 0,
      "rmaId": 0,
      "accountId": 0,
      "shipment": {
        "id": 0,
        "note": "string",
        "trackingUrl": "string",
        "trackingNumber": "string",
        "carrier": "string",
        "method": "string",
        "shippedAt": "2026-04-20T00:00:00Z",
        "insertedAt": "2026-04-20T00:00:00Z",
        "shippingCost": 0,
        "orderId": 0,
        "purchaseOrderId": 0,
        "fulfillmentRequestId": 0,
        "rmaId": 0,
        "sourceId": 0,
        "accountId": 0,
        "partial": true,
        "suppressed": true,
        "syncedToChannel": true,
        "syncError": "string",
        "crossDockPurchaseOrderId": 0,
        "shipmentItems": [
          null
        ],
        "customFields": [
          null
        ],
        "updatedAt": "2026-04-20T00:00:00Z",
        "accountingSynced": true
      },
      "shippingAddress": {
        "id": 0,
        "name": "Joe Smith",
        "addressLine1": "120 1st Lane",
        "addressLine2": "Suite 123",
        "city": "Jacksonville",
        "state": "Florida",
        "country": "United States",
        "stateCode": "FL",
        "countryCode": "US",
        "postal": "12345",
        "email": "person@example.com",
        "phone": "1-555-123-4567",
        "companyName": "string",
        "firstName": "Joe",
        "lastName": "Smith",
        "redacted": true,
        "hash": "string"
      },
      "attachments": [
        {
          "id": null,
          "rmaId": null,
          "rmaShipmentId": null,
          "attachmentType": null,
          "attachmentUrl": null
        }
      ],
      "createdAt": "2026-04-20T00:00:00Z",
      "sentAt": "2026-04-20T00:00:00Z",
      "rmaShipmentStatus": "Shipment Created"
    }
  ],
  "creditSubtotal": 0,
  "creditAdjustment": 0,
  "creditTotal": 0,
  "creditLastSyncedAt": "2026-04-20T00:00:00Z",
  "syncCreditChangesToOrder": true,
  "shipmentReceivedStatus": "not_received",
  "accountingSyncedAt": "2026-04-20T00:00:00Z",
  "accountingError": "string"
}

401Unauthorized

No schema documented for this status.

404Not Found

No schema documented for this status.

OpenAPI fragment

{
  "get": {
    "summary": "Get Rma By ID",
    "description": "Retrives a `RMA` by provided id",
    "parameters": [],
    "responses": {
      "200": {
        "description": "OK",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Rma"
            }
          }
        }
      },
      "401": {
        "description": "Unauthorized"
      },
      "404": {
        "description": "Not Found"
      }
    }
  }
}

Ready to run it? Send the curl from your terminal or Postman, or use the interactive tester in Stoplight.Open in Stoplight