Error
A valid request URL is required to generate request examples{
"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"
}{
"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
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}Returns
Get a processed return by id
Returns the processed return read model for one return id — the signed refund transaction plus its refundMethod, originalTransactionId and reason. 404s when no return carries the given id.
GET
/
v1
/
returns
/
{id}
Error
A valid request URL is required to generate request examples{
"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"
}{
"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
}
}{
"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.
Path Parameters
Id of the processed return (retour) to read.
Minimum string length:
1
