Read a return

Any signed in user. Returns one return with its lines, original sale uuid and credit amount. The read is pinned to the caller’s branch, so a return filed elsewhere is refused with 404.

GET/api/v1/returns/{returnId}

Authorization

AuthorizationBearer token (JWT) · headerrequired

JWT from POST /api/v1/auth/login sent as Authorization Bearer.

Path parameters

returnIdstringrequired

The return id.

Responses

200

The return and its lines

idstringrequired

sale_idstringrequired

branch_idstringrequired

processed_bystringrequired

client_mutation_idstringrequired

device_idstring | nullrequired

sync_statusstringrequired

reasonstringrequired

total_refundstringrequired

created_atstringrequired

processed_by_namestring | nullrequired

original_invoicestring | nullrequired

credit_note_numberstring | nullrequired

original_uuidstring | nullrequired

credit_amountnumber | nullrequired

itemsobject[]required

Show properties

Array of object

idstringrequired

return_idstringrequired

sale_item_idstringrequired

quantityintegerrequired

min -9007199254740991 · max 9007199254740991

restockablebooleanrequired

reasonstringrequired

medicine_idstringrequired

medicine_namestringrequired

unit_pricestringrequired

vat_ratestringrequired

401

Not authenticated

detailstringrequired

404

Return not found

detailstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

returnIdpath*The return id.

Request

curl -X GET 'http://localhost:8000/api/v1/returns/string' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("http://localhost:8000/api/v1/returns/string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "http://localhost:8000/api/v1/returns/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "id": "string",
  "sale_id": "string",
  "branch_id": "string",
  "processed_by": "string",
  "client_mutation_id": "string",
  "device_id": "string",
  "sync_status": "string",
  "reason": "string",
  "total_refund": "string",
  "created_at": "string",
  "processed_by_name": "string",
  "original_invoice": "string",
  "credit_note_number": "string",
  "original_uuid": "string",
  "credit_amount": 0,
  "items": [
    {
      "id": "string",
      "return_id": "string",
      "sale_item_id": "string",
      "quantity": -9007199254740991,
      "restockable": true,
      "reason": "string",
      "medicine_id": "string",
      "medicine_name": "string",
      "unit_price": "string",
      "vat_rate": "string"
    }
  ]
}

{
  "detail": "string"
}

{
  "detail": "string"
}