List processed returns (retours)

Returns one page of the processed returns / avoirs (the caisse ‘Retours’ journal), optionally narrowed by store and/or the originalTransactionId a return was raised against. Use page/pageSize (max 100) to walk the result; total/pageCount tell you when to stop. This is the read source for the returns journal tab. A calendar-day facet is not offered — returns carry no persisted timestamp yet. This router never writes here.

GET /v1/returns

Error

A valid request URL is required to generate request examples

200

{
  "items": [
    {
      "transaction": {
        "id": "ret-ok",
        "number": "R-ret-ok",
        "storeId": "store-1",
        "sellerId": "user-camille",
        "customerId": null,
        "status": "completed",
        "type": "return",
        "lines": [
          {
            "skuId": "f139995b359e2702f33b391acb3d42a419197a7b2c09d04c1fe6d97ecefe4feb",
            "quantity": 1,
            "unitPrice": 1800
          }
        ],
        "totals": {
          "subtotal": 1800,
          "total": -1800,
          "itemCount": 1,
          "lineCount": 1
        }
      },
      "originalTransactionId": "sale-return-seed",
      "refundMethod": "cash",
      "reason": "damaged"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 20,
  "pageCount": 1
}

Authorizations

Authorization · string · header · required

Authorization: Bearer <token>. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same pos.* scope vocabulary the route guards enforce.

Query Parameters

page · integer · default: 1

1-based page index to return. Defaults to 1.

Required range: 1 <= x <= 9007199254740991

pageSize · integer · default: 20

Rows per page, 1..100. Defaults to 20.

Required range: 1 <= x <= 100

store · string

Narrow to one store's returns (retours / avoirs) by store id.

originalTransactionId · string

Narrow to the returns raised against one original charge transaction (vente).

Response

200

application/json

A page of processed returns with the pagination totals.

A page of processed returns with the pagination totals.

items · object[] · required

The rows on this page, in the query's sort order.

Show child attributes

total · integer · required

Total rows matching the filter across ALL pages, not just this one.

Required range: 0 <= x <= 9007199254740991

page · integer · required

The 1-based page number served.

Required range: 0 < x <= 9007199254740991

pageSize · integer · required

Rows requested per page.

Required range: 0 < x <= 9007199254740991

pageCount · integer · required

Total number of pages; stop walking when page reaches it.

Required range: 0 <= x <= 9007199254740991