> For the complete documentation index, see [llms.txt](https://docs.flowretail.com/api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flowretail.com/api/rma-order.md).

# RMA Order

RMA-Order

## List all RMA orders for tenant

> List all RMA orders for tenant\
> \
> Required permissions: RMA\_ORDER

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"RMA-Order","description":"RMA-Order"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"responses":{"RMAOrderListResponse":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","required":["items","paging"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/RMAOrderResponseSchema"}},"paging":{"$ref":"#/components/schemas/Paging"}}}}}}},"schemas":{"RMAOrderResponseSchema":{"title":"RMAOrderResponseSchema","type":"object","required":["note","storeUid","storeName","supplierUid","supplierName","supplierReference","ourReference","reason","status","rmaNumber","items","createdAt","lastModifiedAt","createdBy","lastModifiedBy","sentToSupplierAt","rmaOrderUid"],"properties":{"note":{"type":"string"},"storeUid":{"$ref":"#/components/schemas/UID"},"storeName":{"type":"string"},"supplierUid":{"$ref":"#/components/schemas/UID"},"supplierName":{"type":"string"},"originalPurchaseNumber":{"type":"string","deprecated":true},"supplierReference":{"type":"string"},"ourReference":{"type":"string"},"reason":{"type":"string"},"status":{"$ref":"#/components/schemas/RMAOrderStatusResponseENUM"},"rmaNumber":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/RMAOrderItemResponseSchema"}},"createdAt":{"type":"string","format":"date-time"},"lastModifiedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedBy":{"type":"string"},"sentToSupplierAt":{"type":"string","nullable":true},"rmaOrderUid":{"$ref":"#/components/schemas/UID"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"RMAOrderStatusResponseENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| NEW | RMA Order is created |\n| WAITING_FOR_APPROVAL | RMA Order request is sent to supplier and awaiting approval|\n| DECLINED_BY_SUPPLIER | RMA Order request have been declined by supplier|\n| SENT_TO_SUPPLIER | Items have been physically sent back to supplier|\n| COMPLETE | Item stock has been adjusted |","enum":["NEW","WAITING_FOR_APPROVAL","DECLINED_BY_SUPPLIER","SENT_TO_SUPPLIER","COMPLETE"],"title":"RMAOrderStatusResponseENUM","type":"string"},"RMAOrderItemResponseSchema":{"title":"RMAOrderItemResponseSchema","type":"object","required":["requestedQuantity","productUid","sku","name","supplierSku","serialNumber","requestedUnitPrice","requestedLinePrice","note","warehouseUid","createdAt","lastModifiedAt","createdBy","lastModifiedBy","rmaOrderItemUid","serviceOrderUid","originalPurchaseNumber","supplierReferenceNumber"],"properties":{"requestedQuantity":{"type":"integer"},"productUid":{"$ref":"#/components/schemas/UID"},"sku":{"type":"string"},"name":{"type":"string"},"supplierSku":{"type":"string"},"serialNumber":{"type":"string"},"requestedUnitPrice":{"type":"integer"},"requestedLinePrice":{"type":"integer"},"note":{"type":"string"},"warehouseUid":{"$ref":"#/components/schemas/OptionalUID"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedBy":{"type":"string"},"rmaOrderItemUid":{"$ref":"#/components/schemas/UID"},"serviceOrderUid":{"$ref":"#/components/schemas/OptionalUID"},"originalPurchaseNumber":{"type":"string"},"supplierReferenceNumber":{"type":"string","description":"from the original purchase order"}}},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"},"Paging":{"description":"totalCount The total number of items in the result set.\n\npageSize The number of items per page.\n\npageNumber The current page in the result set.","properties":{"pageNumber":{"type":"integer"},"pageSize":{"type":"integer"},"totalCount":{"type":"integer"}},"required":["totalCount","pageSize","pageNumber"],"title":"Paging","type":"object"},"SortDirectionENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| ASC | Sort in ascending order|\n| DESC | Sort in descending order|\n","enum":["ASC","DESC"],"title":"SortDirectionENUM","type":"string"}},"parameters":{"pageNumberQuery":{"description":"Reference to a specific page in a result set.","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer"}},"pageSizeQuery":{"description":"The number of items per page in a result set.","in":"query","name":"pageSize","required":false,"schema":{"type":"integer"}},"sortByQuery":{"description":"Defines which field the resource list is sorted by.","in":"query","name":"sortBy","required":false,"schema":{"type":"string"}},"sortDirectionQuery":{"description":"Reference to a sort direction","explode":false,"in":"query","name":"sortDirection","schema":{"$ref":"#/components/schemas/SortDirectionENUM"},"style":"form"},"rmaOrderStoreUidQuery":{"name":"rmaOrderStoreUid","in":"query","required":false,"schema":{"type":"string"},"description":"Reference to a storeUid"},"rmaOrderSupplierUidQuery":{"name":"rmaOrderSupplierUid","in":"query","required":false,"schema":{"type":"string"},"description":"Reference to a supplierUid"},"rmaOrderFromDateQuery":{"name":"rmaOrderFromDate","in":"query","required":false,"schema":{"type":"string","format":"date"},"description":"Reference to a date"},"rmaOrderToDateQuery":{"name":"rmaOrderToDate","in":"query","required":false,"schema":{"type":"string","format":"date"},"description":"Reference to a date"}}},"paths":{"/tenants/{tenantUid}/rma-orders":{"get":{"summary":"List all RMA orders for tenant","tags":["RMA-Order"],"responses":{"200":{"$ref":"#/components/responses/RMAOrderListResponse"}},"operationId":"list-rma-orders","description":"List all RMA orders for tenant\n\nRequired permissions: RMA_ORDER","parameters":[{"$ref":"#/components/parameters/pageNumberQuery"},{"$ref":"#/components/parameters/pageSizeQuery"},{"$ref":"#/components/parameters/sortByQuery"},{"$ref":"#/components/parameters/sortDirectionQuery"},{"$ref":"#/components/parameters/rmaOrderStoreUidQuery"},{"$ref":"#/components/parameters/rmaOrderSupplierUidQuery"},{"$ref":"#/components/parameters/rmaOrderFromDateQuery"},{"$ref":"#/components/parameters/rmaOrderToDateQuery"}]}}}}
```

## Create new RMA order

> Create new RMA request\
> \
> Required permissions: RMA\_ORDER

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"RMA-Order","description":"RMA-Order"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"responses":{"RMAOrderResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMAOrderResponseSchema"}}}}},"schemas":{"RMAOrderResponseSchema":{"title":"RMAOrderResponseSchema","type":"object","required":["note","storeUid","storeName","supplierUid","supplierName","supplierReference","ourReference","reason","status","rmaNumber","items","createdAt","lastModifiedAt","createdBy","lastModifiedBy","sentToSupplierAt","rmaOrderUid"],"properties":{"note":{"type":"string"},"storeUid":{"$ref":"#/components/schemas/UID"},"storeName":{"type":"string"},"supplierUid":{"$ref":"#/components/schemas/UID"},"supplierName":{"type":"string"},"originalPurchaseNumber":{"type":"string","deprecated":true},"supplierReference":{"type":"string"},"ourReference":{"type":"string"},"reason":{"type":"string"},"status":{"$ref":"#/components/schemas/RMAOrderStatusResponseENUM"},"rmaNumber":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/RMAOrderItemResponseSchema"}},"createdAt":{"type":"string","format":"date-time"},"lastModifiedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedBy":{"type":"string"},"sentToSupplierAt":{"type":"string","nullable":true},"rmaOrderUid":{"$ref":"#/components/schemas/UID"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"RMAOrderStatusResponseENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| NEW | RMA Order is created |\n| WAITING_FOR_APPROVAL | RMA Order request is sent to supplier and awaiting approval|\n| DECLINED_BY_SUPPLIER | RMA Order request have been declined by supplier|\n| SENT_TO_SUPPLIER | Items have been physically sent back to supplier|\n| COMPLETE | Item stock has been adjusted |","enum":["NEW","WAITING_FOR_APPROVAL","DECLINED_BY_SUPPLIER","SENT_TO_SUPPLIER","COMPLETE"],"title":"RMAOrderStatusResponseENUM","type":"string"},"RMAOrderItemResponseSchema":{"title":"RMAOrderItemResponseSchema","type":"object","required":["requestedQuantity","productUid","sku","name","supplierSku","serialNumber","requestedUnitPrice","requestedLinePrice","note","warehouseUid","createdAt","lastModifiedAt","createdBy","lastModifiedBy","rmaOrderItemUid","serviceOrderUid","originalPurchaseNumber","supplierReferenceNumber"],"properties":{"requestedQuantity":{"type":"integer"},"productUid":{"$ref":"#/components/schemas/UID"},"sku":{"type":"string"},"name":{"type":"string"},"supplierSku":{"type":"string"},"serialNumber":{"type":"string"},"requestedUnitPrice":{"type":"integer"},"requestedLinePrice":{"type":"integer"},"note":{"type":"string"},"warehouseUid":{"$ref":"#/components/schemas/OptionalUID"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedBy":{"type":"string"},"rmaOrderItemUid":{"$ref":"#/components/schemas/UID"},"serviceOrderUid":{"$ref":"#/components/schemas/OptionalUID"},"originalPurchaseNumber":{"type":"string"},"supplierReferenceNumber":{"type":"string","description":"from the original purchase order"}}},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"},"RMAOrderCreateRequestSchema":{"title":"RMAOrderCreateRequestSchema","type":"object","required":["storeUid","supplierUid"],"properties":{"storeUid":{"$ref":"#/components/schemas/UID"},"supplierUid":{"$ref":"#/components/schemas/UID"},"note":{"type":"string"},"supplierReference":{"type":"string"},"ourReference":{"type":"string"},"reason":{"type":"string"},"rmaOrderUid":{"$ref":"#/components/schemas/UID"}}}},"requestBodies":{"RMAOrderCreateRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMAOrderCreateRequestSchema"}}}}}},"paths":{"/tenants/{tenantUid}/rma-orders":{"post":{"summary":"Create new RMA order","tags":["RMA-Order"],"responses":{"201":{"$ref":"#/components/responses/RMAOrderResponse"}},"operationId":"create-rma-order","description":"Create new RMA request\n\nRequired permissions: RMA_ORDER","requestBody":{"$ref":"#/components/requestBodies/RMAOrderCreateRequest"}}}}}
```

## Get RMA order details

> Get RMA order details\
> \
> Required permissions: RMA\_ORDER

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"RMA-Order","description":"RMA-Order"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"responses":{"RMAOrderResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMAOrderResponseSchema"}}}}},"schemas":{"RMAOrderResponseSchema":{"title":"RMAOrderResponseSchema","type":"object","required":["note","storeUid","storeName","supplierUid","supplierName","supplierReference","ourReference","reason","status","rmaNumber","items","createdAt","lastModifiedAt","createdBy","lastModifiedBy","sentToSupplierAt","rmaOrderUid"],"properties":{"note":{"type":"string"},"storeUid":{"$ref":"#/components/schemas/UID"},"storeName":{"type":"string"},"supplierUid":{"$ref":"#/components/schemas/UID"},"supplierName":{"type":"string"},"originalPurchaseNumber":{"type":"string","deprecated":true},"supplierReference":{"type":"string"},"ourReference":{"type":"string"},"reason":{"type":"string"},"status":{"$ref":"#/components/schemas/RMAOrderStatusResponseENUM"},"rmaNumber":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/RMAOrderItemResponseSchema"}},"createdAt":{"type":"string","format":"date-time"},"lastModifiedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedBy":{"type":"string"},"sentToSupplierAt":{"type":"string","nullable":true},"rmaOrderUid":{"$ref":"#/components/schemas/UID"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"RMAOrderStatusResponseENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| NEW | RMA Order is created |\n| WAITING_FOR_APPROVAL | RMA Order request is sent to supplier and awaiting approval|\n| DECLINED_BY_SUPPLIER | RMA Order request have been declined by supplier|\n| SENT_TO_SUPPLIER | Items have been physically sent back to supplier|\n| COMPLETE | Item stock has been adjusted |","enum":["NEW","WAITING_FOR_APPROVAL","DECLINED_BY_SUPPLIER","SENT_TO_SUPPLIER","COMPLETE"],"title":"RMAOrderStatusResponseENUM","type":"string"},"RMAOrderItemResponseSchema":{"title":"RMAOrderItemResponseSchema","type":"object","required":["requestedQuantity","productUid","sku","name","supplierSku","serialNumber","requestedUnitPrice","requestedLinePrice","note","warehouseUid","createdAt","lastModifiedAt","createdBy","lastModifiedBy","rmaOrderItemUid","serviceOrderUid","originalPurchaseNumber","supplierReferenceNumber"],"properties":{"requestedQuantity":{"type":"integer"},"productUid":{"$ref":"#/components/schemas/UID"},"sku":{"type":"string"},"name":{"type":"string"},"supplierSku":{"type":"string"},"serialNumber":{"type":"string"},"requestedUnitPrice":{"type":"integer"},"requestedLinePrice":{"type":"integer"},"note":{"type":"string"},"warehouseUid":{"$ref":"#/components/schemas/OptionalUID"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedBy":{"type":"string"},"rmaOrderItemUid":{"$ref":"#/components/schemas/UID"},"serviceOrderUid":{"$ref":"#/components/schemas/OptionalUID"},"originalPurchaseNumber":{"type":"string"},"supplierReferenceNumber":{"type":"string","description":"from the original purchase order"}}},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"}}},"paths":{"/tenants/{tenantUid}/rma-orders/{rmaOrderUid}":{"get":{"summary":"Get RMA order details","tags":["RMA-Order"],"responses":{"200":{"$ref":"#/components/responses/RMAOrderResponse"}},"operationId":"get-rma-order-details","description":"Get RMA order details\n\nRequired permissions: RMA_ORDER"}}}}
```

## Update RMA order details

> Setting \`status\` to \`COMPLETE\` here only closes the RMA order without adjusting stock.\
> \
> Required permissions: RMA\_ORDER

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"RMA-Order","description":"RMA-Order"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"responses":{"RMAOrderResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMAOrderResponseSchema"}}}}},"schemas":{"RMAOrderResponseSchema":{"title":"RMAOrderResponseSchema","type":"object","required":["note","storeUid","storeName","supplierUid","supplierName","supplierReference","ourReference","reason","status","rmaNumber","items","createdAt","lastModifiedAt","createdBy","lastModifiedBy","sentToSupplierAt","rmaOrderUid"],"properties":{"note":{"type":"string"},"storeUid":{"$ref":"#/components/schemas/UID"},"storeName":{"type":"string"},"supplierUid":{"$ref":"#/components/schemas/UID"},"supplierName":{"type":"string"},"originalPurchaseNumber":{"type":"string","deprecated":true},"supplierReference":{"type":"string"},"ourReference":{"type":"string"},"reason":{"type":"string"},"status":{"$ref":"#/components/schemas/RMAOrderStatusResponseENUM"},"rmaNumber":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/RMAOrderItemResponseSchema"}},"createdAt":{"type":"string","format":"date-time"},"lastModifiedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedBy":{"type":"string"},"sentToSupplierAt":{"type":"string","nullable":true},"rmaOrderUid":{"$ref":"#/components/schemas/UID"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"RMAOrderStatusResponseENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| NEW | RMA Order is created |\n| WAITING_FOR_APPROVAL | RMA Order request is sent to supplier and awaiting approval|\n| DECLINED_BY_SUPPLIER | RMA Order request have been declined by supplier|\n| SENT_TO_SUPPLIER | Items have been physically sent back to supplier|\n| COMPLETE | Item stock has been adjusted |","enum":["NEW","WAITING_FOR_APPROVAL","DECLINED_BY_SUPPLIER","SENT_TO_SUPPLIER","COMPLETE"],"title":"RMAOrderStatusResponseENUM","type":"string"},"RMAOrderItemResponseSchema":{"title":"RMAOrderItemResponseSchema","type":"object","required":["requestedQuantity","productUid","sku","name","supplierSku","serialNumber","requestedUnitPrice","requestedLinePrice","note","warehouseUid","createdAt","lastModifiedAt","createdBy","lastModifiedBy","rmaOrderItemUid","serviceOrderUid","originalPurchaseNumber","supplierReferenceNumber"],"properties":{"requestedQuantity":{"type":"integer"},"productUid":{"$ref":"#/components/schemas/UID"},"sku":{"type":"string"},"name":{"type":"string"},"supplierSku":{"type":"string"},"serialNumber":{"type":"string"},"requestedUnitPrice":{"type":"integer"},"requestedLinePrice":{"type":"integer"},"note":{"type":"string"},"warehouseUid":{"$ref":"#/components/schemas/OptionalUID"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedBy":{"type":"string"},"rmaOrderItemUid":{"$ref":"#/components/schemas/UID"},"serviceOrderUid":{"$ref":"#/components/schemas/OptionalUID"},"originalPurchaseNumber":{"type":"string"},"supplierReferenceNumber":{"type":"string","description":"from the original purchase order"}}},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"},"RMAOrderUpdateRequestSchema":{"title":"RMAOrderUpdateRequestSchema","type":"object","properties":{"note":{"type":"string"},"supplierReference":{"type":"string"},"ourReference":{"type":"string"},"reason":{"type":"string"},"status":{"$ref":"#/components/schemas/RMAOrderStatusRequestENUM"}}},"RMAOrderStatusRequestENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| NEW | RMA Order is created |\n| WAITING_FOR_APPROVAL | RMA Order request is sent to supplier and awaiting approval|\n| DECLINED_BY_SUPPLIER | RMA Order request have been declined by supplier|\n| SENT_TO_SUPPLIER | Items have been physically sent back to supplier|","enum":["NEW","WAITING_FOR_APPROVAL","DECLINED_BY_SUPPLIER","SENT_TO_SUPPLIER","COMPLETE"],"title":"RMAOrderStatusRequestENUM","type":"string"}},"requestBodies":{"RMAOrderUpdateRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMAOrderUpdateRequestSchema"}}}}}},"paths":{"/tenants/{tenantUid}/rma-orders/{rmaOrderUid}":{"put":{"summary":"Update RMA order details","tags":["RMA-Order"],"responses":{"200":{"$ref":"#/components/responses/RMAOrderResponse"}},"operationId":"update-rma-order-details","description":"Setting `status` to `COMPLETE` here only closes the RMA order without adjusting stock.\n\nRequired permissions: RMA_ORDER","requestBody":{"$ref":"#/components/requestBodies/RMAOrderUpdateRequest"}}}}}
```

## Delete RMA order

> Delete RMA order\
> \
> Required permissions: RMA\_ORDER

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"RMA-Order","description":"RMA-Order"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"responses":{"RMAOrderResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMAOrderResponseSchema"}}}}},"schemas":{"RMAOrderResponseSchema":{"title":"RMAOrderResponseSchema","type":"object","required":["note","storeUid","storeName","supplierUid","supplierName","supplierReference","ourReference","reason","status","rmaNumber","items","createdAt","lastModifiedAt","createdBy","lastModifiedBy","sentToSupplierAt","rmaOrderUid"],"properties":{"note":{"type":"string"},"storeUid":{"$ref":"#/components/schemas/UID"},"storeName":{"type":"string"},"supplierUid":{"$ref":"#/components/schemas/UID"},"supplierName":{"type":"string"},"originalPurchaseNumber":{"type":"string","deprecated":true},"supplierReference":{"type":"string"},"ourReference":{"type":"string"},"reason":{"type":"string"},"status":{"$ref":"#/components/schemas/RMAOrderStatusResponseENUM"},"rmaNumber":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/RMAOrderItemResponseSchema"}},"createdAt":{"type":"string","format":"date-time"},"lastModifiedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedBy":{"type":"string"},"sentToSupplierAt":{"type":"string","nullable":true},"rmaOrderUid":{"$ref":"#/components/schemas/UID"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"RMAOrderStatusResponseENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| NEW | RMA Order is created |\n| WAITING_FOR_APPROVAL | RMA Order request is sent to supplier and awaiting approval|\n| DECLINED_BY_SUPPLIER | RMA Order request have been declined by supplier|\n| SENT_TO_SUPPLIER | Items have been physically sent back to supplier|\n| COMPLETE | Item stock has been adjusted |","enum":["NEW","WAITING_FOR_APPROVAL","DECLINED_BY_SUPPLIER","SENT_TO_SUPPLIER","COMPLETE"],"title":"RMAOrderStatusResponseENUM","type":"string"},"RMAOrderItemResponseSchema":{"title":"RMAOrderItemResponseSchema","type":"object","required":["requestedQuantity","productUid","sku","name","supplierSku","serialNumber","requestedUnitPrice","requestedLinePrice","note","warehouseUid","createdAt","lastModifiedAt","createdBy","lastModifiedBy","rmaOrderItemUid","serviceOrderUid","originalPurchaseNumber","supplierReferenceNumber"],"properties":{"requestedQuantity":{"type":"integer"},"productUid":{"$ref":"#/components/schemas/UID"},"sku":{"type":"string"},"name":{"type":"string"},"supplierSku":{"type":"string"},"serialNumber":{"type":"string"},"requestedUnitPrice":{"type":"integer"},"requestedLinePrice":{"type":"integer"},"note":{"type":"string"},"warehouseUid":{"$ref":"#/components/schemas/OptionalUID"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedBy":{"type":"string"},"rmaOrderItemUid":{"$ref":"#/components/schemas/UID"},"serviceOrderUid":{"$ref":"#/components/schemas/OptionalUID"},"originalPurchaseNumber":{"type":"string"},"supplierReferenceNumber":{"type":"string","description":"from the original purchase order"}}},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"}}},"paths":{"/tenants/{tenantUid}/rma-orders/{rmaOrderUid}":{"delete":{"summary":"Delete RMA order","tags":["RMA-Order"],"responses":{"204":{"$ref":"#/components/responses/RMAOrderResponse"}},"operationId":"delete-rma-order","description":"Delete RMA order\n\nRequired permissions: RMA_ORDER"}}}}
```

## Create new item on a RMA order

> Create new item on a RMA order\
> \
> Required permissions: RMA\_ORDER

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"RMA-Order","description":"RMA-Order"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"responses":{"RMAOrderResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMAOrderResponseSchema"}}}}},"schemas":{"RMAOrderResponseSchema":{"title":"RMAOrderResponseSchema","type":"object","required":["note","storeUid","storeName","supplierUid","supplierName","supplierReference","ourReference","reason","status","rmaNumber","items","createdAt","lastModifiedAt","createdBy","lastModifiedBy","sentToSupplierAt","rmaOrderUid"],"properties":{"note":{"type":"string"},"storeUid":{"$ref":"#/components/schemas/UID"},"storeName":{"type":"string"},"supplierUid":{"$ref":"#/components/schemas/UID"},"supplierName":{"type":"string"},"originalPurchaseNumber":{"type":"string","deprecated":true},"supplierReference":{"type":"string"},"ourReference":{"type":"string"},"reason":{"type":"string"},"status":{"$ref":"#/components/schemas/RMAOrderStatusResponseENUM"},"rmaNumber":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/RMAOrderItemResponseSchema"}},"createdAt":{"type":"string","format":"date-time"},"lastModifiedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedBy":{"type":"string"},"sentToSupplierAt":{"type":"string","nullable":true},"rmaOrderUid":{"$ref":"#/components/schemas/UID"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"RMAOrderStatusResponseENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| NEW | RMA Order is created |\n| WAITING_FOR_APPROVAL | RMA Order request is sent to supplier and awaiting approval|\n| DECLINED_BY_SUPPLIER | RMA Order request have been declined by supplier|\n| SENT_TO_SUPPLIER | Items have been physically sent back to supplier|\n| COMPLETE | Item stock has been adjusted |","enum":["NEW","WAITING_FOR_APPROVAL","DECLINED_BY_SUPPLIER","SENT_TO_SUPPLIER","COMPLETE"],"title":"RMAOrderStatusResponseENUM","type":"string"},"RMAOrderItemResponseSchema":{"title":"RMAOrderItemResponseSchema","type":"object","required":["requestedQuantity","productUid","sku","name","supplierSku","serialNumber","requestedUnitPrice","requestedLinePrice","note","warehouseUid","createdAt","lastModifiedAt","createdBy","lastModifiedBy","rmaOrderItemUid","serviceOrderUid","originalPurchaseNumber","supplierReferenceNumber"],"properties":{"requestedQuantity":{"type":"integer"},"productUid":{"$ref":"#/components/schemas/UID"},"sku":{"type":"string"},"name":{"type":"string"},"supplierSku":{"type":"string"},"serialNumber":{"type":"string"},"requestedUnitPrice":{"type":"integer"},"requestedLinePrice":{"type":"integer"},"note":{"type":"string"},"warehouseUid":{"$ref":"#/components/schemas/OptionalUID"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedBy":{"type":"string"},"rmaOrderItemUid":{"$ref":"#/components/schemas/UID"},"serviceOrderUid":{"$ref":"#/components/schemas/OptionalUID"},"originalPurchaseNumber":{"type":"string"},"supplierReferenceNumber":{"type":"string","description":"from the original purchase order"}}},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"},"RMAOrderItemCreateRequestSchema":{"title":"RMAOrderItemCreateRequestSchema","type":"object","required":["requestedQuantity","requestedUnitPrice","productUid"],"properties":{"requestedQuantity":{"type":"integer"},"requestedUnitPrice":{"type":"integer"},"productUid":{"$ref":"#/components/schemas/UID"},"serialNumber":{"type":"string"},"note":{"type":"string"},"warehouseUid":{"$ref":"#/components/schemas/UID"},"rmaOrderItemUid":{"$ref":"#/components/schemas/UID"},"originalPurchaseNumber":{"type":"string"},"supplierReferenceNumber":{"type":"string","description":"from the original purchase order"}}}},"requestBodies":{"RMAOrderItemCreateRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMAOrderItemCreateRequestSchema"}}}}}},"paths":{"/tenants/{tenantUid}/rma-orders/{rmaOrderUid}/items":{"post":{"summary":"Create new item on a RMA order","tags":["RMA-Order"],"responses":{"201":{"$ref":"#/components/responses/RMAOrderResponse"}},"operationId":"create-rma-order-item","description":"Create new item on a RMA order\n\nRequired permissions: RMA_ORDER","requestBody":{"$ref":"#/components/requestBodies/RMAOrderItemCreateRequest"}}}}}
```

## Update RMA order item details

> Update RMA order item details\
> \
> Required permissions: RMA\_ORDER

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"RMA-Order","description":"RMA-Order"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"responses":{"RMAOrderResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMAOrderResponseSchema"}}}}},"schemas":{"RMAOrderResponseSchema":{"title":"RMAOrderResponseSchema","type":"object","required":["note","storeUid","storeName","supplierUid","supplierName","supplierReference","ourReference","reason","status","rmaNumber","items","createdAt","lastModifiedAt","createdBy","lastModifiedBy","sentToSupplierAt","rmaOrderUid"],"properties":{"note":{"type":"string"},"storeUid":{"$ref":"#/components/schemas/UID"},"storeName":{"type":"string"},"supplierUid":{"$ref":"#/components/schemas/UID"},"supplierName":{"type":"string"},"originalPurchaseNumber":{"type":"string","deprecated":true},"supplierReference":{"type":"string"},"ourReference":{"type":"string"},"reason":{"type":"string"},"status":{"$ref":"#/components/schemas/RMAOrderStatusResponseENUM"},"rmaNumber":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/RMAOrderItemResponseSchema"}},"createdAt":{"type":"string","format":"date-time"},"lastModifiedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedBy":{"type":"string"},"sentToSupplierAt":{"type":"string","nullable":true},"rmaOrderUid":{"$ref":"#/components/schemas/UID"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"RMAOrderStatusResponseENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| NEW | RMA Order is created |\n| WAITING_FOR_APPROVAL | RMA Order request is sent to supplier and awaiting approval|\n| DECLINED_BY_SUPPLIER | RMA Order request have been declined by supplier|\n| SENT_TO_SUPPLIER | Items have been physically sent back to supplier|\n| COMPLETE | Item stock has been adjusted |","enum":["NEW","WAITING_FOR_APPROVAL","DECLINED_BY_SUPPLIER","SENT_TO_SUPPLIER","COMPLETE"],"title":"RMAOrderStatusResponseENUM","type":"string"},"RMAOrderItemResponseSchema":{"title":"RMAOrderItemResponseSchema","type":"object","required":["requestedQuantity","productUid","sku","name","supplierSku","serialNumber","requestedUnitPrice","requestedLinePrice","note","warehouseUid","createdAt","lastModifiedAt","createdBy","lastModifiedBy","rmaOrderItemUid","serviceOrderUid","originalPurchaseNumber","supplierReferenceNumber"],"properties":{"requestedQuantity":{"type":"integer"},"productUid":{"$ref":"#/components/schemas/UID"},"sku":{"type":"string"},"name":{"type":"string"},"supplierSku":{"type":"string"},"serialNumber":{"type":"string"},"requestedUnitPrice":{"type":"integer"},"requestedLinePrice":{"type":"integer"},"note":{"type":"string"},"warehouseUid":{"$ref":"#/components/schemas/OptionalUID"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedBy":{"type":"string"},"rmaOrderItemUid":{"$ref":"#/components/schemas/UID"},"serviceOrderUid":{"$ref":"#/components/schemas/OptionalUID"},"originalPurchaseNumber":{"type":"string"},"supplierReferenceNumber":{"type":"string","description":"from the original purchase order"}}},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"},"RMAOrderItemUpdateRequestSchema":{"title":"RMAOrderItemUpdateRequestSchema","type":"object","properties":{"requestedQuantity":{"type":"integer"},"requestedUnitPrice":{"type":"integer"},"serialNumber":{"type":"string"},"note":{"type":"string"},"warehouseUid":{"$ref":"#/components/schemas/OptionalUID"},"originalPurchaseNumber":{"type":"string"},"supplierReferenceNumber":{"type":"string","description":"from the original purchase order"}}}},"requestBodies":{"RMAOrderItemUpdateRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMAOrderItemUpdateRequestSchema"}}}}}},"paths":{"/tenants/{tenantUid}/rma-orders/{rmaOrderUid}/items/{rmaOrderItemUid}":{"put":{"summary":"Update RMA order item details","tags":["RMA-Order"],"responses":{"201":{"$ref":"#/components/responses/RMAOrderResponse"}},"operationId":"update-rma-order-item-details","description":"Update RMA order item details\n\nRequired permissions: RMA_ORDER","requestBody":{"$ref":"#/components/requestBodies/RMAOrderItemUpdateRequest"}}}}}
```

## Delete RMA order item

> Delete RMA order item\
> \
> Required permissions: RMA\_ORDER

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"RMA-Order","description":"RMA-Order"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}}},"paths":{"/tenants/{tenantUid}/rma-orders/{rmaOrderUid}/items/{rmaOrderItemUid}":{"delete":{"summary":"Delete RMA order item","tags":["RMA-Order"],"responses":{"204":{"description":"No Content"}},"operationId":"delete-rma-order-item","description":"Delete RMA order item\n\nRequired permissions: RMA_ORDER"}}}}
```

## Download RMA order

> Download RMA order

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"RMA-Order","description":"RMA-Order"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"responses":{"FileResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Base64EncodedFileContentSchema"}},"application/pdf":{"schema":{"format":"binary","type":"string"}},"text/html":{"schema":{"type":"string"}},"application/octet-stream":{"schema":{"type":"string","format":"binary"}}},"description":"Based on the Accept header the response will be base64 json encoded or a raw file.\napplication/octet-stream will return a binary file\napplication/json will return a json with the file content base64 encoded."}},"schemas":{"Base64EncodedFileContentSchema":{"title":"Base64EncodedFileContentSchema","type":"object","properties":{"content":{"type":"string","description":" base64 encoded"},"contentType":{"description":"mime type","type":"string"},"filename":{"type":"string"}},"required":["content","contentType","filename"]}}},"paths":{"/tenants/{tenantUid}/rma-orders/{rmaOrderUid}/download":{"post":{"summary":"Download RMA order","tags":["RMA-Order"],"responses":{"200":{"$ref":"#/components/responses/FileResponse"},"400":{"description":"Bad Request"}},"operationId":"download-rma-order","description":"Download RMA order"}}}}
```

## Finalize RMA order. Stock will be adjusted

> Finalize RMA order. Stock will be adjusted\
> \
> Required permissions: RMA\_ORDER

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"RMA-Order","description":"RMA-Order"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"responses":{"PdfFileResponse":{"description":"PDF file","content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}}}}},"paths":{"/tenants/{tenantUid}/rma-orders/{rmaOrderUid}/complete":{"post":{"summary":"Finalize RMA order. Stock will be adjusted","tags":["RMA-Order"],"operationId":"finalize-rma-order","description":"Finalize RMA order. Stock will be adjusted\n\nRequired permissions: RMA_ORDER","responses":{"200":{"$ref":"#/components/responses/PdfFileResponse"}}}}}}
```

