RMA Order | Flow Retail Docs

List all RMA orders for tenant

get

List all RMA orders for tenant

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

Query parameters

pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Possible values:

rmaOrderStoreUidstringOptional

Reference to a storeUid

rmaOrderSupplierUidstringOptional

Reference to a supplierUid

rmaOrderFromDatestring · dateOptional

Reference to a date

rmaOrderToDatestring · dateOptional

Reference to a date

Responses

200

Example response

application/json

get

GET /v2/tenants/{tenantUid}/rma-orders HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "note": "text",
      "storeUid": "text",
      "storeName": "text",
      "supplierUid": "text",
      "supplierName": "text",
      "originalPurchaseNumber": "text",
      "supplierReference": "text",
      "ourReference": "text",
      "reason": "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": "2025-07-30T16:53:44.115Z",
          "lastModifiedAt": "2025-07-30T16:53:44.115Z",
          "createdBy": "text",
          "lastModifiedBy": "text",
          "rmaOrderItemUid": "text"
        }
      ],
      "createdAt": "2025-07-30T16:53:44.115Z",
      "lastModifiedAt": "2025-07-30T16:53:44.115Z",
      "createdBy": "text",
      "lastModifiedBy": "text",
      "sentToSupplierAt": "text",
      "rmaOrderUid": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create new RMA order

post

Create new RMA request

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

Body

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

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

notestringOptional

originalPurchaseNumberstringOptional

supplierReferencestringOptional

ourReferencestringOptional

reasonstringOptional

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

Responses

201

Example response

application/json

post

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

{
  "storeUid": "text",
  "supplierUid": "text",
  "note": "text",
  "originalPurchaseNumber": "text",
  "supplierReference": "text",
  "ourReference": "text",
  "reason": "text",
  "rmaOrderUid": "text"
}

201

Example response

{
  "note": "text",
  "storeUid": "text",
  "storeName": "text",
  "supplierUid": "text",
  "supplierName": "text",
  "originalPurchaseNumber": "text",
  "supplierReference": "text",
  "ourReference": "text",
  "reason": "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": "2025-07-30T16:53:44.115Z",
      "lastModifiedAt": "2025-07-30T16:53:44.115Z",
      "createdBy": "text",
      "lastModifiedBy": "text",
      "rmaOrderItemUid": "text"
    }
  ],
  "createdAt": "2025-07-30T16:53:44.115Z",
  "lastModifiedAt": "2025-07-30T16:53:44.115Z",
  "createdBy": "text",
  "lastModifiedBy": "text",
  "sentToSupplierAt": "text",
  "rmaOrderUid": "text"
}

Get RMA order details

get

Get RMA order details

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

rmaOrderUidstringRequired

Reference to a rmaOrderUid

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

Responses

200

Example response

application/json

get

GET /v2/tenants/{tenantUid}/rma-orders/{rmaOrderUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "note": "text",
  "storeUid": "text",
  "storeName": "text",
  "supplierUid": "text",
  "supplierName": "text",
  "originalPurchaseNumber": "text",
  "supplierReference": "text",
  "ourReference": "text",
  "reason": "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": "2025-07-30T16:53:44.115Z",
      "lastModifiedAt": "2025-07-30T16:53:44.115Z",
      "createdBy": "text",
      "lastModifiedBy": "text",
      "rmaOrderItemUid": "text"
    }
  ],
  "createdAt": "2025-07-30T16:53:44.115Z",
  "lastModifiedAt": "2025-07-30T16:53:44.115Z",
  "createdBy": "text",
  "lastModifiedBy": "text",
  "sentToSupplierAt": "text",
  "rmaOrderUid": "text"
}

Update RMA order details

put

Update RMA order details

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

rmaOrderUidstringRequired

Reference to a rmaOrderUid

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

Body

notestringOptional

originalPurchaseNumberstringOptional

supplierReferencestringOptional

ourReferencestringOptional

reasonstringOptional

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

put

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: 127

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

200

Example response

{
  "note": "text",
  "storeUid": "text",
  "storeName": "text",
  "supplierUid": "text",
  "supplierName": "text",
  "originalPurchaseNumber": "text",
  "supplierReference": "text",
  "ourReference": "text",
  "reason": "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": "2025-07-30T16:53:44.115Z",
      "lastModifiedAt": "2025-07-30T16:53:44.115Z",
      "createdBy": "text",
      "lastModifiedBy": "text",
      "rmaOrderItemUid": "text"
    }
  ],
  "createdAt": "2025-07-30T16:53:44.115Z",
  "lastModifiedAt": "2025-07-30T16:53:44.115Z",
  "createdBy": "text",
  "lastModifiedBy": "text",
  "sentToSupplierAt": "text",
  "rmaOrderUid": "text"
}

Delete RMA order

delete

Delete RMA order

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

rmaOrderUidstringRequired

Reference to a rmaOrderUid

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

Responses

204

Example response

application/json

delete

