Skip to content
BuildTrace Docs

Reserve a build order

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

Required scope: production:write.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Request Body

Section titled “Request Body”
Media typeapplication/json
object
expectedVersion

Optional optimistic-lock guard. When supplied and it does not match the build order’s current version, the operation returns 409 with the current version so the caller can retry.

integer

Example generated

{
  "expectedVersion": 1
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
id
required
string format: uuid
orderNumber
required

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

string
assemblyRevisionId
required
string format: uuid
targetQty
required
integer
consumeFromLocationId
string format: uuid
produceToLocationId
string format: uuid
status
required
string
version
required
integer
partCode

Code of the assembly’s part (read-only; populated by list/detail reads).

string
partName

Name of the assembly’s part (read-only; populated by list/detail reads).

string
revisionLabel

Label of the assembly revision (read-only; populated by list/detail reads).

string
consumeFromLocationCode

Code of the consume-from location (read-only; populated by list/detail reads).

string
consumeFromLocationName

Name of the consume-from location (read-only; populated by list/detail reads).

string
produceToLocationCode

Code of the produce-to location (read-only; populated by list/detail reads).

string
produceToLocationName

Name of the produce-to location (read-only; populated by list/detail reads).

string

Example generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "orderNumber": "example",
  "assemblyRevisionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "targetQty": 1,
  "consumeFromLocationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "produceToLocationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "status": "example",
  "version": 1,
  "partCode": "example",
  "partName": "example",
  "revisionLabel": "example",
  "consumeFromLocationCode": "example",
  "consumeFromLocationName": "example",
  "produceToLocationCode": "example",
  "produceToLocationName": "example"
}

401

Section titled “401”

Unauthorized

404

Section titled “404”

Not found

409

Section titled “409”

Conflict: a version conflict, unacknowledged ECOs, not enough stock, or an OBSOLETE part (the assembly, or a part on the order’s lines; a top-up of an order already reserved is not refused for it). The error message names what is in the way.

Media typeapplication/json
object
error
required
string
currentVersion
required
integer

Example generated

{
  "error": "example",
  "currentVersion": 1
}