Cancel a rework order

POST

/rework-orders/{id}/cancel

curl --request POST \
  --url https://app.buildtrace.eu/api/rework-orders/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "reason": "example" }'

Cancels a rework order opened by mistake, with a reason (recorded in the audit log). Its unit is free to be reserved again (unless another rework is open on it), and a cancelled retrofit stamps nothing, so the unit still needs the ECO. Only an order nothing has been fitted or removed under can be cancelled, and not an RMA repair (complete it to return the unit).

Required scope: service:write.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Request Body^required

Media typeapplication/json

object

reason

required

Why the order is cancelled (recorded in the audit log).

string

Example ^generated

{
  "reason": "example"
}

Responses

200

OK

Media typeapplication/json

object

id

required

string format: uuid

orderNumber

required

The order’s number within the organization, e.g. RW-0001

string

serialId

required

string format: uuid

reason

required

string

ecoId

string format: uuid

status

required

string

serialNumber

Human-readable serial number of the unit being reworked (read-only).

string

ecoNumber

ECO number, when the order is ECO-linked (read-only).

string

nullable

ecoTitle

ECO title, when the order is ECO-linked (read-only).

string

nullable

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "orderNumber": "example",
  "serialId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "reason": "example",
  "ecoId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "status": "example",
  "serialNumber": "example",
  "ecoNumber": "example",
  "ecoTitle": "example"
}

400

The reason is missing

Media typeapplication/json

object

error

required

string

Example ^generated

{
  "error": "example"
}

401

Unauthorized

403

Forbidden (the caller lacks service:write)

404

Not found

409

The order is already completed or cancelled, units have been fitted or removed under it, or it is an RMA repair

Media typeapplication/json

object

error

required

string

Example ^generated

{
  "error": "example"
}