Skip to main content
POST
/
returns
Create customer return
curl --request POST \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/returns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sales_order_id": 123,
  "items": [
    {
      "sales_order_item_id": 123,
      "quantity": 1.001,
      "uom_id": 123,
      "location_id": 123,
      "lot_id": 123
    }
  ],
  "order_date": "2023-12-25",
  "is_posted": 0,
  "restock": true,
  "transaction_type": "return-only"
}
'
{
  "data": {
    "id": 123,
    "sales_order_id": 123,
    "status": "Pending",
    "restock": true,
    "order_date": "2023-12-25",
    "transaction_type": "return-only",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "items": [
      {
        "id": 123,
        "sales_order_item_id": 123,
        "sku": "<string>",
        "quantity": 123,
        "location_id": 123,
        "lot_id": 123
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.joinluminous.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Body

application/json
​
sales_order_id
integer
required
​
items
object[]
required
Minimum array length: 1
​
order_date
string<date> | null
​
is_posted
enum<integer> | null

Optional. When 1, the return is created already received.

Available options:
0,
1
​
restock
boolean | null

When true, inventory is restocked on receive (default behavior).

​
transaction_type
enum<string> | null
Available options:
return-only,
refund-only,
return-and-refund

Response

Created

​
data
object

A customer return for a sales order — return-only, refund-only, or return-and-refund. Status is Pending until received, then Received.