Lock

[POST] .../v1/docordertopartner/lock

Locks partner order document for editing. Use this method to reserve one or more supplier orders for the current user before editing the document header or OrderToPartnerOperation rows. The request body must contain a non-empty ids array of positive document ids; the method returns the number of documents locked. Lock and permission rules are enforced in the persistent layer for the current request user. Missing body, empty ids, invalid id values, denied access, already locked documents or database failures are returned as HTTP 200 ErrorResult business errors.

Request Parameters

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

Request Example

{
  "ids": [
    4501
  ]
}

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
  }
}