Lock

[POST] .../v1/docorderfrompartner/lock

Locks customer order documents for editing. Reserve one or more order-from-partner documents for the current user before editing the document header, item rows or discounts. The request body must contain a non-empty ids array of positive document ids; the method returns the number of documents locked. Lock and tariff rules are enforced for the current request user. Missing body, empty ids, invalid id values, unavailable tariff, already locked documents or storage errors are returned as HTTP 200 ErrorResult.

Request Parameters

Name Type Required Description
ids Array of Int64 Required Order-from-partner document IDs. The array must contain at least one positive ID.

Request Example

{
  "ids": [
    4601
  ]
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Update Update operation result.

Response Example

{
  "ok": true,
  "result": {
    "row_affected": 1
  }
}