FlxpointAPI Help CenterBeta

Get Return by ID

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

Use this when you want to pull returns 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.

Retrieves a `Return` by provided id

Request

Example request

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

Responses

200OKapplication/json
idinteger
orderIdinteger
returnNumberstring
accountIdinteger
totalReturnItemsinteger
totalRmasinteger
channelIdinteger
itemsarray[ReturnItem]
idinteger
returnIdinteger
orderItemIdinteger
skustring
returnQuantityinteger
returnReasonstring
returnConditionstring
salesPricenumber
titlestring
refundedAmountnumber
bundleComponentsarray[OrderItemBundleComponent]
idinteger
orderItemIdinteger
componentVirtualVariantIdinteger
componentQuantityinteger
quantityintegerrequired
skustring
costnumber
shippedQuantityinteger
shippedStatusCompletionStatus
allowedNot StartedPartially CompletedCompleted
allocatedQuantityinteger
allocatedStatusCompletionStatus
allowedNot StartedPartially CompletedCompleted
acknowledgedQuantityinteger
acknowledgedStatusCompletionStatus
allowedNot StartedPartially CompletedCompleted
rmasarray[Rma]
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]
customFieldsarray[ShipmentCustomField]
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
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.
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
returnTotalnumber
statusReturnStatus
allowedopenclosedcancelled
updatedAtstring (date-time)
insertedAtstring (date-time)
refundAdjustmentnumber
refundSubtotalnumber
sum of refunded_amount for all return_items on the return
refundTotalnumber
refundSubtotal + refundAdjustment
refundLastSyncedAtstring (date-time)
syncRefundChangesToOrderboolean
shipmentReceivedStatusShipmentReceivedStatus
allowednot_receivedpartially_receivedfully_received
Example response
{
  "id": 0,
  "orderId": 0,
  "returnNumber": "string",
  "accountId": 0,
  "totalReturnItems": 0,
  "totalRmas": 0,
  "channelId": 0,
  "items": [
    {
      "id": 0,
      "returnId": 0,
      "orderItemId": 0,
      "sku": "string",
      "returnQuantity": 0,
      "returnReason": "string",
      "returnCondition": "string",
      "salesPrice": 0,
      "title": "string",
      "refundedAmount": 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
        }
      ]
    }
  ],
  "rmas": [
    {
      "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": null,
          "returnItemId": null,
          "rmaId": null,
          "sku": null,
          "title": null,
          "cost": null,
          "returnReason": null,
          "returnCondition": null,
          "note": null,
          "quantity": null,
          "approvedQuantity": null,
          "deniedQuantity": null,
          "creditedAmount": null,
          "receivedQuantity": null,
          "voidedQuantity": null,
          "bundleComponents": null
        }
      ],
      "totalRmaItems": 0,
      "createdAt": "2026-04-20T00:00:00Z",
      "updatedAt": "2026-04-20T00:00:00Z",
      "rmaStatus": "Waiting",
      "rmaShipments": [
        {
          "id": null,
          "rmaId": null,
          "accountId": null,
          "shipment": null,
          "shippingAddress": null,
          "attachments": null,
          "createdAt": null,
          "sentAt": null,
          "rmaShipmentStatus": null
        }
      ],
      "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"
    }
  ],
  "returnTotal": 0,
  "status": "open",
  "updatedAt": "2026-04-20T00:00:00Z",
  "insertedAt": "2026-04-20T00:00:00Z",
  "refundAdjustment": 0,
  "refundSubtotal": 0,
  "refundTotal": 0,
  "refundLastSyncedAt": "2026-04-20T00:00:00Z",
  "syncRefundChangesToOrder": true,
  "shipmentReceivedStatus": "not_received"
}
401Unauthorized

No schema documented for this status.

404Not Found

No schema documented for this status.

OpenAPI fragment
{
  "get": {
    "summary": "Get Return by ID",
    "description": "Retrieves a `Return` by provided id",
    "parameters": [],
    "responses": {
      "200": {
        "description": "OK",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ReturnModel"
            }
          }
        }
      },
      "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