TRANXACT.AI Help

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.

Type REST18 operationsBase path /api/scm/rmaPublished as /api/v1/rma

Download specification (OpenAPI 3.1) Screen: Returns (RMA)

Overview

PackageSupply Chain
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tablescm.rma · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
customer_notestextNoWhat the customer says
notestextNoNotes

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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
customer_notestextNoWhat the customer says
notestextNoNotes

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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, refundReference

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/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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
idstring (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, withLines

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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
rma_notextread onlyRma no
account_iduuidread onlyCustomer
contact_iduuidread onlyContact id
ar_invoice_iduuidread onlyInvoice — The invoice the goods were bought on.
sales_order_iduuidread onlySales order id
statustextread onlyStatus
reason_codetextread onlyReason
requested_resolutiontextread onlyThe customer asks for
Allowed: credit replacement refund repair
resolutiontextread onlyResolution
requested_viatextread onlyRequested via
portal_user_iduuidread onlyPortal user id
customer_notestextread, writeWhat the customer says
currencytextread onlyCurrency
return_valuenumericread onlyReturn value
restocking_fee_pctnumericread onlyRestocking fee pct
return_warehouse_iduuidread onlyReturn warehouse id
return_bin_iduuidread onlyReturn bin id
return_instructionstextread onlyReturn instructions
return_carriertextread onlyReturn carrier
return_label_reftextread onlyReturn label ref
expected_bydateread onlyExpected by
approved_attimestamp with time zoneread onlyApproved at
approved_byuuidread onlyApproved by
rejection_reasontextread onlyRejection reason
received_attimestamp with time zoneread onlyReceived at
inspected_attimestamp with time zoneread onlyInspected at
resolved_attimestamp with time zoneread onlyResolved at
credit_note_iduuidread onlyCredit note id
replacement_so_iduuidread onlyReplacement so id
refund_amountnumericread onlyRefund amount
refund_referencetextread onlyRefund reference
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Supply Chain › Returns (RMA) for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.