Lock
[POST] .../v1/docwholesalereturn/lock
Locks wholesale customer return documents for editing. Lock one or more wholesale return documents before editing the header or item operations. The request body must contain ids with at least one positive document id and the response returns row_affected for documents locked for the current request user. This method uses the document lock service and does not perform a separate permission check in the current implementation; missing body, empty ids, invalid ids, lock conflicts, storage errors or lock errors are returned as HTTP 200 ErrorResult.
Request Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ids | Array of Int64 | Required | Return-from-partner document IDs. The array must contain at least one positive ID. |
Request Example
{
"ids": [
6601
]
}
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
}
}