## Send email to supplier

> Send RMA order request to supplier by email\
> \
> Required permissions: RMA\_ORDER

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"RMA-Order","description":"RMA-Order"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"requestBodies":{"EmailNotificationRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailNotificationRequestSchema"}}}}},"schemas":{"EmailNotificationRequestSchema":{"title":"EmailNotificationRequestSchema","type":"object","required":["recepients"],"properties":{"recepients":{"type":"array","items":{"$ref":"#/components/schemas/EmailTYPE"}},"subject":{"type":"string"},"body":{"type":"string"},"includePDF":{"type":"boolean","default":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/Base64EncodedFileContentSchema"}}}},"EmailTYPE":{"title":"Email","type":"string"},"Base64EncodedFileContentSchema":{"title":"Base64EncodedFileContentSchema","type":"object","properties":{"content":{"type":"string","description":" base64 encoded"},"contentType":{"description":"mime type","type":"string"},"filename":{"type":"string"}},"required":["content","contentType","filename"]}},"responses":{"FileResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Base64EncodedFileContentSchema"}},"application/pdf":{"schema":{"format":"binary","type":"string"}},"text/html":{"schema":{"type":"string"}},"application/octet-stream":{"schema":{"type":"string","format":"binary"}}},"description":"Based on the Accept header the response will be base64 json encoded or a raw file.\napplication/octet-stream will return a binary file\napplication/json will return a json with the file content base64 encoded."}}},"paths":{"/tenants/{tenantUid}/rma-orders/{rmaOrderUid}/email":{"post":{"summary":"Send email to supplier","tags":["RMA-Order"],"operationId":"email-rma-order","description":"Send RMA order request to supplier by email\n\nRequired permissions: RMA_ORDER","requestBody":{"$ref":"#/components/requestBodies/EmailNotificationRequest"},"responses":{"200":{"$ref":"#/components/responses/FileResponse"},"201":{"description":"Created"},"400":{"description":"Bad Request"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.flowretail.com/api/rma-order.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.