Update RMA order details

Setting status to COMPLETE here only closes the RMA order without adjusting stock.

Required permissions: RMA_ORDER

put

/tenants/{tenantUid}/rma-orders/{rmaOrderUid}

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

rmaOrderUidstringRequired

Reference to a rmaOrderUid

Pattern: ^[A-Za-z0-9-_]+

Body

notestringOptional

supplierReferencestringOptional

ourReferencestringOptional

reasonstringOptional

referencestringOptional

statusstring · enumOptional

ENUM	Description
NEW	RMA Order is created
WAITING_FOR_APPROVAL	RMA Order request is sent to supplier and awaiting approval
DECLINED_BY_SUPPLIER	RMA Order request have been declined by supplier
SENT_TO_SUPPLIER	Items have been physically sent back to supplier

Possible values:

Responses

200

Example response

application/json

notestringRequired

storeUidstringRequiredPattern: ^[A-Za-z0-9-_]+

storeNamestringRequired

supplierUidstringRequiredPattern: ^[A-Za-z0-9-_]+

supplierNamestringRequired

supplierReferencestringRequired

ourReferencestringRequired

reasonstringRequired

referencestringOptional

statusstring · enumRequired

ENUM	Description
NEW	RMA Order is created
WAITING_FOR_APPROVAL	RMA Order request is sent to supplier and awaiting approval
DECLINED_BY_SUPPLIER	RMA Order request have been declined by supplier
SENT_TO_SUPPLIER	Items have been physically sent back to supplier
COMPLETE	Item stock has been adjusted

Possible values:

rmaNumberstringRequired

createdAtstring · date-timeRequired

lastModifiedAtstring · date-timeRequired

createdBystringRequired

lastModifiedBystringRequired

sentToSupplierAtstring · nullableRequired

rmaOrderUidstringRequiredPattern: ^[A-Za-z0-9-_]+

put/tenants/{tenantUid}/rma-orders/{rmaOrderUid}

PUT /v2/tenants/{tenantUid}/rma-orders/{rmaOrderUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 114

{
  "note": "text",
  "supplierReference": "text",
  "ourReference": "text",
  "reason": "text",
  "reference": "text",
  "status": "NEW"
}

200

Example response

{
  "note": "text",
  "storeUid": "text",
  "storeName": "text",
  "supplierUid": "text",
  "supplierName": "text",
  "supplierReference": "text",
  "ourReference": "text",
  "reason": "text",
  "reference": "text",
  "status": "NEW",
  "rmaNumber": "text",
  "items": [
    {
      "requestedQuantity": 1,
      "productUid": "text",
      "sku": "text",
      "name": "text",
      "supplierSku": "text",
      "serialNumber": "text",
      "requestedUnitPrice": 1,
      "requestedLinePrice": 1,
      "note": "text",
      "warehouseUid": "text",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "lastModifiedAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "text",
      "lastModifiedBy": "text",
      "rmaOrderItemUid": "text",
      "serviceOrderUid": "text",
      "customerUid": "text",
      "customerName": "text",
      "originalPurchaseNumber": "text",
      "supplierReferenceNumber": "text"
    }
  ],
  "createdAt": "2026-01-01T00:00:00.000Z",
  "lastModifiedAt": "2026-01-01T00:00:00.000Z",
  "createdBy": "text",
  "lastModifiedBy": "text",
  "sentToSupplierAt": "text",
  "rmaOrderUid": "text"
}