Supply Chain · Returns
Returns (RMA)
Goods a customer sends back: authorised before they travel, received into quarantine, inspected and dispositioned, and resolved by a credit note, a replacement or a refund.
/api/scm/rmaPublished as /api/v1/rmaOverview
| Package | Supply Chain |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Supply Chain › Returns (RMA) on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | scm.rma · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
18 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/scm/rmaList returns (rma)
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"rma_no": "RMA-000001",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"ar_invoice_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"status": "draft",
"reason_code": "REA-000001",
"requested_resolution": "credit",
"resolution": "text",
"requested_via": "text",
"portal_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"customer_notes": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/rma?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/rma/{id}Read one return
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"rma_no": "RMA-000001",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"ar_invoice_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"status": "draft",
"reason_code": "REA-000001",
"requested_resolution": "credit",
"resolution": "text",
"requested_via": "text",
"portal_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"customer_notes": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/rma/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/rmaCreate a return
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
customer_notes | text | No | What the customer says |
notes | text | No | Notes |
Sample body
{
"customer_notes": "text",
"notes": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"rma_no": "RMA-000001",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"ar_invoice_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"status": "draft",
"reason_code": "REA-000001",
"requested_resolution": "credit",
"resolution": "text",
"requested_via": "text",
"portal_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"customer_notes": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/rma" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"customer_notes":"text","notes":"text"}'PUT/api/scm/rma/{id}Change a return
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
customer_notes | text | No | What the customer says |
notes | text | No | Notes |
Sample body
{
"customer_notes": "text",
"notes": "text"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"rma_no": "RMA-000001",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"ar_invoice_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"status": "draft",
"reason_code": "REA-000001",
"requested_resolution": "credit",
"resolution": "text",
"requested_via": "text",
"portal_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"customer_notes": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/rma/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"customer_notes":"text","notes":"text"}'DELETE/api/scm/rma/{id}Delete a return
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/scm/rma/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/rma/{id}/trackingTracking
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/scm/rma/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/tracking" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/rma/{id}/approveApprove
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/rma/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approve" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/rma/{id}/rejectReject
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/rma/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/reject" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/rma/{id}/receiveReceive
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/rma/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/receive" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/rma/{id}/inspectInspect
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/rma/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/inspect" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/rma/{id}/closeClose
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/rma/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/close" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/rma/{id}/cancelCancel
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/rma/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/cancel" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/rma/{id}/resolveResolve
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
resolution*, refundAmount, refundReferenceResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/rma/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/resolve" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"resolution":"value","refundAmount":"value","refundReference":"value"}'GET/api/scm/rma/{parentId}/linesLines
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/scm/rma/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/rma/{parentId}/linesLines
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/rma/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
-H "Authorization: Bearer $TOKEN"PUT/api/scm/rma/{parentId}/lines/{lineId}Lines
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/rma/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/scm/rma/{parentId}/lines/{lineId}Lines
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/scm/rma/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/rma/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/rma/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'Data model
Every field of a return, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
rma_no | text | read only | Rma no |
account_id | uuid | read only | Customer |
contact_id | uuid | read only | Contact id |
ar_invoice_id | uuid | read only | Invoice — The invoice the goods were bought on. |
sales_order_id | uuid | read only | Sales order id |
status | text | read only | Status |
reason_code | text | read only | Reason |
requested_resolution | text | read only | The customer asks for Allowed: credit replacement refund repair |
resolution | text | read only | Resolution |
requested_via | text | read only | Requested via |
portal_user_id | uuid | read only | Portal user id |
customer_notes | text | read, write | What the customer says |
currency | text | read only | Currency |
return_value | numeric | read only | Return value |
restocking_fee_pct | numeric | read only | Restocking fee pct |
return_warehouse_id | uuid | read only | Return warehouse id |
return_bin_id | uuid | read only | Return bin id |
return_instructions | text | read only | Return instructions |
return_carrier | text | read only | Return carrier |
return_label_ref | text | read only | Return label ref |
expected_by | date | read only | Expected by |
approved_at | timestamp with time zone | read only | Approved at |
approved_by | uuid | read only | Approved by |
rejection_reason | text | read only | Rejection reason |
received_at | timestamp with time zone | read only | Received at |
inspected_at | timestamp with time zone | read only | Inspected at |
resolved_at | timestamp with time zone | read only | Resolved at |
credit_note_id | uuid | read only | Credit note id |
replacement_so_id | uuid | read only | Replacement so id |
refund_amount | numeric | read only | Refund amount |
refund_reference | text | read only | Refund reference |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Supply Chain › Returns (RMA) for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.