RMA — Returns (parallel flow)

RMA manages returns of components or equipment to the supplier, optionally linked to a service order.

Own catalogues (once)

POST /gateway/return-type
Content-Type: application/json
Authorization: Bearer {token}

{
  "description": "Warranty"
}

POST /gateway/return-reason
Content-Type: application/json
Authorization: Bearer {token}

{
  "description": "Manufacturing defect"
}

Create the RMA

POST /gateway/rma
Content-Type: application/json
Authorization: Bearer {token}

{
  "rmaId": "RMA-2026-001",
  "rmaType": 1,
  "equipmentId": 123,
  "quantity": 1,
  "date": "2026-08-12T00:00:00Z",
  "returnType": "Warranty",
  "returnReason": "Manufacturing defect",
  "warrantyValid": true,
  "itemNotModified": true,
  "serviceOrderGuid": "ORDER-GUID",
  "supplierKey": "F0010"
}

Required: rmaId (business identifier).

Conditional rules:

• rmaType 1 = Equipment → requires equipmentId
• Component type → requires componentKeyId
• returnType / returnReason, when sent, must exist in the catalogues

CRUD and listing

Operation	Endpoint
Detail / update / delete	GET|PUT|DELETE /gateway/rma/{guid}
Listing	GET /gateway/rma
Next id	GET /gateway/rma/next-id

See also

How to link an RMA to a service order (and the risks of each option): overview — link RMA.

Common errors.