Return

[POST] .../v1/docorderdelivery/return

Refreshes data by return cheque Use this workflow method while processing a return for a retail order to reduce or remove returned operation quantities. The request requires document_id and a data array of one to 250 operation rows; each row must contain an operation id and positive quantity within the allowed numeric limit. The method requires the retail order operation edit permission, locks the document by document_id, requires the order to be in ReturnProcessing status, verifies that all operations belong to the document and that return quantities do not exceed remaining quantities, updates or deletes returned rows and may set the order to Canceled when no quantities remain. Business errors such as a missing request body, invalid document_id, empty or too-large data array, invalid operation id or quantity, denied access, missing order, invalid status, operation membership mismatch, excessive return quantity, missing active row, database errors or persistence failures are returned as HTTP 200 ErrorResult.

Request Parameters

Request Example

{
  "data": [
    {
      "id": 1,
      "quantity": 1.0
    }
  ],
  "document_id": 1
}

Response Parameters

Response Example

{
  "ok": true,
  "result": {
    "ids": [
      null
    ],
    "row_affected": 1
  }
}