--- updatedAt: 2026-05-29T09:20:09.000Z agentTools: projectIndex: https://developer.katanamrp.com/llms.txt --- # Update a sales return Updates the specified sales return by setting the values of the parameters passed. Any parameters not provided will be left unchanged. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "RESOURCES", "version": "1.0.0", "description": "public api" }, "servers": [ { "url": "https://api.katanamrp.com/v1" } ], "security": [ { "bearerAuth": [] } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer" } } }, "paths": { "/sales_returns/{id}": { "patch": { "summary": "Update a sales return", "tags": [ "Sales return" ], "description": "Updates the specified sales return by setting the values of the parameters passed.\n Any parameters not provided will be left unchanged. ", "operationId": "updateSalesReturn", "parameters": [ { "name": "id", "required": true, "description": "Sales return id", "schema": { "type": "integer" }, "in": "path" } ], "requestBody": { "description": "sales return fields to be updated with new values", "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "status": { "type": "string", "description": "New status of the sales return.", "enum": [ "NOT_RETURNED", "RETURNED_ALL", "RESTOCKED_ALL" ] }, "return_date": { "type": "string", "description": "Date of the return. Must be compatible with ISO 8601 format. Updatable only when current return status is not restockedAll." }, "order_created_date": { "type": "string", "description": "Creation date of the return. Must be compatible with ISO 8601 format. Updatable only when current return status is not restockedAll." }, "return_location_id": { "type": "integer", "description": "Updatable only when current return status is not restockedAll.", "maximum": 2147483647 }, "order_no": { "type": "string", "description": "Updatable only when current return status is not restockedAll." }, "additional_info": { "type": "string", "description": "Additional information about the return. Updatable only when current return status is not restockedAll.", "nullable": true } } } } } }, "responses": { "200": { "description": "Sales order updated", "headers": { "X-Ratelimit-Limit": { "description": "Number of requests available for this application.", "schema": { "type": "number" } }, "X-Ratelimit-Remaining": { "description": "Number of requests remaining in quota.", "schema": { "type": "number" } }, "X-Ratelimit-Reset": { "description": "The timestamp when the quota will reset.", "schema": { "type": "number" } } }, "content": { "application/json": { "example": { "id": 1148, "customer_id": 52910306, "sales_order_id": 26857265, "order_no": "RO-6", "return_location_id": 26331, "status": "RESTOCKED_ALL", "currency": "EUR", "return_date": "2025-02-20T11:05:56.738Z", "order_created_date": "2025-02-07T07:52:41.237Z", "additional_info": "", "refund_status": "NOT_REFUNDED", "created_at": "2025-02-07T07:52:41.395Z", "updated_at": "2025-02-20T11:05:56.753Z" } } } }, "401": { "description": "Make sure you've entered your API token correctly.", "headers": { "X-Ratelimit-Limit": { "description": "Number of requests available for this application.", "schema": { "type": "number" } }, "X-Ratelimit-Remaining": { "description": "Number of requests remaining in quota.", "schema": { "type": "number" } }, "X-Ratelimit-Reset": { "description": "The timestamp when the quota will reset.", "schema": { "type": "number" } } }, "content": { "application/json": { "example": { "statusCode": 401, "name": "UnauthorizedError", "message": "Unauthorized" } } } }, "404": { "description": "Make sure data is correct", "headers": { "X-Ratelimit-Limit": { "description": "Number of requests available for this application.", "schema": { "type": "number" } }, "X-Ratelimit-Remaining": { "description": "Number of requests remaining in quota.", "schema": { "type": "number" } }, "X-Ratelimit-Reset": { "description": "The timestamp when the quota will reset.", "schema": { "type": "number" } } }, "content": { "application/json": { "example": { "statusCode": 404, "name": "NotFoundError", "message": "Not found" } } } }, "422": { "description": "Check the details property for a specific error message.", "headers": { "X-Ratelimit-Limit": { "description": "Number of requests available for this application.", "schema": { "type": "number" } }, "X-Ratelimit-Remaining": { "description": "Number of requests remaining in quota.", "schema": { "type": "number" } }, "X-Ratelimit-Reset": { "description": "The timestamp when the quota will reset.", "schema": { "type": "number" } } }, "content": { "application/json": { "example": { "statusCode": 422, "name": "UnprocessableEntityError", "message": "The request body is invalid. See error object `details` property for more info.", "code": "VALIDATION_FAILED", "details": [ { "path": ".name", "code": "maxLength", "message": "should NOT be longer than 10 characters", "info": { "limit": 10 } } ] } } } }, "429": { "description": "The rate limit has been reached. Please try again later.", "headers": { "X-Ratelimit-Limit": { "description": "Number of requests available for this application.", "schema": { "type": "number" } }, "X-Ratelimit-Remaining": { "description": "Number of requests remaining in quota.", "schema": { "type": "number" } }, "X-Ratelimit-Reset": { "description": "The timestamp when the quota will reset.", "schema": { "type": "number" } } }, "content": { "application/json": { "example": { "statusCode": 429, "name": "TooManyRequests", "message": "Too Many Requests" } } } }, "500": { "description": "The server encountered an error. If this persists, please contact support", "headers": { "X-Ratelimit-Limit": { "description": "Number of requests available for this application.", "schema": { "type": "number" } }, "X-Ratelimit-Remaining": { "description": "Number of requests remaining in quota.", "schema": { "type": "number" } }, "X-Ratelimit-Reset": { "description": "The timestamp when the quota will reset.", "schema": { "type": "number" } } }, "content": { "application/json": { "example": { "statusCode": 500, "name": "InternalServerError", "message": "Internal Server Error" } } } } } } } }, "x-explorer-enabled": false, "x-samples-enabled": true, "x-samples-languages": [ "curl", "node", "go", "ruby", "python", "php" ], "x-headers": [ { "key": "Authorization", "value": "Bearer " } ] } ```