DELETE /v2/tenants/{tenantUid}/rma-orders/{rmaOrderUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

Example response

{
  "note": "text",
  "storeUid": "text",
  "storeName": "text",
  "supplierUid": "text",
  "supplierName": "text",
  "originalPurchaseNumber": "text",
  "supplierReference": "text",
  "ourReference": "text",
  "reason": "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": "2025-07-30T16:53:44.115Z",
      "lastModifiedAt": "2025-07-30T16:53:44.115Z",
      "createdBy": "text",
      "lastModifiedBy": "text",
      "rmaOrderItemUid": "text"
    }
  ],
  "createdAt": "2025-07-30T16:53:44.115Z",
  "lastModifiedAt": "2025-07-30T16:53:44.115Z",
  "createdBy": "text",
  "lastModifiedBy": "text",
  "sentToSupplierAt": "text",
  "rmaOrderUid": "text"
}

Create new item on a RMA order

post

Create new item on a RMA order

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

rmaOrderUidstringRequired

Reference to a rmaOrderUid

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

Body

requestedQuantityintegerRequired

requestedUnitPriceintegerRequired

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

serialNumberstringOptional

notestringOptional

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

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

Responses

201

Example response

application/json

post

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

{
  "requestedQuantity": 1,
  "requestedUnitPrice": 1,
  "productUid": "text",
  "serialNumber": "text",
  "note": "text",
  "warehouseUid": "text",
  "rmaOrderItemUid": "text"
}

201

Example response

{
  "note": "text",
  "storeUid": "text",
  "storeName": "text",
  "supplierUid": "text",
  "supplierName": "text",
  "originalPurchaseNumber": "text",
  "supplierReference": "text",
  "ourReference": "text",
  "reason": "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": "2025-07-30T16:53:44.115Z",
      "lastModifiedAt": "2025-07-30T16:53:44.115Z",
      "createdBy": "text",
      "lastModifiedBy": "text",
      "rmaOrderItemUid": "text"
    }
  ],
  "createdAt": "2025-07-30T16:53:44.115Z",
  "lastModifiedAt": "2025-07-30T16:53:44.115Z",
  "createdBy": "text",
  "lastModifiedBy": "text",
  "sentToSupplierAt": "text",
  "rmaOrderUid": "text"
}

Update RMA order item details

put

Update RMA order item details

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

rmaOrderUidstringRequired

Reference to a rmaOrderUid

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

rmaOrderItemUidstringRequired

Reference to a rmaOrderItemUid

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

Body

requestedQuantityintegerOptional

requestedUnitPriceintegerOptional

serialNumberstringOptional

notestringOptional

warehouseUidstringOptionalPattern: ^[A-Za-z0-9-_]*

Responses

201

Example response

application/json

put

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

{
  "requestedQuantity": 1,
  "requestedUnitPrice": 1,
  "serialNumber": "text",
  "note": "text",
  "warehouseUid": "text"
}

201

Example response

{
  "note": "text",
  "storeUid": "text",
  "storeName": "text",
  "supplierUid": "text",
  "supplierName": "text",
  "originalPurchaseNumber": "text",
  "supplierReference": "text",
  "ourReference": "text",
  "reason": "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": "2025-07-30T16:53:44.115Z",
      "lastModifiedAt": "2025-07-30T16:53:44.115Z",
      "createdBy": "text",
      "lastModifiedBy": "text",
      "rmaOrderItemUid": "text"
    }
  ],
  "createdAt": "2025-07-30T16:53:44.115Z",
  "lastModifiedAt": "2025-07-30T16:53:44.115Z",
  "createdBy": "text",
  "lastModifiedBy": "text",
  "sentToSupplierAt": "text",
  "rmaOrderUid": "text"
}

Delete RMA order item

delete

Delete RMA order item

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

rmaOrderUidstringRequired

Reference to a rmaOrderUid

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

rmaOrderItemUidstringRequired

Reference to a rmaOrderItemUid

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

Responses

204

No Content

delete

DELETE /v2/tenants/{tenantUid}/rma-orders/{rmaOrderUid}/items/{rmaOrderItemUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content

download RMA order

post

Download RMA order

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

rmaOrderUidstringRequired

Reference to a rmaOrderUid

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

Responses

200

Based on the Accept header the response will be base64 json encoded or a raw file. application/octet-stream will return a binary file application/json will return a json with the file content base64 encoded.

400

Bad Request

post

POST /v2/tenants/{tenantUid}/rma-orders/{rmaOrderUid}/download HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "content": "text",
  "contentType": "text",
  "filename": "text"
}

Finalize RMA order. Stock will be adjusted

post

Finalize RMA order. Stock will be adjusted

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

rmaOrderUidstringRequired

Reference to a rmaOrderUid

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

Responses

200

PDF file

application/pdf

Responsestring · binary

post

POST /v2/tenants/{tenantUid}/rma-orders/{rmaOrderUid}/complete HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

PDF file

binary

Send email to supplier

post

Send RMA order request to supplier by email

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

rmaOrderUidstringRequired

Reference to a rmaOrderUid

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

Body

recepientsstring[]Required

subjectstringOptional

bodystringOptional

includePDFbooleanOptionalDefault: true

Responses

200

Based on the Accept header the response will be base64 json encoded or a raw file. application/octet-stream will return a binary file application/json will return a json with the file content base64 encoded.

201

Created

400

Bad Request

post

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

{
  "recepients": [
    "text"
  ],
  "subject": "text",
  "body": "text",
  "includePDF": true,
  "attachments": [
    {
      "content": "text",
      "contentType": "text",
      "filename": "text"
    }
  ]
}

{
  "content": "text",
  "contentType": "text",
  "filename": "text"
}