RMA-Order
Get RMA order details
Accesstoken recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a rmaOrderUid
^[A-Za-z0-9-_]+Example response
Update RMA order details
Accesstoken recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a rmaOrderUid
^[A-Za-z0-9-_]+Delete RMA order
Accesstoken recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a rmaOrderUid
^[A-Za-z0-9-_]+Example response
Create new item on a RMA order
Accesstoken recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a rmaOrderUid
^[A-Za-z0-9-_]+Update RMA order item details
Accesstoken recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a rmaOrderUid
^[A-Za-z0-9-_]+Reference to a rmaOrderItemUid
^[A-Za-z0-9-_]+Delete RMA order item
Accesstoken recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a rmaOrderUid
^[A-Za-z0-9-_]+Reference to a rmaOrderItemUid
^[A-Za-z0-9-_]+No Content
Download RMA order
Accesstoken recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a rmaOrderUid
^[A-Za-z0-9-_]+Finalize RMA order. Stock will be adjusted
Accesstoken recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a rmaOrderUid
^[A-Za-z0-9-_]+PDF file
Send RMA order request to supplier by email
Accesstoken recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a rmaOrderUid
^[A-Za-z0-9-_]+Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
Reference to a storeUid
Reference to a supplierUid
Reference to a date
Reference to a date
Example response
Example response
^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+Example response
Example response
Example response
| 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 |
Example response
Example response
Example response
^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+Example response
Example response
^[A-Za-z0-9-_]*Example response
Example response
No Content
No content
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.
Bad Request
PDF file
trueBased 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.
Created
Bad Request
GET /v2/tenants/{tenantUid}/rma-orders HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"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-12-08T22:43:13.787Z",
"lastModifiedAt": "2025-12-08T22:43:13.787Z",
"createdBy": "text",
"lastModifiedBy": "text",
"rmaOrderItemUid": "text"
}
],
"createdAt": "2025-12-08T22:43:13.787Z",
"lastModifiedAt": "2025-12-08T22:43:13.787Z",
"createdBy": "text",
"lastModifiedBy": "text",
"sentToSupplierAt": "text",
"rmaOrderUid": "text"
}{
"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-12-08T22:43:13.787Z",
"lastModifiedAt": "2025-12-08T22:43:13.787Z",
"createdBy": "text",
"lastModifiedBy": "text",
"rmaOrderItemUid": "text"
}
],
"createdAt": "2025-12-08T22:43:13.787Z",
"lastModifiedAt": "2025-12-08T22:43:13.787Z",
"createdBy": "text",
"lastModifiedBy": "text",
"sentToSupplierAt": "text",
"rmaOrderUid": "text"
}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"
}{
"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-12-08T22:43:13.787Z",
"lastModifiedAt": "2025-12-08T22:43:13.787Z",
"createdBy": "text",
"lastModifiedBy": "text",
"rmaOrderItemUid": "text"
}
],
"createdAt": "2025-12-08T22:43:13.787Z",
"lastModifiedAt": "2025-12-08T22:43:13.787Z",
"createdBy": "text",
"lastModifiedBy": "text",
"sentToSupplierAt": "text",
"rmaOrderUid": "text"
}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"
}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"
}POST /v2/tenants/{tenantUid}/rma-orders/{rmaOrderUid}/download HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
binaryPOST /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"
}
]
}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"
}GET /v2/tenants/{tenantUid}/rma-orders/{rmaOrderUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
DELETE /v2/tenants/{tenantUid}/rma-orders/{rmaOrderUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
DELETE /v2/tenants/{tenantUid}/rma-orders/{rmaOrderUid}/items/{rmaOrderItemUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
POST /v2/tenants/{tenantUid}/rma-orders/{rmaOrderUid}/complete HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"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-12-08T22:43:13.787Z",
"lastModifiedAt": "2025-12-08T22:43:13.787Z",
"createdBy": "text",
"lastModifiedBy": "text",
"rmaOrderItemUid": "text"
}
],
"createdAt": "2025-12-08T22:43:13.787Z",
"lastModifiedAt": "2025-12-08T22:43:13.787Z",
"createdBy": "text",
"lastModifiedBy": "text",
"sentToSupplierAt": "text",
"rmaOrderUid": "text"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}{
"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-12-08T22:43:13.787Z",
"lastModifiedAt": "2025-12-08T22:43:13.787Z",
"createdBy": "text",
"lastModifiedBy": "text",
"rmaOrderItemUid": "text"
}
],
"createdAt": "2025-12-08T22:43:13.787Z",
"lastModifiedAt": "2025-12-08T22:43:13.787Z",
"createdBy": "text",
"lastModifiedBy": "text",
"sentToSupplierAt": "text",
"rmaOrderUid": "text"
}{
"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-12-08T22:43:13.787Z",
"lastModifiedAt": "2025-12-08T22:43:13.787Z",
"createdBy": "text",
"lastModifiedBy": "text",
"rmaOrderItemUid": "text"
}
],
"createdAt": "2025-12-08T22:43:13.787Z",
"lastModifiedAt": "2025-12-08T22:43:13.787Z",
"createdBy": "text",
"lastModifiedBy": "text",
"sentToSupplierAt": "text",
"rmaOrderUid": "text"
}{
"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-12-08T22:43:13.787Z",
"lastModifiedAt": "2025-12-08T22:43:13.787Z",
"createdBy": "text",
"lastModifiedBy": "text",
"rmaOrderItemUid": "text"
}
],
"createdAt": "2025-12-08T22:43:13.787Z",
"lastModifiedAt": "2025-12-08T22:43:13.787Z",
"createdBy": "text",
"lastModifiedBy": "text",
"sentToSupplierAt": "text",
"rmaOrderUid": "text"
}{
"content": "text",
"contentType": "text",
"filename": "text"
}{
"content": "text",
"contentType": "text",
"filename": "text"
}