Get Return Merchandise Authorisations (RMAs):/return-merchandise-authorisations
GET
https://dev-api.exsited.com/api/v3/return-merchandise-authorisations
Try It Out
Purpose
This endpoint retrieves a list of all return merchandise authorisation (RMA) records. It provides details on each RMA request, including return status, related invoices, return quantities, and associated item information. This is essential for tracking customer returns and ensuring the proper handling of returned goods.
Path Parameters
No path parameters required for this endpoint.
Query Parameters
No query parameters required for this endpoint.
Request Body
No request body required for this endpoint.
Response
The response includes a paginated list of RMAs, with each entry detailing the return request, such as the customer return status, return date, linked invoice ID, and the list of items being returned. Each item return record includes both requested and received quantities along with item metadata. Pagination details help navigate through large RMA datasets.
JSON
{
"return_merchandise_authorisations": [
{
"id": "RMA_ID",
"customer_return_status": "RETURN_STATUS",
"customer_return_date": "RETURN_DATE_ISO8601",
"invoice_id": "INVOICE_ID",
"note": "RETURN_NOTE",
"received_count": "RECEIVED_COUNT",
"returns": [
{
"item_id": "ITEM_ID",
"item_name": "ITEM_NAME",
"item_uuid": "ITEM_UUID",
"rma_returned": "RETURNED_QUANTITY",
"rma_requested": "REQUESTED_QUANTITY",
"uuid": "RETURN_UUID"
}
],
"created_by": "CREATED_BY",
"created_on": "CREATED_ON_ISO8601",
"last_updated_by": "LAST_UPDATED_BY",
"last_updated_on": "LAST_UPDATED_ON_ISO8601",
"uuid": "RMA_UUID",
"version": "VERSION_NUMBER"
}
],
"pagination": {
"records": TOTAL_RECORDS,
"limit": PAGE_LIMIT,
"offset": PAGE_OFFSET,
"previous_page": "PREVIOUS_PAGE_URL",
"next_page": "NEXT_PAGE_URL"
}
}
| Field | Type | Description |
|---|---|---|
| return_merchandise_authorisations | array | List of return merchandise authorisations. |
| id | string | Unique RMA identifier. |
| customer_return_status | string | Status of the return (e.g., PENDING, CLOSED). |
| customer_return_date | string | The date when the customer return was initiated. |
| invoice_id | string | Related invoice identifier for the return. |
| note | string | Additional notes regarding the return. |
| received_count | string | Number of items physically received. |
| returns | array | Items being returned with quantity details. |
| returns[].item_id | string | ID of the item being returned. |
| returns[].item_name | string | Name of the item. |
| returns[].item_uuid | string | UUID of the returned item. |
| returns[].rma_returned | string | Quantity returned by the customer. |
| returns[].rma_requested | string | Quantity originally requested for return. |
| returns[].uuid | string | UUID of the specific return record. |
| created_by | string | The user who created the RMA. |
| created_on | string | Timestamp of when the RMA was created (ISO8601). |
| last_updated_by | string | The user who last updated the RMA. |
| last_updated_on | string | Timestamp of the last update (ISO8601). |
| uuid | string | Unique UUID of the RMA record. |
| version | string | Version number of the RMA record. |
| pagination | object | Metadata for pagination of records. |
| pagination.records | integer | Total number of records available. |
| pagination.limit | integer | Limit of records returned per page. |
| pagination.offset | integer | Offset for the current page. |
| pagination.previous_page | string | URL of the previous page (if any). |
| pagination.next_page | string | URL of the next page (if any). |
Get Return Merchandise Authorisation by ID: /return-merchandise-authorisations/{rma_id}
GET
https://dev-api.exsited.com/api/v3/return-merchandise-authorisations/{rma_id}
Try It Out
Purpose
Fetches details of a specific Return Merchandise Authorisation (RMA) record using its unique identifier.
Use Case
Used by staff or system modules to retrieve RMA details such as return quantities, invoice linkage, item information, and audit metadata.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| rma_id | string | Unique identifier of the RMA record. |
Query Parameters
No query parameters required for this endpoint.
Request Body
No request body required for this endpoint.
Response
Returns the full RMA record, including item returns, status, timestamps, and metadata.
JSON
{
"return_merchandise_authorisation": {
"id": "RMA_ID",
"customer_return_status": "RETURN_STATUS",
"customer_return_date": "RETURN_DATE_ISO",
"invoice_id": "INVOICE_ID",
"note": "NOTE_TEXT",
"received_count": "RECEIVED_ITEM_COUNT",
"returns": [
{
"item_id": "ITEM_ID",
"item_name": "ITEM_NAME",
"item_uuid": "ITEM_UUID",
"rma_returned": "QUANTITY_RETURNED",
"rma_requested": "QUANTITY_REQUESTED",
"uuid": "RETURN_UUID"
}
],
"created_by": "CREATOR_NAME",
"created_on": "CREATED_TIMESTAMP_ISO",
"last_updated_by": "LAST_UPDATED_BY",
"last_updated_on": "LAST_UPDATED_TIMESTAMP_ISO",
"uuid": "RMA_UUID",
"version": "VERSION_NUMBER"
}
}
| Field | Type | Description |
|---|---|---|
| return_merchandise_authorisation | object | Container for the RMA details. |
| id | string | RMA identifier. |
| customer_return_status | string | Status of the return (e.g., PENDING, CLOSED). |
| customer_return_date | string | Return request date in ISO format. |
| invoice_id | string | Associated invoice ID. |
| note | string | Notes or comments about the RMA. |
| received_count | string | Number of items received as part of the RMA. |
| returns | array | List of returned item details. |
| returns[].item_id | string | Identifier for the item. |
| returns[].item_name | string | Name of the returned item. |
| returns[].item_uuid | string | UUID of the returned item. |
| returns[].rma_returned | string | Quantity actually returned. |
| returns[].rma_requested | string | Quantity originally requested for return. |
| returns[].uuid | string | UUID of the return line item. |
| created_by | string | Name of the user who created the RMA. |
| created_on | string | Timestamp of when the RMA was created (ISO 8601). |
| last_updated_by | string | User who last updated the RMA. |
| last_updated_on | string | Last update timestamp in ISO format. |
| uuid | string | Unique identifier of the RMA object. |
| version | string | Version number of the RMA record for concurrency checks. |
Get Return Merchandise Authorisations by Invoice ID:/invoices/{id}/return-merchandise-authorisations
GET
https://dev-api.exsited.com/api/v3/invoices/{id}/return-merchandise-authorisations
Try It Out
Purpose
Retrieves all return merchandise authorisation (RMA) records associated with a specific invoice.
Use Case
Useful for tracking product returns, viewing return status, and reviewing customer return requests related to a particular invoice.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| id | string | Unique invoice identifier |
Query Parameters
No query parameters required for this endpoint.
Request Body
No request body required for this endpoint.
Response
Returns a list of RMAs linked to the specified invoice, including details of returned items and pagination metadata.
JSON
{
"invoice": {
"return_merchandise_authorisations": [
{
"id": "RMA_ID",
"customer_return_status": "RETURN_STATUS",
"customer_return_date": "RETURN_DATE_ISO",
"invoice_id": "INVOICE_ID",
"note": "RMA_NOTE",
"received_count": "RECEIVED_ITEM_COUNT",
"returns": [
{
"item_id": "ITEM_ID",
"item_name": "ITEM_NAME",
"item_uuid": "ITEM_UUID",
"rma_returned": "QUANTITY_RETURNED",
"rma_requested": "QUANTITY_REQUESTED",
"uuid": "RETURN_UUID"
}
],
"created_by": "CREATED_BY_USER",
"created_on": "CREATED_TIMESTAMP_ISO",
"last_updated_by": "UPDATED_BY_USER",
"last_updated_on": "UPDATED_TIMESTAMP_ISO",
"uuid": "RMA_UUID",
"version": "VERSION_NUMBER"
}
],
"pagination": {
"records": TOTAL_RECORDS,
"limit": PAGE_LIMIT,
"offset": OFFSET_VALUE,
"previous_page": "PREVIOUS_PAGE_TOKEN",
"next_page": "NEXT_PAGE_TOKEN"
}
}
}
| Field | Type | Description |
|---|---|---|
| invoice | object | Root object containing RMA data and pagination info. |
| return_merchandise_authorisations | array | List of RMAs linked to the invoice. |
| return_merchandise_authorisations[].id | string | RMA identifier. |
| return_merchandise_authorisations[].customer_return_status | string | Return status (e.g., PENDING, CLOSED). |
| return_merchandise_authorisations[].customer_return_date | string | Date of customer return request (ISO 8601). |
| return_merchandise_authorisations[].invoice_id | string | Associated invoice ID. |
| return_merchandise_authorisations[].note | string | Note or comment associated with the RMA. |
| return_merchandise_authorisations[].received_count | string | Number of items received from the return. |
| return_merchandise_authorisations[].returns | array | Returned item details. |
| returns[].item_id | string | Item code. |
| returns[].item_name | string | Name of the returned item. |
| returns[].item_uuid | string | Unique item identifier. |
| returns[].rma_returned | string | Quantity returned by the customer. |
| returns[].rma_requested | string | Quantity initially requested for return. |
| returns[].uuid | string | UUID of the return line item. |
| created_by | string | Name of the user who created the RMA. |
| created_on | string | Timestamp of when the RMA was created (ISO 8601). |
| last_updated_by | string | Name of the user who last updated the RMA. |
| last_updated_on | string | Last update timestamp in ISO format. |
| uuid | string | UUID of the RMA record. |
| version | string | Version number of the RMA for concurrency checks. |
| pagination | object | Metadata for pagination support. |
| pagination.records | integer | Total number of RMA records found. |
| pagination.limit | integer | Number of records per page. |
| pagination.offset | integer | Record offset (start index). |
| pagination.previous_page | string | Token or reference for the previous page. |
| pagination.next_page | string | Token or reference for the next page. |
Get Specific Return Merchandise Authorisation by Invoice ID:/invoices/{id}/return-merchandise-authorisations/{id}
GET
https://dev-api.exsited.com/api/v3/invoices/{id}/return-merchandise-authorisations/{id}
Try It Out
Purpose
Retrieves the details of a specific Return Merchandise Authorisation (RMA) associated with a given invoice
Use Case
Useful when viewing the complete return details of a specific RMA to monitor return status, items involved, and audit metadata.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| id (invoice) | string | Unique identifier of the invoice. |
| id (rma_id) | string | Unique identifier of the return merchandise authorisation. |
Query Parameters
No query parameters required for this endpoint.
Request Body
No request body required for this endpoint.
Response
Returns detailed information about a single RMA, including item return details, return status, creation audit, and linked invoice.
JSON
{
"invoice": {
"return_merchandise_authorisation": {
"id": "RMA_ID",
"customer_return_status": "RETURN_STATUS",
"customer_return_date": "RETURN_DATE_ISO",
"invoice_id": "INVOICE_ID",
"note": "RMA_NOTE",
"received_count": "RECEIVED_ITEM_COUNT",
"returns": [
{
"item_id": "ITEM_ID",
"item_name": "ITEM_NAME",
"item_uuid": "ITEM_UUID",
"rma_returned": "QUANTITY_RETURNED",
"rma_requested": "QUANTITY_REQUESTED",
"uuid": "RETURN_UUID"
}
],
"created_by": "CREATED_BY_USER",
"created_on": "CREATED_TIMESTAMP_ISO",
"last_updated_by": "UPDATED_BY_USER",
"last_updated_on": "UPDATED_TIMESTAMP_ISO",
"uuid": "RMA_UUID",
"version": "VERSION_NUMBER"
}
}
}
| Field | Type | Description |
|---|---|---|
| invoice | object | Container for invoice-linked data. |
| return_merchandise_authorisation | object | Detailed data for a specific RMA. |
| id | string | Unique RMA identifier. |
| customer_return_status | string | Return status (PENDING, CLOSED, etc.). |
| customer_return_date | string | ISO timestamp when the return was initiated. |
| invoice_id | string | Invoice associated with the return. |
| note | string | Optional note about the return. |
| received_count | string | Number of items physically returned. |
| returns | array | Line items being returned. |
| returns[].item_id | string | Returned item code. |
| returns[].item_name | string | Name of the item returned. |
| returns[].item_uuid | string | UUID for the item. |
| returns[].rma_returned | string | Actual quantity returned. |
| returns[].rma_requested | string | Quantity requested for return. |
| returns[].uuid | string | UUID of the individual return line. |
| created_by | string | Name of the user who created the RMA. |
| created_on | string | ISO timestamp of RMA creation. |
| last_updated_by | string | Last user to update the RMA. |
| last_updated_on | string | ISO timestamp of last update. |
| uuid | string | Unique identifier of the RMA entity. |
| version | string | Version number used for concurrency control. |