Return Reason

The return reason resource.

Base/returnReason

GET/returnReason

List return reasons

Retrieve a paginated list of return reasons. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GET/returnReason

curl --request GET \
  --url '<your-host>/returnReason?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "name": "Example",
    "inventoryValueZero": true,
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "updatedBy": "string",
    "updatedAt": "2026-01-01T00:00:00Z"
  }
]

GET/returnReason

Retrieve a return reason

Fetch a single return reason by filtering on `id`.

Query parameters

idstring

Match on the return reason's `id`, e.g. `eq.{id}`.

GET/returnReason

curl --request GET \
  --url '<your-host>/returnReason?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "name": "Example",
  "inventoryValueZero": true,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string",
  "updatedAt": "2026-01-01T00:00:00Z"
}

POST/returnReason

Create a return reason

Create a new return reason.

Body parameters

namestringrequired

inventoryValueZerobooleanrequired

customFieldsobject

POST/returnReason

curl --request POST \
  --url <your-host>/returnReason \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","inventoryValueZero":true}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "name": "Example",
  "inventoryValueZero": true,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string",
  "updatedAt": "2026-01-01T00:00:00Z"
}

PATCH/returnReason

Update a return reason

Update an existing return reason, matched on `id`.

Body parameters

namestringrequired

inventoryValueZerobooleanrequired

customFieldsobject

PATCH/returnReason

curl --request PATCH \
  --url '<your-host>/returnReason?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example"}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "name": "Example",
  "inventoryValueZero": true,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string",
  "updatedAt": "2026-01-01T00:00:00Z"
}

DELETE/returnReason

Delete a return reason

Delete a return reason, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the return reason to delete, e.g. `eq.{id}`.

DELETE/returnReason

curl --request DELETE \
  --url '<your-host>/returnReason?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content