Unlock

[POST] .../v1/docwholesale/unlock

Unlocks partner shipment document for editing. Use this method to release locks from one or more shipment-to-partner documents after editing is finished or when another user should continue work. The request body must contain ids with at least one positive document id and the response returns row_affected for documents unlocked by the lock service. The current request user must have shipment document unlock permission; missing body, empty ids, invalid ids, denied access, tariff restrictions, lock ownership conflicts, database failures or persistent unlock errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

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

Request Example

{
  "ids": [
    5601
  ]
}

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