List returns

Any signed in user. Lists the branch returns, newest first, with author and credit note. Pass sale_id to narrow the list to the returns raised against a single sale.

GET/api/v1/returns

Authorization

AuthorizationBearer token (JWT) · headerrequired

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

Query parameters

sale_idstring

Restrict to the returns raised against one sale.

pageinteger

One based page number. Defaults to 1.

page_sizeinteger

Rows per page, capped at 200. Defaults to 20.

Responses

200

A page of returns

totalintegerrequired

min -9007199254740991 · max 9007199254740991

pageintegerrequired

min -9007199254740991 · max 9007199254740991

page_sizeintegerrequired

min -9007199254740991 · max 9007199254740991

itemsobject[]required

Show properties

Array of object

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

401

Not authenticated

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

sale_idqueryRestrict to the returns raised against one sale.pagequeryOne based page number. Defaults to 1.page_sizequeryRows per page, capped at 200. Defaults to 20.

Request

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

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

import requests

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

Response

{
  "total": -9007199254740991,
  "page": -9007199254740991,
  "page_size": -9007199254740991,
  "items": [
    {
      "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"
    }
  ]
}

{
  "detail": "string"
}