A valid request URL is required to generate request examples{
"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
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123,
"fieldErrors": [
{
"field": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}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.
A valid request URL is required to generate request examples{
"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
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123,
"fieldErrors": [
{
"field": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}Authorizations
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
1-based page index to return. Defaults to 1.
1 <= x <= 9007199254740991Rows per page, 1..100. Defaults to 20.
1 <= x <= 100Narrow to one store's returns (retours / avoirs) by store id.
Narrow to the returns raised against one original charge transaction (vente).
Response
A page of processed returns with the pagination totals.
A page of processed returns with the pagination totals.
The rows on this page, in the query's sort order.
Show child attributes
Show child attributes
Total rows matching the filter across ALL pages, not just this one.
0 <= x <= 9007199254740991The 1-based page number served.
0 < x <= 9007199254740991Rows requested per page.
0 < x <= 9007199254740991Total number of pages; stop walking when page reaches it.
0 <= x <= 9007199254740991