Delete

[POST] .../v1/deliverycourier/delete

Deletes courier. Delete a courier that should no longer be available for delivery assignment or dispatch selectors. It requires a positive id and returns row_affected after the method checks whether removal is allowed. The caller must have courier delete permission; missing body, invalid id, denied access, related delivery order restrictions, missing records and storage errors are returned as HTTP 200 ErrorResult.

Request Parameters

Name Type Required Description
id Int64 Required Courier ID.

Request Example

{
  "id": 11
}

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