The Build Order Management section of the InvenTree API schema is documented below.
InvenTree API 294¶
API for InvenTree - the intuitive open source inventory management system
License: MIT
Servers¶
| Description | URL |
|---|---|
| http://localhost:8000 | http://localhost:8000 |
build¶
GET /api/build/¶
Description
Override the 'get' method to check for the export query parameter.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
active |
query | boolean | No | Build is active | |
ancestor |
query | string | No | Ancestor Build | |
assigned_to |
query | integer | No | Assigned To | |
assigned_to_me |
query | boolean | No | Assigned to me | |
completed_after |
query | string | No | Completed after | |
completed_before |
query | string | No | Completed before | |
created_after |
query | string | No | Created after | |
created_before |
query | string | No | Created before | |
has_project_code |
query | boolean | No | has_project_code | |
include_variants |
query | boolean | No | Include Variants | |
issued_by |
query | integer | No | Issued By | |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
outstanding |
query | boolean | No | Build is outstanding | |
overdue |
query | boolean | No | Build is overdue | |
parent |
query | integer | No | Parent Build | |
part |
query | integer | No | ||
project_code |
query | integer | No | ||
reference |
query | string | No | Filter by exact reference | |
sales_order |
query | integer | No | ||
search |
query | string | No | A search term. | |
status |
query | integer | No | Status | |
target_date_after |
query | string | No | Target date after | |
target_date_before |
query | string | No | Target date before |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"barcode_hash": "string",
"batch": "string",
"completed": 0,
"completion_date": "2022-04-13",
"create_child_builds": true,
"creation_date": "2022-04-13",
"destination": 0,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"overdue": true,
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"quantity": 10.12,
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"sales_order": 0,
"status": null,
"status_custom_key": null,
"status_text": "string",
"take_from": 0,
"target_date": "2022-04-13",
"title": "string",
"url": "string"
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/Build"
},
"type": "array"
}
},
"type": "object"
}
POST /api/build/¶
Description
API endpoint for accessing a list of Build objects.
- GET: Return list of objects (with filters)
- POST: Create a new Build object
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"barcode_hash": "string",
"batch": "string",
"completed": 0,
"completion_date": "2022-04-13",
"create_child_builds": true,
"creation_date": "2022-04-13",
"destination": 0,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"overdue": true,
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"quantity": 10.12,
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"sales_order": 0,
"status": null,
"status_custom_key": null,
"status_text": "string",
"take_from": 0,
"target_date": "2022-04-13",
"title": "string",
"url": "string"
}
Schema of the request body
{
"description": "Serializes a Build object.",
"properties": {
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"batch": {
"description": "Batch code for this build output",
"maxLength": 100,
"nullable": true,
"title": "Batch Code",
"type": "string"
},
"completed": {
"description": "Number of stock items which have been completed",
"readOnly": true,
"title": "Completed items",
"type": "integer"
},
"completion_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"create_child_builds": {
"default": false,
"description": "Automatically generate child build orders",
"type": "boolean",
"writeOnly": true
},
"creation_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"destination": {
"description": "Select location where the completed items will be stored",
"nullable": true,
"title": "Destination Location",
"type": "integer"
},
"issued_by": {
"description": "User who issued this build order",
"nullable": true,
"type": "integer"
},
"issued_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
},
"level": {
"readOnly": true,
"title": "Build Level",
"type": "integer"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"title": "External Link",
"type": "string"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"parent": {
"description": "BuildOrder to which this build is allocated",
"nullable": true,
"title": "Parent Build",
"type": "integer"
},
"part": {
"description": "Select part to build",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"priority": {
"description": "Priority of this build order",
"minimum": 0,
"title": "Build Priority",
"type": "integer"
},
"project_code": {
"description": "Project code for this build order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this build order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"sales_order": {
"description": "SalesOrder to which this build is allocated",
"nullable": true,
"title": "Sales Order Reference",
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/StatusC2fEnum"
}
],
"description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"readOnly": true,
"title": "Build Status"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/StatusCustomKeyC2fEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"take_from": {
"description": "Select location to take stock from for this build (leave blank to take from any stock location)",
"nullable": true,
"title": "Source Location",
"type": "integer"
},
"target_date": {
"description": "Target date for build completion. Build will be overdue after this date.",
"format": "date",
"nullable": true,
"title": "Target completion date",
"type": "string"
},
"title": {
"description": "Brief description of the build (optional)",
"maxLength": 100,
"title": "Description",
"type": "string"
},
"url": {
"readOnly": true,
"type": "string"
}
},
"required": [
"barcode_hash",
"completed",
"creation_date",
"issued_by_detail",
"level",
"overdue",
"part",
"part_detail",
"part_name",
"pk",
"project_code_detail",
"project_code_label",
"quantity",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"url"
],
"type": "object"
}
{
"barcode_hash": "string",
"batch": "string",
"completed": 0,
"completion_date": "2022-04-13",
"create_child_builds": true,
"creation_date": "2022-04-13",
"destination": 0,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"overdue": true,
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"quantity": 10.12,
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"sales_order": 0,
"status": null,
"status_custom_key": null,
"status_text": "string",
"take_from": 0,
"target_date": "2022-04-13",
"title": "string",
"url": "string"
}
Schema of the request body
{
"description": "Serializes a Build object.",
"properties": {
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"batch": {
"description": "Batch code for this build output",
"maxLength": 100,
"nullable": true,
"title": "Batch Code",
"type": "string"
},
"completed": {
"description": "Number of stock items which have been completed",
"readOnly": true,
"title": "Completed items",
"type": "integer"
},
"completion_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"create_child_builds": {
"default": false,
"description": "Automatically generate child build orders",
"type": "boolean",
"writeOnly": true
},
"creation_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"destination": {
"description": "Select location where the completed items will be stored",
"nullable": true,
"title": "Destination Location",
"type": "integer"
},
"issued_by": {
"description": "User who issued this build order",
"nullable": true,
"type": "integer"
},
"issued_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
},
"level": {
"readOnly": true,
"title": "Build Level",
"type": "integer"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"title": "External Link",
"type": "string"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"parent": {
"description": "BuildOrder to which this build is allocated",
"nullable": true,
"title": "Parent Build",
"type": "integer"
},
"part": {
"description": "Select part to build",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"priority": {
"description": "Priority of this build order",
"minimum": 0,
"title": "Build Priority",
"type": "integer"
},
"project_code": {
"description": "Project code for this build order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this build order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"sales_order": {
"description": "SalesOrder to which this build is allocated",
"nullable": true,
"title": "Sales Order Reference",
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/StatusC2fEnum"
}
],
"description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"readOnly": true,
"title": "Build Status"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/StatusCustomKeyC2fEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"take_from": {
"description": "Select location to take stock from for this build (leave blank to take from any stock location)",
"nullable": true,
"title": "Source Location",
"type": "integer"
},
"target_date": {
"description": "Target date for build completion. Build will be overdue after this date.",
"format": "date",
"nullable": true,
"title": "Target completion date",
"type": "string"
},
"title": {
"description": "Brief description of the build (optional)",
"maxLength": 100,
"title": "Description",
"type": "string"
},
"url": {
"readOnly": true,
"type": "string"
}
},
"required": [
"barcode_hash",
"completed",
"creation_date",
"issued_by_detail",
"level",
"overdue",
"part",
"part_detail",
"part_name",
"pk",
"project_code_detail",
"project_code_label",
"quantity",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"url"
],
"type": "object"
}
{
"barcode_hash": "string",
"batch": "string",
"completed": 0,
"completion_date": "2022-04-13",
"create_child_builds": true,
"creation_date": "2022-04-13",
"destination": 0,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"overdue": true,
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"quantity": 10.12,
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"sales_order": 0,
"status": null,
"status_custom_key": null,
"status_text": "string",
"take_from": 0,
"target_date": "2022-04-13",
"title": "string",
"url": "string"
}
Schema of the request body
{
"description": "Serializes a Build object.",
"properties": {
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"batch": {
"description": "Batch code for this build output",
"maxLength": 100,
"nullable": true,
"title": "Batch Code",
"type": "string"
},
"completed": {
"description": "Number of stock items which have been completed",
"readOnly": true,
"title": "Completed items",
"type": "integer"
},
"completion_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"create_child_builds": {
"default": false,
"description": "Automatically generate child build orders",
"type": "boolean",
"writeOnly": true
},
"creation_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"destination": {
"description": "Select location where the completed items will be stored",
"nullable": true,
"title": "Destination Location",
"type": "integer"
},
"issued_by": {
"description": "User who issued this build order",
"nullable": true,
"type": "integer"
},
"issued_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
},
"level": {
"readOnly": true,
"title": "Build Level",
"type": "integer"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"title": "External Link",
"type": "string"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"parent": {
"description": "BuildOrder to which this build is allocated",
"nullable": true,
"title": "Parent Build",
"type": "integer"
},
"part": {
"description": "Select part to build",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"priority": {
"description": "Priority of this build order",
"minimum": 0,
"title": "Build Priority",
"type": "integer"
},
"project_code": {
"description": "Project code for this build order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this build order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"sales_order": {
"description": "SalesOrder to which this build is allocated",
"nullable": true,
"title": "Sales Order Reference",
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/StatusC2fEnum"
}
],
"description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"readOnly": true,
"title": "Build Status"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/StatusCustomKeyC2fEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"take_from": {
"description": "Select location to take stock from for this build (leave blank to take from any stock location)",
"nullable": true,
"title": "Source Location",
"type": "integer"
},
"target_date": {
"description": "Target date for build completion. Build will be overdue after this date.",
"format": "date",
"nullable": true,
"title": "Target completion date",
"type": "string"
},
"title": {
"description": "Brief description of the build (optional)",
"maxLength": 100,
"title": "Description",
"type": "string"
},
"url": {
"readOnly": true,
"type": "string"
}
},
"required": [
"barcode_hash",
"completed",
"creation_date",
"issued_by_detail",
"level",
"overdue",
"part",
"part_detail",
"part_name",
"pk",
"project_code_detail",
"project_code_label",
"quantity",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"url"
],
"type": "object"
}
Response 201 Created
{
"barcode_hash": "string",
"batch": "string",
"completed": 0,
"completion_date": "2022-04-13",
"create_child_builds": true,
"creation_date": "2022-04-13",
"destination": 0,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"overdue": true,
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"quantity": 10.12,
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"sales_order": 0,
"status": null,
"status_custom_key": null,
"status_text": "string",
"take_from": 0,
"target_date": "2022-04-13",
"title": "string",
"url": "string"
}
Schema of the response body
{
"description": "Serializes a Build object.",
"properties": {
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"batch": {
"description": "Batch code for this build output",
"maxLength": 100,
"nullable": true,
"title": "Batch Code",
"type": "string"
},
"completed": {
"description": "Number of stock items which have been completed",
"readOnly": true,
"title": "Completed items",
"type": "integer"
},
"completion_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"create_child_builds": {
"default": false,
"description": "Automatically generate child build orders",
"type": "boolean",
"writeOnly": true
},
"creation_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"destination": {
"description": "Select location where the completed items will be stored",
"nullable": true,
"title": "Destination Location",
"type": "integer"
},
"issued_by": {
"description": "User who issued this build order",
"nullable": true,
"type": "integer"
},
"issued_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
},
"level": {
"readOnly": true,
"title": "Build Level",
"type": "integer"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"title": "External Link",
"type": "string"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"parent": {
"description": "BuildOrder to which this build is allocated",
"nullable": true,
"title": "Parent Build",
"type": "integer"
},
"part": {
"description": "Select part to build",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"priority": {
"description": "Priority of this build order",
"minimum": 0,
"title": "Build Priority",
"type": "integer"
},
"project_code": {
"description": "Project code for this build order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this build order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"sales_order": {
"description": "SalesOrder to which this build is allocated",
"nullable": true,
"title": "Sales Order Reference",
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/StatusC2fEnum"
}
],
"description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"readOnly": true,
"title": "Build Status"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/StatusCustomKeyC2fEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"take_from": {
"description": "Select location to take stock from for this build (leave blank to take from any stock location)",
"nullable": true,
"title": "Source Location",
"type": "integer"
},
"target_date": {
"description": "Target date for build completion. Build will be overdue after this date.",
"format": "date",
"nullable": true,
"title": "Target completion date",
"type": "string"
},
"title": {
"description": "Brief description of the build (optional)",
"maxLength": 100,
"title": "Description",
"type": "string"
},
"url": {
"readOnly": true,
"type": "string"
}
},
"required": [
"barcode_hash",
"completed",
"creation_date",
"issued_by_detail",
"level",
"overdue",
"part",
"part_detail",
"part_name",
"pk",
"project_code_detail",
"project_code_label",
"quantity",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"url"
],
"type": "object"
}
DELETE /api/build/item/¶
Description
Perform a DELETE operation against this list endpoint.
We expect a list of primary-key (ID) values to be supplied as a JSON object, e.g. { items: [4, 8, 15, 16, 23, 42] }
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 204 No Content
GET /api/build/item/¶
Description
Override the 'get' method to check for the export query parameter.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
build |
query | integer | No | Build Order | |
build_line |
query | integer | No | ||
include_variants |
query | boolean | No | Include Variants | |
install_into |
query | integer | No | ||
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
part |
query | integer | No | Part | |
search |
query | string | No | A search term. | |
stock_item |
query | integer | No | ||
tracked |
query | boolean | No | Tracked |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"bom_reference": "string",
"build": 0,
"build_line": 0,
"install_into": 0,
"item_serial_number": "string",
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/BuildItem"
},
"type": "array"
}
},
"type": "object"
}
POST /api/build/item/¶
Description
API endpoint for accessing a list of BuildItem objects.
- GET: Return list of objects
- POST: Create a new BuildItem object
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"bom_reference": "string",
"build": 0,
"build_line": 0,
"install_into": 0,
"item_serial_number": "string",
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
Schema of the request body
{
"description": "Serializes a BuildItem object, which is an allocation of a stock item against a build order.",
"properties": {
"bom_reference": {
"readOnly": true,
"type": "string"
},
"build": {
"readOnly": true,
"type": "integer"
},
"build_line": {
"nullable": true,
"type": "integer"
},
"install_into": {
"description": "Destination stock item",
"nullable": true,
"type": "integer"
},
"item_serial_number": {
"readOnly": true,
"title": "Serial Number",
"type": "string"
},
"location": {
"readOnly": true,
"type": "integer"
},
"location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"title": "Allocated Quantity",
"type": "number"
},
"stock_item": {
"description": "Source stock item",
"type": "integer"
},
"stock_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItemSerializerBrief"
}
],
"readOnly": true
},
"supplier_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"readOnly": true
}
},
"required": [
"bom_reference",
"build",
"build_line",
"install_into",
"item_serial_number",
"location",
"location_detail",
"part_detail",
"pk",
"quantity",
"stock_item",
"stock_item_detail",
"supplier_part_detail"
],
"type": "object"
}
{
"bom_reference": "string",
"build": 0,
"build_line": 0,
"install_into": 0,
"item_serial_number": "string",
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
Schema of the request body
{
"description": "Serializes a BuildItem object, which is an allocation of a stock item against a build order.",
"properties": {
"bom_reference": {
"readOnly": true,
"type": "string"
},
"build": {
"readOnly": true,
"type": "integer"
},
"build_line": {
"nullable": true,
"type": "integer"
},
"install_into": {
"description": "Destination stock item",
"nullable": true,
"type": "integer"
},
"item_serial_number": {
"readOnly": true,
"title": "Serial Number",
"type": "string"
},
"location": {
"readOnly": true,
"type": "integer"
},
"location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"title": "Allocated Quantity",
"type": "number"
},
"stock_item": {
"description": "Source stock item",
"type": "integer"
},
"stock_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItemSerializerBrief"
}
],
"readOnly": true
},
"supplier_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"readOnly": true
}
},
"required": [
"bom_reference",
"build",
"build_line",
"install_into",
"item_serial_number",
"location",
"location_detail",
"part_detail",
"pk",
"quantity",
"stock_item",
"stock_item_detail",
"supplier_part_detail"
],
"type": "object"
}
{
"bom_reference": "string",
"build": 0,
"build_line": 0,
"install_into": 0,
"item_serial_number": "string",
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
Schema of the request body
{
"description": "Serializes a BuildItem object, which is an allocation of a stock item against a build order.",
"properties": {
"bom_reference": {
"readOnly": true,
"type": "string"
},
"build": {
"readOnly": true,
"type": "integer"
},
"build_line": {
"nullable": true,
"type": "integer"
},
"install_into": {
"description": "Destination stock item",
"nullable": true,
"type": "integer"
},
"item_serial_number": {
"readOnly": true,
"title": "Serial Number",
"type": "string"
},
"location": {
"readOnly": true,
"type": "integer"
},
"location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"title": "Allocated Quantity",
"type": "number"
},
"stock_item": {
"description": "Source stock item",
"type": "integer"
},
"stock_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItemSerializerBrief"
}
],
"readOnly": true
},
"supplier_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"readOnly": true
}
},
"required": [
"bom_reference",
"build",
"build_line",
"install_into",
"item_serial_number",
"location",
"location_detail",
"part_detail",
"pk",
"quantity",
"stock_item",
"stock_item_detail",
"supplier_part_detail"
],
"type": "object"
}
Response 201 Created
{
"bom_reference": "string",
"build": 0,
"build_line": 0,
"install_into": 0,
"item_serial_number": "string",
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
Schema of the response body
{
"description": "Serializes a BuildItem object, which is an allocation of a stock item against a build order.",
"properties": {
"bom_reference": {
"readOnly": true,
"type": "string"
},
"build": {
"readOnly": true,
"type": "integer"
},
"build_line": {
"nullable": true,
"type": "integer"
},
"install_into": {
"description": "Destination stock item",
"nullable": true,
"type": "integer"
},
"item_serial_number": {
"readOnly": true,
"title": "Serial Number",
"type": "string"
},
"location": {
"readOnly": true,
"type": "integer"
},
"location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"title": "Allocated Quantity",
"type": "number"
},
"stock_item": {
"description": "Source stock item",
"type": "integer"
},
"stock_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItemSerializerBrief"
}
],
"readOnly": true
},
"supplier_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"readOnly": true
}
},
"required": [
"bom_reference",
"build",
"build_line",
"install_into",
"item_serial_number",
"location",
"location_detail",
"part_detail",
"pk",
"quantity",
"stock_item",
"stock_item_detail",
"supplier_part_detail"
],
"type": "object"
}
DELETE /api/build/item/{id}/¶
Description
API endpoint for detail view of a BuildItem object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/build/item/{id}/¶
Description
API endpoint for detail view of a BuildItem object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"bom_reference": "string",
"build": 0,
"build_line": 0,
"install_into": 0,
"item_serial_number": "string",
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
Schema of the response body
{
"description": "Serializes a BuildItem object, which is an allocation of a stock item against a build order.",
"properties": {
"bom_reference": {
"readOnly": true,
"type": "string"
},
"build": {
"readOnly": true,
"type": "integer"
},
"build_line": {
"nullable": true,
"type": "integer"
},
"install_into": {
"description": "Destination stock item",
"nullable": true,
"type": "integer"
},
"item_serial_number": {
"readOnly": true,
"title": "Serial Number",
"type": "string"
},
"location": {
"readOnly": true,
"type": "integer"
},
"location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"title": "Allocated Quantity",
"type": "number"
},
"stock_item": {
"description": "Source stock item",
"type": "integer"
},
"stock_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItemSerializerBrief"
}
],
"readOnly": true
},
"supplier_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"readOnly": true
}
},
"required": [
"bom_reference",
"build",
"build_line",
"install_into",
"item_serial_number",
"location",
"location_detail",
"part_detail",
"pk",
"quantity",
"stock_item",
"stock_item_detail",
"supplier_part_detail"
],
"type": "object"
}
PATCH /api/build/item/{id}/¶
Description
API endpoint for detail view of a BuildItem object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"bom_reference": "string",
"build": 0,
"build_line": 0,
"install_into": 0,
"item_serial_number": "string",
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
Schema of the request body
{
"description": "Serializes a BuildItem object, which is an allocation of a stock item against a build order.",
"properties": {
"bom_reference": {
"readOnly": true,
"type": "string"
},
"build": {
"readOnly": true,
"type": "integer"
},
"build_line": {
"nullable": true,
"type": "integer"
},
"install_into": {
"description": "Destination stock item",
"nullable": true,
"type": "integer"
},
"item_serial_number": {
"readOnly": true,
"title": "Serial Number",
"type": "string"
},
"location": {
"readOnly": true,
"type": "integer"
},
"location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"title": "Allocated Quantity",
"type": "number"
},
"stock_item": {
"description": "Source stock item",
"type": "integer"
},
"stock_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItemSerializerBrief"
}
],
"readOnly": true
},
"supplier_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"readOnly": true
}
},
"type": "object"
}
{
"bom_reference": "string",
"build": 0,
"build_line": 0,
"install_into": 0,
"item_serial_number": "string",
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
Schema of the request body
{
"description": "Serializes a BuildItem object, which is an allocation of a stock item against a build order.",
"properties": {
"bom_reference": {
"readOnly": true,
"type": "string"
},
"build": {
"readOnly": true,
"type": "integer"
},
"build_line": {
"nullable": true,
"type": "integer"
},
"install_into": {
"description": "Destination stock item",
"nullable": true,
"type": "integer"
},
"item_serial_number": {
"readOnly": true,
"title": "Serial Number",
"type": "string"
},
"location": {
"readOnly": true,
"type": "integer"
},
"location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"title": "Allocated Quantity",
"type": "number"
},
"stock_item": {
"description": "Source stock item",
"type": "integer"
},
"stock_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItemSerializerBrief"
}
],
"readOnly": true
},
"supplier_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"readOnly": true
}
},
"type": "object"
}
{
"bom_reference": "string",
"build": 0,
"build_line": 0,
"install_into": 0,
"item_serial_number": "string",
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
Schema of the request body
{
"description": "Serializes a BuildItem object, which is an allocation of a stock item against a build order.",
"properties": {
"bom_reference": {
"readOnly": true,
"type": "string"
},
"build": {
"readOnly": true,
"type": "integer"
},
"build_line": {
"nullable": true,
"type": "integer"
},
"install_into": {
"description": "Destination stock item",
"nullable": true,
"type": "integer"
},
"item_serial_number": {
"readOnly": true,
"title": "Serial Number",
"type": "string"
},
"location": {
"readOnly": true,
"type": "integer"
},
"location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"title": "Allocated Quantity",
"type": "number"
},
"stock_item": {
"description": "Source stock item",
"type": "integer"
},
"stock_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItemSerializerBrief"
}
],
"readOnly": true
},
"supplier_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"readOnly": true
}
},
"type": "object"
}
Response 200 OK
{
"bom_reference": "string",
"build": 0,
"build_line": 0,
"install_into": 0,
"item_serial_number": "string",
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
Schema of the response body
{
"description": "Serializes a BuildItem object, which is an allocation of a stock item against a build order.",
"properties": {
"bom_reference": {
"readOnly": true,
"type": "string"
},
"build": {
"readOnly": true,
"type": "integer"
},
"build_line": {
"nullable": true,
"type": "integer"
},
"install_into": {
"description": "Destination stock item",
"nullable": true,
"type": "integer"
},
"item_serial_number": {
"readOnly": true,
"title": "Serial Number",
"type": "string"
},
"location": {
"readOnly": true,
"type": "integer"
},
"location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"title": "Allocated Quantity",
"type": "number"
},
"stock_item": {
"description": "Source stock item",
"type": "integer"
},
"stock_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItemSerializerBrief"
}
],
"readOnly": true
},
"supplier_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"readOnly": true
}
},
"required": [
"bom_reference",
"build",
"build_line",
"install_into",
"item_serial_number",
"location",
"location_detail",
"part_detail",
"pk",
"quantity",
"stock_item",
"stock_item_detail",
"supplier_part_detail"
],
"type": "object"
}
PUT /api/build/item/{id}/¶
Description
API endpoint for detail view of a BuildItem object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"bom_reference": "string",
"build": 0,
"build_line": 0,
"install_into": 0,
"item_serial_number": "string",
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
Schema of the request body
{
"description": "Serializes a BuildItem object, which is an allocation of a stock item against a build order.",
"properties": {
"bom_reference": {
"readOnly": true,
"type": "string"
},
"build": {
"readOnly": true,
"type": "integer"
},
"build_line": {
"nullable": true,
"type": "integer"
},
"install_into": {
"description": "Destination stock item",
"nullable": true,
"type": "integer"
},
"item_serial_number": {
"readOnly": true,
"title": "Serial Number",
"type": "string"
},
"location": {
"readOnly": true,
"type": "integer"
},
"location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"title": "Allocated Quantity",
"type": "number"
},
"stock_item": {
"description": "Source stock item",
"type": "integer"
},
"stock_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItemSerializerBrief"
}
],
"readOnly": true
},
"supplier_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"readOnly": true
}
},
"required": [
"bom_reference",
"build",
"build_line",
"install_into",
"item_serial_number",
"location",
"location_detail",
"part_detail",
"pk",
"quantity",
"stock_item",
"stock_item_detail",
"supplier_part_detail"
],
"type": "object"
}
{
"bom_reference": "string",
"build": 0,
"build_line": 0,
"install_into": 0,
"item_serial_number": "string",
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
Schema of the request body
{
"description": "Serializes a BuildItem object, which is an allocation of a stock item against a build order.",
"properties": {
"bom_reference": {
"readOnly": true,
"type": "string"
},
"build": {
"readOnly": true,
"type": "integer"
},
"build_line": {
"nullable": true,
"type": "integer"
},
"install_into": {
"description": "Destination stock item",
"nullable": true,
"type": "integer"
},
"item_serial_number": {
"readOnly": true,
"title": "Serial Number",
"type": "string"
},
"location": {
"readOnly": true,
"type": "integer"
},
"location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"title": "Allocated Quantity",
"type": "number"
},
"stock_item": {
"description": "Source stock item",
"type": "integer"
},
"stock_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItemSerializerBrief"
}
],
"readOnly": true
},
"supplier_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"readOnly": true
}
},
"required": [
"bom_reference",
"build",
"build_line",
"install_into",
"item_serial_number",
"location",
"location_detail",
"part_detail",
"pk",
"quantity",
"stock_item",
"stock_item_detail",
"supplier_part_detail"
],
"type": "object"
}
{
"bom_reference": "string",
"build": 0,
"build_line": 0,
"install_into": 0,
"item_serial_number": "string",
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
Schema of the request body
{
"description": "Serializes a BuildItem object, which is an allocation of a stock item against a build order.",
"properties": {
"bom_reference": {
"readOnly": true,
"type": "string"
},
"build": {
"readOnly": true,
"type": "integer"
},
"build_line": {
"nullable": true,
"type": "integer"
},
"install_into": {
"description": "Destination stock item",
"nullable": true,
"type": "integer"
},
"item_serial_number": {
"readOnly": true,
"title": "Serial Number",
"type": "string"
},
"location": {
"readOnly": true,
"type": "integer"
},
"location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"title": "Allocated Quantity",
"type": "number"
},
"stock_item": {
"description": "Source stock item",
"type": "integer"
},
"stock_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItemSerializerBrief"
}
],
"readOnly": true
},
"supplier_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"readOnly": true
}
},
"required": [
"bom_reference",
"build",
"build_line",
"install_into",
"item_serial_number",
"location",
"location_detail",
"part_detail",
"pk",
"quantity",
"stock_item",
"stock_item_detail",
"supplier_part_detail"
],
"type": "object"
}
Response 200 OK
{
"bom_reference": "string",
"build": 0,
"build_line": 0,
"install_into": 0,
"item_serial_number": "string",
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
Schema of the response body
{
"description": "Serializes a BuildItem object, which is an allocation of a stock item against a build order.",
"properties": {
"bom_reference": {
"readOnly": true,
"type": "string"
},
"build": {
"readOnly": true,
"type": "integer"
},
"build_line": {
"nullable": true,
"type": "integer"
},
"install_into": {
"description": "Destination stock item",
"nullable": true,
"type": "integer"
},
"item_serial_number": {
"readOnly": true,
"title": "Serial Number",
"type": "string"
},
"location": {
"readOnly": true,
"type": "integer"
},
"location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"title": "Allocated Quantity",
"type": "number"
},
"stock_item": {
"description": "Source stock item",
"type": "integer"
},
"stock_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItemSerializerBrief"
}
],
"readOnly": true
},
"supplier_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"readOnly": true
}
},
"required": [
"bom_reference",
"build",
"build_line",
"install_into",
"item_serial_number",
"location",
"location_detail",
"part_detail",
"pk",
"quantity",
"stock_item",
"stock_item_detail",
"supplier_part_detail"
],
"type": "object"
}
GET /api/build/item/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PATCH /api/build/item/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PUT /api/build/item/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
GET /api/build/line/¶
Description
Override the 'get' method to check for the export query parameter.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
allocated |
query | boolean | No | Allocated | |
assembly |
query | boolean | No | Assembly | |
available |
query | boolean | No | Available | |
bom_item |
query | integer | No | ||
build |
query | integer | No | ||
consumable |
query | boolean | No | Consumable | |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
optional |
query | boolean | No | Optional | |
order_outstanding |
query | boolean | No | Order Outstanding | |
ordering |
query | string | No | Which field to use when ordering the results. | |
part |
query | integer | No | Part | |
search |
query | string | No | A search term. | |
testable |
query | boolean | No | Testable | |
tracked |
query | boolean | No | Tracked |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"allocated": 10.12,
"allocations": [
{
"bom_reference": "string",
"build": 0,
"build_line": 0,
"install_into": 0,
"item_serial_number": "string",
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
],
"allow_variants": true,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_reference": "string",
"consumable": true,
"external_stock": 10.12,
"in_production": 10.12,
"inherited": true,
"on_order": 10.12,
"optional": true,
"part": 0,
"part_IPN": "string",
"part_category_id": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"quantity": 10.12,
"reference": "string",
"testable": true,
"trackable": true
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/BuildLine"
},
"type": "array"
}
},
"type": "object"
}
POST /api/build/line/¶
Description
API endpoint for accessing a list of BuildLine objects
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"allocated": 10.12,
"allocations": [
{
"bom_reference": "string",
"build": 0,
"build_line": 0,
"install_into": 0,
"item_serial_number": "string",
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
],
"allow_variants": true,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_reference": "string",
"consumable": true,
"external_stock": 10.12,
"in_production": 10.12,
"inherited": true,
"on_order": 10.12,
"optional": true,
"part": 0,
"part_IPN": "string",
"part_category_id": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"quantity": 10.12,
"reference": "string",
"testable": true,
"trackable": true
}
Schema of the request body
{
"description": "Serializer for a BuildItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"title": "Allocated Stock",
"type": "number"
},
"allocations": {
"items": {
"$ref": "#/components/schemas/BuildItem"
},
"readOnly": true,
"type": "array"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"available_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_substitute_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"bom_item": {
"readOnly": true,
"type": "integer"
},
"bom_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/BomItem"
}
],
"readOnly": true
},
"build": {
"description": "Build object",
"readOnly": true,
"type": "integer"
},
"build_reference": {
"readOnly": true,
"type": "string"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"in_production": {
"format": "double",
"readOnly": true,
"type": "number"
},
"inherited": {
"readOnly": true,
"type": "boolean"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"optional": {
"readOnly": true,
"type": "boolean"
},
"part": {
"readOnly": true,
"type": "integer"
},
"part_IPN": {
"readOnly": true,
"type": "string"
},
"part_category_id": {
"readOnly": true,
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"allocated",
"allocations",
"allow_variants",
"available_stock",
"available_substitute_stock",
"available_variant_stock",
"bom_item",
"bom_item_detail",
"build",
"build_reference",
"consumable",
"external_stock",
"in_production",
"inherited",
"on_order",
"optional",
"part",
"part_IPN",
"part_category_id",
"part_detail",
"part_name",
"pk",
"quantity",
"reference",
"testable",
"trackable"
],
"type": "object"
}
{
"allocated": 10.12,
"allocations": [
{
"bom_reference": "string",
"build": 0,
"build_line": 0,
"install_into": 0,
"item_serial_number": "string",
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
],
"allow_variants": true,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_reference": "string",
"consumable": true,
"external_stock": 10.12,
"in_production": 10.12,
"inherited": true,
"on_order": 10.12,
"optional": true,
"part": 0,
"part_IPN": "string",
"part_category_id": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"quantity": 10.12,
"reference": "string",
"testable": true,
"trackable": true
}
Schema of the request body
{
"description": "Serializer for a BuildItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"title": "Allocated Stock",
"type": "number"
},
"allocations": {
"items": {
"$ref": "#/components/schemas/BuildItem"
},
"readOnly": true,
"type": "array"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"available_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_substitute_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"bom_item": {
"readOnly": true,
"type": "integer"
},
"bom_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/BomItem"
}
],
"readOnly": true
},
"build": {
"description": "Build object",
"readOnly": true,
"type": "integer"
},
"build_reference": {
"readOnly": true,
"type": "string"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"in_production": {
"format": "double",
"readOnly": true,
"type": "number"
},
"inherited": {
"readOnly": true,
"type": "boolean"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"optional": {
"readOnly": true,
"type": "boolean"
},
"part": {
"readOnly": true,
"type": "integer"
},
"part_IPN": {
"readOnly": true,
"type": "string"
},
"part_category_id": {
"readOnly": true,
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"allocated",
"allocations",
"allow_variants",
"available_stock",
"available_substitute_stock",
"available_variant_stock",
"bom_item",
"bom_item_detail",
"build",
"build_reference",
"consumable",
"external_stock",
"in_production",
"inherited",
"on_order",
"optional",
"part",
"part_IPN",
"part_category_id",
"part_detail",
"part_name",
"pk",
"quantity",
"reference",
"testable",
"trackable"
],
"type": "object"
}
{
"allocated": 10.12,
"allocations": [
{
"bom_reference": "string",
"build": 0,
"build_line": 0,
"install_into": 0,
"item_serial_number": "string",
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
],
"allow_variants": true,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_reference": "string",
"consumable": true,
"external_stock": 10.12,
"in_production": 10.12,
"inherited": true,
"on_order": 10.12,
"optional": true,
"part": 0,
"part_IPN": "string",
"part_category_id": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"quantity": 10.12,
"reference": "string",
"testable": true,
"trackable": true
}
Schema of the request body
{
"description": "Serializer for a BuildItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"title": "Allocated Stock",
"type": "number"
},
"allocations": {
"items": {
"$ref": "#/components/schemas/BuildItem"
},
"readOnly": true,
"type": "array"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"available_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_substitute_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"bom_item": {
"readOnly": true,
"type": "integer"
},
"bom_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/BomItem"
}
],
"readOnly": true
},
"build": {
"description": "Build object",
"readOnly": true,
"type": "integer"
},
"build_reference": {
"readOnly": true,
"type": "string"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"in_production": {
"format": "double",
"readOnly": true,
"type": "number"
},
"inherited": {
"readOnly": true,
"type": "boolean"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"optional": {
"readOnly": true,
"type": "boolean"
},
"part": {
"readOnly": true,
"type": "integer"
},
"part_IPN": {
"readOnly": true,
"type": "string"
},
"part_category_id": {
"readOnly": true,
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"allocated",
"allocations",
"allow_variants",
"available_stock",
"available_substitute_stock",
"available_variant_stock",
"bom_item",
"bom_item_detail",
"build",
"build_reference",
"consumable",
"external_stock",
"in_production",
"inherited",
"on_order",
"optional",
"part",
"part_IPN",
"part_category_id",
"part_detail",
"part_name",
"pk",
"quantity",
"reference",
"testable",
"trackable"
],
"type": "object"
}
Response 201 Created
{
"allocated": 10.12,
"allocations": [
{
"bom_reference": "string",
"build": 0,
"build_line": 0,
"install_into": 0,
"item_serial_number": "string",
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
],
"allow_variants": true,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_reference": "string",
"consumable": true,
"external_stock": 10.12,
"in_production": 10.12,
"inherited": true,
"on_order": 10.12,
"optional": true,
"part": 0,
"part_IPN": "string",
"part_category_id": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"quantity": 10.12,
"reference": "string",
"testable": true,
"trackable": true
}
Schema of the response body
{
"description": "Serializer for a BuildItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"title": "Allocated Stock",
"type": "number"
},
"allocations": {
"items": {
"$ref": "#/components/schemas/BuildItem"
},
"readOnly": true,
"type": "array"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"available_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_substitute_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"bom_item": {
"readOnly": true,
"type": "integer"
},
"bom_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/BomItem"
}
],
"readOnly": true
},
"build": {
"description": "Build object",
"readOnly": true,
"type": "integer"
},
"build_reference": {
"readOnly": true,
"type": "string"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"in_production": {
"format": "double",
"readOnly": true,
"type": "number"
},
"inherited": {
"readOnly": true,
"type": "boolean"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"optional": {
"readOnly": true,
"type": "boolean"
},
"part": {
"readOnly": true,
"type": "integer"
},
"part_IPN": {
"readOnly": true,
"type": "string"
},
"part_category_id": {
"readOnly": true,
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"allocated",
"allocations",
"allow_variants",
"available_stock",
"available_substitute_stock",
"available_variant_stock",
"bom_item",
"bom_item_detail",
"build",
"build_reference",
"consumable",
"external_stock",
"in_production",
"inherited",
"on_order",
"optional",
"part",
"part_IPN",
"part_category_id",
"part_detail",
"part_name",
"pk",
"quantity",
"reference",
"testable",
"trackable"
],
"type": "object"
}
DELETE /api/build/line/{id}/¶
Description
API endpoint for detail view of a BuildLine object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/build/line/{id}/¶
Description
API endpoint for detail view of a BuildLine object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"allocated": 10.12,
"allocations": [
{
"bom_reference": "string",
"build": 0,
"build_line": 0,
"install_into": 0,
"item_serial_number": "string",
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
],
"allow_variants": true,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_reference": "string",
"consumable": true,
"external_stock": 10.12,
"in_production": 10.12,
"inherited": true,
"on_order": 10.12,
"optional": true,
"part": 0,
"part_IPN": "string",
"part_category_id": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"quantity": 10.12,
"reference": "string",
"testable": true,
"trackable": true
}
Schema of the response body
{
"description": "Serializer for a BuildItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"title": "Allocated Stock",
"type": "number"
},
"allocations": {
"items": {
"$ref": "#/components/schemas/BuildItem"
},
"readOnly": true,
"type": "array"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"available_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_substitute_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"bom_item": {
"readOnly": true,
"type": "integer"
},
"bom_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/BomItem"
}
],
"readOnly": true
},
"build": {
"description": "Build object",
"readOnly": true,
"type": "integer"
},
"build_reference": {
"readOnly": true,
"type": "string"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"in_production": {
"format": "double",
"readOnly": true,
"type": "number"
},
"inherited": {
"readOnly": true,
"type": "boolean"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"optional": {
"readOnly": true,
"type": "boolean"
},
"part": {
"readOnly": true,
"type": "integer"
},
"part_IPN": {
"readOnly": true,
"type": "string"
},
"part_category_id": {
"readOnly": true,
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"allocated",
"allocations",
"allow_variants",
"available_stock",
"available_substitute_stock",
"available_variant_stock",
"bom_item",
"bom_item_detail",
"build",
"build_reference",
"consumable",
"external_stock",
"in_production",
"inherited",
"on_order",
"optional",
"part",
"part_IPN",
"part_category_id",
"part_detail",
"part_name",
"pk",
"quantity",
"reference",
"testable",
"trackable"
],
"type": "object"
}
PATCH /api/build/line/{id}/¶
Description
API endpoint for detail view of a BuildLine object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"allocated": 10.12,
"allocations": [
{
"bom_reference": "string",
"build": 0,
"build_line": 0,
"install_into": 0,
"item_serial_number": "string",
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
],
"allow_variants": true,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_reference": "string",
"consumable": true,
"external_stock": 10.12,
"in_production": 10.12,
"inherited": true,
"on_order": 10.12,
"optional": true,
"part": 0,
"part_IPN": "string",
"part_category_id": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"quantity": 10.12,
"reference": "string",
"testable": true,
"trackable": true
}
Schema of the request body
{
"description": "Serializer for a BuildItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"title": "Allocated Stock",
"type": "number"
},
"allocations": {
"items": {
"$ref": "#/components/schemas/BuildItem"
},
"readOnly": true,
"type": "array"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"available_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_substitute_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"bom_item": {
"readOnly": true,
"type": "integer"
},
"bom_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/BomItem"
}
],
"readOnly": true
},
"build": {
"description": "Build object",
"readOnly": true,
"type": "integer"
},
"build_reference": {
"readOnly": true,
"type": "string"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"in_production": {
"format": "double",
"readOnly": true,
"type": "number"
},
"inherited": {
"readOnly": true,
"type": "boolean"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"optional": {
"readOnly": true,
"type": "boolean"
},
"part": {
"readOnly": true,
"type": "integer"
},
"part_IPN": {
"readOnly": true,
"type": "string"
},
"part_category_id": {
"readOnly": true,
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"type": "object"
}
{
"allocated": 10.12,
"allocations": [
{
"bom_reference": "string",
"build": 0,
"build_line": 0,
"install_into": 0,
"item_serial_number": "string",
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
],
"allow_variants": true,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_reference": "string",
"consumable": true,
"external_stock": 10.12,
"in_production": 10.12,
"inherited": true,
"on_order": 10.12,
"optional": true,
"part": 0,
"part_IPN": "string",
"part_category_id": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"quantity": 10.12,
"reference": "string",
"testable": true,
"trackable": true
}
Schema of the request body
{
"description": "Serializer for a BuildItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"title": "Allocated Stock",
"type": "number"
},
"allocations": {
"items": {
"$ref": "#/components/schemas/BuildItem"
},
"readOnly": true,
"type": "array"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"available_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_substitute_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"bom_item": {
"readOnly": true,
"type": "integer"
},
"bom_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/BomItem"
}
],
"readOnly": true
},
"build": {
"description": "Build object",
"readOnly": true,
"type": "integer"
},
"build_reference": {
"readOnly": true,
"type": "string"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"in_production": {
"format": "double",
"readOnly": true,
"type": "number"
},
"inherited": {
"readOnly": true,
"type": "boolean"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"optional": {
"readOnly": true,
"type": "boolean"
},
"part": {
"readOnly": true,
"type": "integer"
},
"part_IPN": {
"readOnly": true,
"type": "string"
},
"part_category_id": {
"readOnly": true,
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"type": "object"
}
{
"allocated": 10.12,
"allocations": [
{
"bom_reference": "string",
"build": 0,
"build_line": 0,
"install_into": 0,
"item_serial_number": "string",
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
],
"allow_variants": true,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_reference": "string",
"consumable": true,
"external_stock": 10.12,
"in_production": 10.12,
"inherited": true,
"on_order": 10.12,
"optional": true,
"part": 0,
"part_IPN": "string",
"part_category_id": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"quantity": 10.12,
"reference": "string",
"testable": true,
"trackable": true
}
Schema of the request body
{
"description": "Serializer for a BuildItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"title": "Allocated Stock",
"type": "number"
},
"allocations": {
"items": {
"$ref": "#/components/schemas/BuildItem"
},
"readOnly": true,
"type": "array"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"available_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_substitute_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"bom_item": {
"readOnly": true,
"type": "integer"
},
"bom_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/BomItem"
}
],
"readOnly": true
},
"build": {
"description": "Build object",
"readOnly": true,
"type": "integer"
},
"build_reference": {
"readOnly": true,
"type": "string"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"in_production": {
"format": "double",
"readOnly": true,
"type": "number"
},
"inherited": {
"readOnly": true,
"type": "boolean"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"optional": {
"readOnly": true,
"type": "boolean"
},
"part": {
"readOnly": true,
"type": "integer"
},
"part_IPN": {
"readOnly": true,
"type": "string"
},
"part_category_id": {
"readOnly": true,
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"type": "object"
}
Response 200 OK
{
"allocated": 10.12,
"allocations": [
{
"bom_reference": "string",
"build": 0,
"build_line": 0,
"install_into": 0,
"item_serial_number": "string",
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
],
"allow_variants": true,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_reference": "string",
"consumable": true,
"external_stock": 10.12,
"in_production": 10.12,
"inherited": true,
"on_order": 10.12,
"optional": true,
"part": 0,
"part_IPN": "string",
"part_category_id": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"quantity": 10.12,
"reference": "string",
"testable": true,
"trackable": true
}
Schema of the response body
{
"description": "Serializer for a BuildItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"title": "Allocated Stock",
"type": "number"
},
"allocations": {
"items": {
"$ref": "#/components/schemas/BuildItem"
},
"readOnly": true,
"type": "array"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"available_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_substitute_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"bom_item": {
"readOnly": true,
"type": "integer"
},
"bom_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/BomItem"
}
],
"readOnly": true
},
"build": {
"description": "Build object",
"readOnly": true,
"type": "integer"
},
"build_reference": {
"readOnly": true,
"type": "string"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"in_production": {
"format": "double",
"readOnly": true,
"type": "number"
},
"inherited": {
"readOnly": true,
"type": "boolean"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"optional": {
"readOnly": true,
"type": "boolean"
},
"part": {
"readOnly": true,
"type": "integer"
},
"part_IPN": {
"readOnly": true,
"type": "string"
},
"part_category_id": {
"readOnly": true,
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"allocated",
"allocations",
"allow_variants",
"available_stock",
"available_substitute_stock",
"available_variant_stock",
"bom_item",
"bom_item_detail",
"build",
"build_reference",
"consumable",
"external_stock",
"in_production",
"inherited",
"on_order",
"optional",
"part",
"part_IPN",
"part_category_id",
"part_detail",
"part_name",
"pk",
"quantity",
"reference",
"testable",
"trackable"
],
"type": "object"
}
PUT /api/build/line/{id}/¶
Description
API endpoint for detail view of a BuildLine object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"allocated": 10.12,
"allocations": [
{
"bom_reference": "string",
"build": 0,
"build_line": 0,
"install_into": 0,
"item_serial_number": "string",
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
],
"allow_variants": true,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_reference": "string",
"consumable": true,
"external_stock": 10.12,
"in_production": 10.12,
"inherited": true,
"on_order": 10.12,
"optional": true,
"part": 0,
"part_IPN": "string",
"part_category_id": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"quantity": 10.12,
"reference": "string",
"testable": true,
"trackable": true
}
Schema of the request body
{
"description": "Serializer for a BuildItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"title": "Allocated Stock",
"type": "number"
},
"allocations": {
"items": {
"$ref": "#/components/schemas/BuildItem"
},
"readOnly": true,
"type": "array"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"available_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_substitute_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"bom_item": {
"readOnly": true,
"type": "integer"
},
"bom_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/BomItem"
}
],
"readOnly": true
},
"build": {
"description": "Build object",
"readOnly": true,
"type": "integer"
},
"build_reference": {
"readOnly": true,
"type": "string"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"in_production": {
"format": "double",
"readOnly": true,
"type": "number"
},
"inherited": {
"readOnly": true,
"type": "boolean"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"optional": {
"readOnly": true,
"type": "boolean"
},
"part": {
"readOnly": true,
"type": "integer"
},
"part_IPN": {
"readOnly": true,
"type": "string"
},
"part_category_id": {
"readOnly": true,
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"allocated",
"allocations",
"allow_variants",
"available_stock",
"available_substitute_stock",
"available_variant_stock",
"bom_item",
"bom_item_detail",
"build",
"build_reference",
"consumable",
"external_stock",
"in_production",
"inherited",
"on_order",
"optional",
"part",
"part_IPN",
"part_category_id",
"part_detail",
"part_name",
"pk",
"quantity",
"reference",
"testable",
"trackable"
],
"type": "object"
}
{
"allocated": 10.12,
"allocations": [
{
"bom_reference": "string",
"build": 0,
"build_line": 0,
"install_into": 0,
"item_serial_number": "string",
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
],
"allow_variants": true,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_reference": "string",
"consumable": true,
"external_stock": 10.12,
"in_production": 10.12,
"inherited": true,
"on_order": 10.12,
"optional": true,
"part": 0,
"part_IPN": "string",
"part_category_id": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"quantity": 10.12,
"reference": "string",
"testable": true,
"trackable": true
}
Schema of the request body
{
"description": "Serializer for a BuildItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"title": "Allocated Stock",
"type": "number"
},
"allocations": {
"items": {
"$ref": "#/components/schemas/BuildItem"
},
"readOnly": true,
"type": "array"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"available_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_substitute_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"bom_item": {
"readOnly": true,
"type": "integer"
},
"bom_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/BomItem"
}
],
"readOnly": true
},
"build": {
"description": "Build object",
"readOnly": true,
"type": "integer"
},
"build_reference": {
"readOnly": true,
"type": "string"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"in_production": {
"format": "double",
"readOnly": true,
"type": "number"
},
"inherited": {
"readOnly": true,
"type": "boolean"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"optional": {
"readOnly": true,
"type": "boolean"
},
"part": {
"readOnly": true,
"type": "integer"
},
"part_IPN": {
"readOnly": true,
"type": "string"
},
"part_category_id": {
"readOnly": true,
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"allocated",
"allocations",
"allow_variants",
"available_stock",
"available_substitute_stock",
"available_variant_stock",
"bom_item",
"bom_item_detail",
"build",
"build_reference",
"consumable",
"external_stock",
"in_production",
"inherited",
"on_order",
"optional",
"part",
"part_IPN",
"part_category_id",
"part_detail",
"part_name",
"pk",
"quantity",
"reference",
"testable",
"trackable"
],
"type": "object"
}
{
"allocated": 10.12,
"allocations": [
{
"bom_reference": "string",
"build": 0,
"build_line": 0,
"install_into": 0,
"item_serial_number": "string",
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
],
"allow_variants": true,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_reference": "string",
"consumable": true,
"external_stock": 10.12,
"in_production": 10.12,
"inherited": true,
"on_order": 10.12,
"optional": true,
"part": 0,
"part_IPN": "string",
"part_category_id": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"quantity": 10.12,
"reference": "string",
"testable": true,
"trackable": true
}
Schema of the request body
{
"description": "Serializer for a BuildItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"title": "Allocated Stock",
"type": "number"
},
"allocations": {
"items": {
"$ref": "#/components/schemas/BuildItem"
},
"readOnly": true,
"type": "array"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"available_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_substitute_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"bom_item": {
"readOnly": true,
"type": "integer"
},
"bom_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/BomItem"
}
],
"readOnly": true
},
"build": {
"description": "Build object",
"readOnly": true,
"type": "integer"
},
"build_reference": {
"readOnly": true,
"type": "string"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"in_production": {
"format": "double",
"readOnly": true,
"type": "number"
},
"inherited": {
"readOnly": true,
"type": "boolean"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"optional": {
"readOnly": true,
"type": "boolean"
},
"part": {
"readOnly": true,
"type": "integer"
},
"part_IPN": {
"readOnly": true,
"type": "string"
},
"part_category_id": {
"readOnly": true,
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"allocated",
"allocations",
"allow_variants",
"available_stock",
"available_substitute_stock",
"available_variant_stock",
"bom_item",
"bom_item_detail",
"build",
"build_reference",
"consumable",
"external_stock",
"in_production",
"inherited",
"on_order",
"optional",
"part",
"part_IPN",
"part_category_id",
"part_detail",
"part_name",
"pk",
"quantity",
"reference",
"testable",
"trackable"
],
"type": "object"
}
Response 200 OK
{
"allocated": 10.12,
"allocations": [
{
"bom_reference": "string",
"build": 0,
"build_line": 0,
"install_into": 0,
"item_serial_number": "string",
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
],
"allow_variants": true,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_reference": "string",
"consumable": true,
"external_stock": 10.12,
"in_production": 10.12,
"inherited": true,
"on_order": 10.12,
"optional": true,
"part": 0,
"part_IPN": "string",
"part_category_id": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"quantity": 10.12,
"reference": "string",
"testable": true,
"trackable": true
}
Schema of the response body
{
"description": "Serializer for a BuildItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"title": "Allocated Stock",
"type": "number"
},
"allocations": {
"items": {
"$ref": "#/components/schemas/BuildItem"
},
"readOnly": true,
"type": "array"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"available_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_substitute_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"bom_item": {
"readOnly": true,
"type": "integer"
},
"bom_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/BomItem"
}
],
"readOnly": true
},
"build": {
"description": "Build object",
"readOnly": true,
"type": "integer"
},
"build_reference": {
"readOnly": true,
"type": "string"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"in_production": {
"format": "double",
"readOnly": true,
"type": "number"
},
"inherited": {
"readOnly": true,
"type": "boolean"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"optional": {
"readOnly": true,
"type": "boolean"
},
"part": {
"readOnly": true,
"type": "integer"
},
"part_IPN": {
"readOnly": true,
"type": "string"
},
"part_category_id": {
"readOnly": true,
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"allocated",
"allocations",
"allow_variants",
"available_stock",
"available_substitute_stock",
"available_variant_stock",
"bom_item",
"bom_item_detail",
"build",
"build_reference",
"consumable",
"external_stock",
"in_production",
"inherited",
"on_order",
"optional",
"part",
"part_IPN",
"part_category_id",
"part_detail",
"part_name",
"pk",
"quantity",
"reference",
"testable",
"trackable"
],
"type": "object"
}
GET /api/build/status/¶
Description
Retrieve information about a specific status code
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 200 OK
Response 400 Bad Request
DELETE /api/build/{id}/¶
Description
API endpoint for detail view of a Build object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/build/{id}/¶
Description
API endpoint for detail view of a Build object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"barcode_hash": "string",
"batch": "string",
"completed": 0,
"completion_date": "2022-04-13",
"create_child_builds": true,
"creation_date": "2022-04-13",
"destination": 0,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"overdue": true,
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"quantity": 10.12,
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"sales_order": 0,
"status": null,
"status_custom_key": null,
"status_text": "string",
"take_from": 0,
"target_date": "2022-04-13",
"title": "string",
"url": "string"
}
Schema of the response body
{
"description": "Serializes a Build object.",
"properties": {
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"batch": {
"description": "Batch code for this build output",
"maxLength": 100,
"nullable": true,
"title": "Batch Code",
"type": "string"
},
"completed": {
"description": "Number of stock items which have been completed",
"readOnly": true,
"title": "Completed items",
"type": "integer"
},
"completion_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"create_child_builds": {
"default": false,
"description": "Automatically generate child build orders",
"type": "boolean",
"writeOnly": true
},
"creation_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"destination": {
"description": "Select location where the completed items will be stored",
"nullable": true,
"title": "Destination Location",
"type": "integer"
},
"issued_by": {
"description": "User who issued this build order",
"nullable": true,
"type": "integer"
},
"issued_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
},
"level": {
"readOnly": true,
"title": "Build Level",
"type": "integer"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"title": "External Link",
"type": "string"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"parent": {
"description": "BuildOrder to which this build is allocated",
"nullable": true,
"title": "Parent Build",
"type": "integer"
},
"part": {
"description": "Select part to build",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"priority": {
"description": "Priority of this build order",
"minimum": 0,
"title": "Build Priority",
"type": "integer"
},
"project_code": {
"description": "Project code for this build order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this build order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"sales_order": {
"description": "SalesOrder to which this build is allocated",
"nullable": true,
"title": "Sales Order Reference",
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/StatusC2fEnum"
}
],
"description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"readOnly": true,
"title": "Build Status"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/StatusCustomKeyC2fEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"take_from": {
"description": "Select location to take stock from for this build (leave blank to take from any stock location)",
"nullable": true,
"title": "Source Location",
"type": "integer"
},
"target_date": {
"description": "Target date for build completion. Build will be overdue after this date.",
"format": "date",
"nullable": true,
"title": "Target completion date",
"type": "string"
},
"title": {
"description": "Brief description of the build (optional)",
"maxLength": 100,
"title": "Description",
"type": "string"
},
"url": {
"readOnly": true,
"type": "string"
}
},
"required": [
"barcode_hash",
"completed",
"creation_date",
"issued_by_detail",
"level",
"overdue",
"part",
"part_detail",
"part_name",
"pk",
"project_code_detail",
"project_code_label",
"quantity",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"url"
],
"type": "object"
}
PATCH /api/build/{id}/¶
Description
API endpoint for detail view of a Build object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"barcode_hash": "string",
"batch": "string",
"completed": 0,
"completion_date": "2022-04-13",
"creation_date": "2022-04-13",
"destination": 0,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"notes": "string",
"overdue": true,
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"quantity": 10.12,
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"sales_order": 0,
"status": null,
"status_custom_key": null,
"status_text": "string",
"take_from": 0,
"target_date": "2022-04-13",
"title": "string",
"url": "string"
}
Schema of the request body
{
"description": "Serializes a Build object.",
"properties": {
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"batch": {
"description": "Batch code for this build output",
"maxLength": 100,
"nullable": true,
"title": "Batch Code",
"type": "string"
},
"completed": {
"description": "Number of stock items which have been completed",
"readOnly": true,
"title": "Completed items",
"type": "integer"
},
"completion_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"creation_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"destination": {
"description": "Select location where the completed items will be stored",
"nullable": true,
"title": "Destination Location",
"type": "integer"
},
"issued_by": {
"description": "User who issued this build order",
"nullable": true,
"type": "integer"
},
"issued_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
},
"level": {
"readOnly": true,
"title": "Build Level",
"type": "integer"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"title": "External Link",
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"parent": {
"description": "BuildOrder to which this build is allocated",
"nullable": true,
"title": "Parent Build",
"type": "integer"
},
"part": {
"description": "Select part to build",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"priority": {
"description": "Priority of this build order",
"minimum": 0,
"title": "Build Priority",
"type": "integer"
},
"project_code": {
"description": "Project code for this build order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this build order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"sales_order": {
"description": "SalesOrder to which this build is allocated",
"nullable": true,
"title": "Sales Order Reference",
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/StatusC2fEnum"
}
],
"description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"readOnly": true,
"title": "Build Status"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/StatusCustomKeyC2fEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"take_from": {
"description": "Select location to take stock from for this build (leave blank to take from any stock location)",
"nullable": true,
"title": "Source Location",
"type": "integer"
},
"target_date": {
"description": "Target date for build completion. Build will be overdue after this date.",
"format": "date",
"nullable": true,
"title": "Target completion date",
"type": "string"
},
"title": {
"description": "Brief description of the build (optional)",
"maxLength": 100,
"title": "Description",
"type": "string"
},
"url": {
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
{
"barcode_hash": "string",
"batch": "string",
"completed": 0,
"completion_date": "2022-04-13",
"creation_date": "2022-04-13",
"destination": 0,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"notes": "string",
"overdue": true,
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"quantity": 10.12,
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"sales_order": 0,
"status": null,
"status_custom_key": null,
"status_text": "string",
"take_from": 0,
"target_date": "2022-04-13",
"title": "string",
"url": "string"
}
Schema of the request body
{
"description": "Serializes a Build object.",
"properties": {
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"batch": {
"description": "Batch code for this build output",
"maxLength": 100,
"nullable": true,
"title": "Batch Code",
"type": "string"
},
"completed": {
"description": "Number of stock items which have been completed",
"readOnly": true,
"title": "Completed items",
"type": "integer"
},
"completion_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"creation_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"destination": {
"description": "Select location where the completed items will be stored",
"nullable": true,
"title": "Destination Location",
"type": "integer"
},
"issued_by": {
"description": "User who issued this build order",
"nullable": true,
"type": "integer"
},
"issued_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
},
"level": {
"readOnly": true,
"title": "Build Level",
"type": "integer"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"title": "External Link",
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"parent": {
"description": "BuildOrder to which this build is allocated",
"nullable": true,
"title": "Parent Build",
"type": "integer"
},
"part": {
"description": "Select part to build",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"priority": {
"description": "Priority of this build order",
"minimum": 0,
"title": "Build Priority",
"type": "integer"
},
"project_code": {
"description": "Project code for this build order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this build order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"sales_order": {
"description": "SalesOrder to which this build is allocated",
"nullable": true,
"title": "Sales Order Reference",
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/StatusC2fEnum"
}
],
"description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"readOnly": true,
"title": "Build Status"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/StatusCustomKeyC2fEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"take_from": {
"description": "Select location to take stock from for this build (leave blank to take from any stock location)",
"nullable": true,
"title": "Source Location",
"type": "integer"
},
"target_date": {
"description": "Target date for build completion. Build will be overdue after this date.",
"format": "date",
"nullable": true,
"title": "Target completion date",
"type": "string"
},
"title": {
"description": "Brief description of the build (optional)",
"maxLength": 100,
"title": "Description",
"type": "string"
},
"url": {
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
{
"barcode_hash": "string",
"batch": "string",
"completed": 0,
"completion_date": "2022-04-13",
"creation_date": "2022-04-13",
"destination": 0,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"notes": "string",
"overdue": true,
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"quantity": 10.12,
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"sales_order": 0,
"status": null,
"status_custom_key": null,
"status_text": "string",
"take_from": 0,
"target_date": "2022-04-13",
"title": "string",
"url": "string"
}
Schema of the request body
{
"description": "Serializes a Build object.",
"properties": {
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"batch": {
"description": "Batch code for this build output",
"maxLength": 100,
"nullable": true,
"title": "Batch Code",
"type": "string"
},
"completed": {
"description": "Number of stock items which have been completed",
"readOnly": true,
"title": "Completed items",
"type": "integer"
},
"completion_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"creation_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"destination": {
"description": "Select location where the completed items will be stored",
"nullable": true,
"title": "Destination Location",
"type": "integer"
},
"issued_by": {
"description": "User who issued this build order",
"nullable": true,
"type": "integer"
},
"issued_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
},
"level": {
"readOnly": true,
"title": "Build Level",
"type": "integer"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"title": "External Link",
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"parent": {
"description": "BuildOrder to which this build is allocated",
"nullable": true,
"title": "Parent Build",
"type": "integer"
},
"part": {
"description": "Select part to build",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"priority": {
"description": "Priority of this build order",
"minimum": 0,
"title": "Build Priority",
"type": "integer"
},
"project_code": {
"description": "Project code for this build order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this build order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"sales_order": {
"description": "SalesOrder to which this build is allocated",
"nullable": true,
"title": "Sales Order Reference",
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/StatusC2fEnum"
}
],
"description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"readOnly": true,
"title": "Build Status"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/StatusCustomKeyC2fEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"take_from": {
"description": "Select location to take stock from for this build (leave blank to take from any stock location)",
"nullable": true,
"title": "Source Location",
"type": "integer"
},
"target_date": {
"description": "Target date for build completion. Build will be overdue after this date.",
"format": "date",
"nullable": true,
"title": "Target completion date",
"type": "string"
},
"title": {
"description": "Brief description of the build (optional)",
"maxLength": 100,
"title": "Description",
"type": "string"
},
"url": {
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"barcode_hash": "string",
"batch": "string",
"completed": 0,
"completion_date": "2022-04-13",
"create_child_builds": true,
"creation_date": "2022-04-13",
"destination": 0,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"overdue": true,
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"quantity": 10.12,
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"sales_order": 0,
"status": null,
"status_custom_key": null,
"status_text": "string",
"take_from": 0,
"target_date": "2022-04-13",
"title": "string",
"url": "string"
}
Schema of the response body
{
"description": "Serializes a Build object.",
"properties": {
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"batch": {
"description": "Batch code for this build output",
"maxLength": 100,
"nullable": true,
"title": "Batch Code",
"type": "string"
},
"completed": {
"description": "Number of stock items which have been completed",
"readOnly": true,
"title": "Completed items",
"type": "integer"
},
"completion_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"create_child_builds": {
"default": false,
"description": "Automatically generate child build orders",
"type": "boolean",
"writeOnly": true
},
"creation_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"destination": {
"description": "Select location where the completed items will be stored",
"nullable": true,
"title": "Destination Location",
"type": "integer"
},
"issued_by": {
"description": "User who issued this build order",
"nullable": true,
"type": "integer"
},
"issued_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
},
"level": {
"readOnly": true,
"title": "Build Level",
"type": "integer"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"title": "External Link",
"type": "string"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"parent": {
"description": "BuildOrder to which this build is allocated",
"nullable": true,
"title": "Parent Build",
"type": "integer"
},
"part": {
"description": "Select part to build",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"priority": {
"description": "Priority of this build order",
"minimum": 0,
"title": "Build Priority",
"type": "integer"
},
"project_code": {
"description": "Project code for this build order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this build order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"sales_order": {
"description": "SalesOrder to which this build is allocated",
"nullable": true,
"title": "Sales Order Reference",
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/StatusC2fEnum"
}
],
"description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"readOnly": true,
"title": "Build Status"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/StatusCustomKeyC2fEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"take_from": {
"description": "Select location to take stock from for this build (leave blank to take from any stock location)",
"nullable": true,
"title": "Source Location",
"type": "integer"
},
"target_date": {
"description": "Target date for build completion. Build will be overdue after this date.",
"format": "date",
"nullable": true,
"title": "Target completion date",
"type": "string"
},
"title": {
"description": "Brief description of the build (optional)",
"maxLength": 100,
"title": "Description",
"type": "string"
},
"url": {
"readOnly": true,
"type": "string"
}
},
"required": [
"barcode_hash",
"completed",
"creation_date",
"issued_by_detail",
"level",
"overdue",
"part",
"part_detail",
"part_name",
"pk",
"project_code_detail",
"project_code_label",
"quantity",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"url"
],
"type": "object"
}
PUT /api/build/{id}/¶
Description
API endpoint for detail view of a Build object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"barcode_hash": "string",
"batch": "string",
"completed": 0,
"completion_date": "2022-04-13",
"create_child_builds": true,
"creation_date": "2022-04-13",
"destination": 0,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"overdue": true,
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"quantity": 10.12,
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"sales_order": 0,
"status": null,
"status_custom_key": null,
"status_text": "string",
"take_from": 0,
"target_date": "2022-04-13",
"title": "string",
"url": "string"
}
Schema of the request body
{
"description": "Serializes a Build object.",
"properties": {
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"batch": {
"description": "Batch code for this build output",
"maxLength": 100,
"nullable": true,
"title": "Batch Code",
"type": "string"
},
"completed": {
"description": "Number of stock items which have been completed",
"readOnly": true,
"title": "Completed items",
"type": "integer"
},
"completion_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"create_child_builds": {
"default": false,
"description": "Automatically generate child build orders",
"type": "boolean",
"writeOnly": true
},
"creation_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"destination": {
"description": "Select location where the completed items will be stored",
"nullable": true,
"title": "Destination Location",
"type": "integer"
},
"issued_by": {
"description": "User who issued this build order",
"nullable": true,
"type": "integer"
},
"issued_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
},
"level": {
"readOnly": true,
"title": "Build Level",
"type": "integer"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"title": "External Link",
"type": "string"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"parent": {
"description": "BuildOrder to which this build is allocated",
"nullable": true,
"title": "Parent Build",
"type": "integer"
},
"part": {
"description": "Select part to build",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"priority": {
"description": "Priority of this build order",
"minimum": 0,
"title": "Build Priority",
"type": "integer"
},
"project_code": {
"description": "Project code for this build order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this build order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"sales_order": {
"description": "SalesOrder to which this build is allocated",
"nullable": true,
"title": "Sales Order Reference",
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/StatusC2fEnum"
}
],
"description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"readOnly": true,
"title": "Build Status"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/StatusCustomKeyC2fEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"take_from": {
"description": "Select location to take stock from for this build (leave blank to take from any stock location)",
"nullable": true,
"title": "Source Location",
"type": "integer"
},
"target_date": {
"description": "Target date for build completion. Build will be overdue after this date.",
"format": "date",
"nullable": true,
"title": "Target completion date",
"type": "string"
},
"title": {
"description": "Brief description of the build (optional)",
"maxLength": 100,
"title": "Description",
"type": "string"
},
"url": {
"readOnly": true,
"type": "string"
}
},
"required": [
"barcode_hash",
"completed",
"creation_date",
"issued_by_detail",
"level",
"overdue",
"part",
"part_detail",
"part_name",
"pk",
"project_code_detail",
"project_code_label",
"quantity",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"url"
],
"type": "object"
}
{
"barcode_hash": "string",
"batch": "string",
"completed": 0,
"completion_date": "2022-04-13",
"create_child_builds": true,
"creation_date": "2022-04-13",
"destination": 0,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"overdue": true,
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"quantity": 10.12,
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"sales_order": 0,
"status": null,
"status_custom_key": null,
"status_text": "string",
"take_from": 0,
"target_date": "2022-04-13",
"title": "string",
"url": "string"
}
Schema of the request body
{
"description": "Serializes a Build object.",
"properties": {
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"batch": {
"description": "Batch code for this build output",
"maxLength": 100,
"nullable": true,
"title": "Batch Code",
"type": "string"
},
"completed": {
"description": "Number of stock items which have been completed",
"readOnly": true,
"title": "Completed items",
"type": "integer"
},
"completion_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"create_child_builds": {
"default": false,
"description": "Automatically generate child build orders",
"type": "boolean",
"writeOnly": true
},
"creation_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"destination": {
"description": "Select location where the completed items will be stored",
"nullable": true,
"title": "Destination Location",
"type": "integer"
},
"issued_by": {
"description": "User who issued this build order",
"nullable": true,
"type": "integer"
},
"issued_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
},
"level": {
"readOnly": true,
"title": "Build Level",
"type": "integer"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"title": "External Link",
"type": "string"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"parent": {
"description": "BuildOrder to which this build is allocated",
"nullable": true,
"title": "Parent Build",
"type": "integer"
},
"part": {
"description": "Select part to build",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"priority": {
"description": "Priority of this build order",
"minimum": 0,
"title": "Build Priority",
"type": "integer"
},
"project_code": {
"description": "Project code for this build order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this build order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"sales_order": {
"description": "SalesOrder to which this build is allocated",
"nullable": true,
"title": "Sales Order Reference",
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/StatusC2fEnum"
}
],
"description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"readOnly": true,
"title": "Build Status"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/StatusCustomKeyC2fEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"take_from": {
"description": "Select location to take stock from for this build (leave blank to take from any stock location)",
"nullable": true,
"title": "Source Location",
"type": "integer"
},
"target_date": {
"description": "Target date for build completion. Build will be overdue after this date.",
"format": "date",
"nullable": true,
"title": "Target completion date",
"type": "string"
},
"title": {
"description": "Brief description of the build (optional)",
"maxLength": 100,
"title": "Description",
"type": "string"
},
"url": {
"readOnly": true,
"type": "string"
}
},
"required": [
"barcode_hash",
"completed",
"creation_date",
"issued_by_detail",
"level",
"overdue",
"part",
"part_detail",
"part_name",
"pk",
"project_code_detail",
"project_code_label",
"quantity",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"url"
],
"type": "object"
}
{
"barcode_hash": "string",
"batch": "string",
"completed": 0,
"completion_date": "2022-04-13",
"create_child_builds": true,
"creation_date": "2022-04-13",
"destination": 0,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"overdue": true,
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"quantity": 10.12,
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"sales_order": 0,
"status": null,
"status_custom_key": null,
"status_text": "string",
"take_from": 0,
"target_date": "2022-04-13",
"title": "string",
"url": "string"
}
Schema of the request body
{
"description": "Serializes a Build object.",
"properties": {
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"batch": {
"description": "Batch code for this build output",
"maxLength": 100,
"nullable": true,
"title": "Batch Code",
"type": "string"
},
"completed": {
"description": "Number of stock items which have been completed",
"readOnly": true,
"title": "Completed items",
"type": "integer"
},
"completion_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"create_child_builds": {
"default": false,
"description": "Automatically generate child build orders",
"type": "boolean",
"writeOnly": true
},
"creation_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"destination": {
"description": "Select location where the completed items will be stored",
"nullable": true,
"title": "Destination Location",
"type": "integer"
},
"issued_by": {
"description": "User who issued this build order",
"nullable": true,
"type": "integer"
},
"issued_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
},
"level": {
"readOnly": true,
"title": "Build Level",
"type": "integer"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"title": "External Link",
"type": "string"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"parent": {
"description": "BuildOrder to which this build is allocated",
"nullable": true,
"title": "Parent Build",
"type": "integer"
},
"part": {
"description": "Select part to build",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"priority": {
"description": "Priority of this build order",
"minimum": 0,
"title": "Build Priority",
"type": "integer"
},
"project_code": {
"description": "Project code for this build order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this build order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"sales_order": {
"description": "SalesOrder to which this build is allocated",
"nullable": true,
"title": "Sales Order Reference",
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/StatusC2fEnum"
}
],
"description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"readOnly": true,
"title": "Build Status"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/StatusCustomKeyC2fEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"take_from": {
"description": "Select location to take stock from for this build (leave blank to take from any stock location)",
"nullable": true,
"title": "Source Location",
"type": "integer"
},
"target_date": {
"description": "Target date for build completion. Build will be overdue after this date.",
"format": "date",
"nullable": true,
"title": "Target completion date",
"type": "string"
},
"title": {
"description": "Brief description of the build (optional)",
"maxLength": 100,
"title": "Description",
"type": "string"
},
"url": {
"readOnly": true,
"type": "string"
}
},
"required": [
"barcode_hash",
"completed",
"creation_date",
"issued_by_detail",
"level",
"overdue",
"part",
"part_detail",
"part_name",
"pk",
"project_code_detail",
"project_code_label",
"quantity",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"url"
],
"type": "object"
}
Response 200 OK
{
"barcode_hash": "string",
"batch": "string",
"completed": 0,
"completion_date": "2022-04-13",
"create_child_builds": true,
"creation_date": "2022-04-13",
"destination": 0,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"overdue": true,
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"quantity": 10.12,
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"sales_order": 0,
"status": null,
"status_custom_key": null,
"status_text": "string",
"take_from": 0,
"target_date": "2022-04-13",
"title": "string",
"url": "string"
}
Schema of the response body
{
"description": "Serializes a Build object.",
"properties": {
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"batch": {
"description": "Batch code for this build output",
"maxLength": 100,
"nullable": true,
"title": "Batch Code",
"type": "string"
},
"completed": {
"description": "Number of stock items which have been completed",
"readOnly": true,
"title": "Completed items",
"type": "integer"
},
"completion_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"create_child_builds": {
"default": false,
"description": "Automatically generate child build orders",
"type": "boolean",
"writeOnly": true
},
"creation_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"destination": {
"description": "Select location where the completed items will be stored",
"nullable": true,
"title": "Destination Location",
"type": "integer"
},
"issued_by": {
"description": "User who issued this build order",
"nullable": true,
"type": "integer"
},
"issued_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
},
"level": {
"readOnly": true,
"title": "Build Level",
"type": "integer"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"title": "External Link",
"type": "string"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"parent": {
"description": "BuildOrder to which this build is allocated",
"nullable": true,
"title": "Parent Build",
"type": "integer"
},
"part": {
"description": "Select part to build",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"priority": {
"description": "Priority of this build order",
"minimum": 0,
"title": "Build Priority",
"type": "integer"
},
"project_code": {
"description": "Project code for this build order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this build order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"sales_order": {
"description": "SalesOrder to which this build is allocated",
"nullable": true,
"title": "Sales Order Reference",
"type": "integer"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/StatusC2fEnum"
}
],
"description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"readOnly": true,
"title": "Build Status"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/StatusCustomKeyC2fEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"take_from": {
"description": "Select location to take stock from for this build (leave blank to take from any stock location)",
"nullable": true,
"title": "Source Location",
"type": "integer"
},
"target_date": {
"description": "Target date for build completion. Build will be overdue after this date.",
"format": "date",
"nullable": true,
"title": "Target completion date",
"type": "string"
},
"title": {
"description": "Brief description of the build (optional)",
"maxLength": 100,
"title": "Description",
"type": "string"
},
"url": {
"readOnly": true,
"type": "string"
}
},
"required": [
"barcode_hash",
"completed",
"creation_date",
"issued_by_detail",
"level",
"overdue",
"part",
"part_detail",
"part_name",
"pk",
"project_code_detail",
"project_code_label",
"quantity",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"url"
],
"type": "object"
}
POST /api/build/{id}/allocate/¶
Description
API endpoint to allocate stock items to a build order.
- The BuildOrder object is specified by the URL
- Items to allocate are specified as a list called "items" with the
following options:
- bom_item: pk value of a given BomItem object (must match the part associated with this build)
- stock_item: pk value of a given StockItem object
- quantity: quantity to allocate
- output: StockItem (build order output) to allocate stock against (optional)
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"items": [
{
"build_line": 0,
"output": 0,
"quantity": "string",
"stock_item": 0
}
]
}
Schema of the request body
{
"description": "DRF serializer for allocation stock items against a build order.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/BuildAllocationItem"
},
"type": "array"
}
},
"required": [
"items"
],
"type": "object"
}
{
"items": [
{
"build_line": 0,
"output": 0,
"quantity": "string",
"stock_item": 0
}
]
}
Schema of the request body
{
"description": "DRF serializer for allocation stock items against a build order.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/BuildAllocationItem"
},
"type": "array"
}
},
"required": [
"items"
],
"type": "object"
}
{
"items": [
{
"build_line": 0,
"output": 0,
"quantity": "string",
"stock_item": 0
}
]
}
Schema of the request body
{
"description": "DRF serializer for allocation stock items against a build order.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/BuildAllocationItem"
},
"type": "array"
}
},
"required": [
"items"
],
"type": "object"
}
Response 201 Created
{
"items": [
{
"build_line": 0,
"output": 0,
"quantity": "string",
"stock_item": 0
}
]
}
Schema of the response body
{
"description": "DRF serializer for allocation stock items against a build order.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/BuildAllocationItem"
},
"type": "array"
}
},
"required": [
"items"
],
"type": "object"
}
POST /api/build/{id}/auto-allocate/¶
Description
API endpoint for 'automatically' allocating stock against a build order.
- Only looks at 'untracked' parts
- If stock exists in a single location, easy!
- If user decides that stock items are "fungible", allocate against multiple stock items
- If the user wants to, allocate substite parts if the primary parts are not available.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"exclude_location": 0,
"interchangeable": true,
"location": 0,
"optional_items": true,
"substitutes": true
}
Schema of the request body
{
"description": "DRF serializer for auto allocating stock items against a build order.",
"properties": {
"exclude_location": {
"description": "Exclude stock items from this selected location",
"nullable": true,
"type": "integer"
},
"interchangeable": {
"default": false,
"description": "Stock items in multiple locations can be used interchangeably",
"title": "Interchangeable Stock",
"type": "boolean"
},
"location": {
"description": "Stock location where parts are to be sourced (leave blank to take from any location)",
"nullable": true,
"title": "Source Location",
"type": "integer"
},
"optional_items": {
"default": false,
"description": "Allocate optional BOM items to build order",
"type": "boolean"
},
"substitutes": {
"default": true,
"description": "Allow allocation of substitute parts",
"title": "Substitute Stock",
"type": "boolean"
}
},
"type": "object"
}
{
"exclude_location": 0,
"interchangeable": true,
"location": 0,
"optional_items": true,
"substitutes": true
}
Schema of the request body
{
"description": "DRF serializer for auto allocating stock items against a build order.",
"properties": {
"exclude_location": {
"description": "Exclude stock items from this selected location",
"nullable": true,
"type": "integer"
},
"interchangeable": {
"default": false,
"description": "Stock items in multiple locations can be used interchangeably",
"title": "Interchangeable Stock",
"type": "boolean"
},
"location": {
"description": "Stock location where parts are to be sourced (leave blank to take from any location)",
"nullable": true,
"title": "Source Location",
"type": "integer"
},
"optional_items": {
"default": false,
"description": "Allocate optional BOM items to build order",
"type": "boolean"
},
"substitutes": {
"default": true,
"description": "Allow allocation of substitute parts",
"title": "Substitute Stock",
"type": "boolean"
}
},
"type": "object"
}
{
"exclude_location": 0,
"interchangeable": true,
"location": 0,
"optional_items": true,
"substitutes": true
}
Schema of the request body
{
"description": "DRF serializer for auto allocating stock items against a build order.",
"properties": {
"exclude_location": {
"description": "Exclude stock items from this selected location",
"nullable": true,
"type": "integer"
},
"interchangeable": {
"default": false,
"description": "Stock items in multiple locations can be used interchangeably",
"title": "Interchangeable Stock",
"type": "boolean"
},
"location": {
"description": "Stock location where parts are to be sourced (leave blank to take from any location)",
"nullable": true,
"title": "Source Location",
"type": "integer"
},
"optional_items": {
"default": false,
"description": "Allocate optional BOM items to build order",
"type": "boolean"
},
"substitutes": {
"default": true,
"description": "Allow allocation of substitute parts",
"title": "Substitute Stock",
"type": "boolean"
}
},
"type": "object"
}
Response 201 Created
{
"exclude_location": 0,
"interchangeable": true,
"location": 0,
"optional_items": true,
"substitutes": true
}
Schema of the response body
{
"description": "DRF serializer for auto allocating stock items against a build order.",
"properties": {
"exclude_location": {
"description": "Exclude stock items from this selected location",
"nullable": true,
"type": "integer"
},
"interchangeable": {
"default": false,
"description": "Stock items in multiple locations can be used interchangeably",
"title": "Interchangeable Stock",
"type": "boolean"
},
"location": {
"description": "Stock location where parts are to be sourced (leave blank to take from any location)",
"nullable": true,
"title": "Source Location",
"type": "integer"
},
"optional_items": {
"default": false,
"description": "Allocate optional BOM items to build order",
"type": "boolean"
},
"substitutes": {
"default": true,
"description": "Allow allocation of substitute parts",
"title": "Substitute Stock",
"type": "boolean"
}
},
"type": "object"
}
POST /api/build/{id}/cancel/¶
Description
API endpoint for cancelling a BuildOrder.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"remove_allocated_stock": true,
"remove_incomplete_outputs": true
}
Schema of the request body
{
"description": "DRF serializer class for cancelling an active BuildOrder",
"properties": {
"remove_allocated_stock": {
"default": false,
"description": "Consume any stock which has already been allocated to this build",
"title": "Consume Allocated Stock",
"type": "boolean"
},
"remove_incomplete_outputs": {
"default": false,
"description": "Delete any build outputs which have not been completed",
"type": "boolean"
}
},
"type": "object"
}
{
"remove_allocated_stock": true,
"remove_incomplete_outputs": true
}
Schema of the request body
{
"description": "DRF serializer class for cancelling an active BuildOrder",
"properties": {
"remove_allocated_stock": {
"default": false,
"description": "Consume any stock which has already been allocated to this build",
"title": "Consume Allocated Stock",
"type": "boolean"
},
"remove_incomplete_outputs": {
"default": false,
"description": "Delete any build outputs which have not been completed",
"type": "boolean"
}
},
"type": "object"
}
{
"remove_allocated_stock": true,
"remove_incomplete_outputs": true
}
Schema of the request body
{
"description": "DRF serializer class for cancelling an active BuildOrder",
"properties": {
"remove_allocated_stock": {
"default": false,
"description": "Consume any stock which has already been allocated to this build",
"title": "Consume Allocated Stock",
"type": "boolean"
},
"remove_incomplete_outputs": {
"default": false,
"description": "Delete any build outputs which have not been completed",
"type": "boolean"
}
},
"type": "object"
}
Response 201 Created
{
"remove_allocated_stock": true,
"remove_incomplete_outputs": true
}
Schema of the response body
{
"description": "DRF serializer class for cancelling an active BuildOrder",
"properties": {
"remove_allocated_stock": {
"default": false,
"description": "Consume any stock which has already been allocated to this build",
"title": "Consume Allocated Stock",
"type": "boolean"
},
"remove_incomplete_outputs": {
"default": false,
"description": "Delete any build outputs which have not been completed",
"type": "boolean"
}
},
"type": "object"
}
POST /api/build/{id}/complete/¶
Description
API endpoint for completing build outputs.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"accept_incomplete_allocation": true,
"location": 0,
"notes": "string",
"outputs": [
{
"output": 0
}
],
"status_custom_key": null
}
Schema of the request body
{
"description": "DRF serializer for completing one or more build outputs.",
"properties": {
"accept_incomplete_allocation": {
"default": false,
"description": "Complete outputs if stock has not been fully allocated",
"type": "boolean"
},
"location": {
"description": "Location for completed build outputs",
"type": "integer"
},
"notes": {
"type": "string"
},
"outputs": {
"items": {
"$ref": "#/components/schemas/BuildOutput"
},
"type": "array"
},
"status_custom_key": {
"allOf": [
{
"$ref": "#/components/schemas/StatusCustomKey2a7Enum"
}
],
"default": 10,
"title": "Status"
}
},
"required": [
"location",
"outputs"
],
"type": "object"
}
{
"accept_incomplete_allocation": true,
"location": 0,
"notes": "string",
"outputs": [
{
"output": 0
}
],
"status_custom_key": null
}
Schema of the request body
{
"description": "DRF serializer for completing one or more build outputs.",
"properties": {
"accept_incomplete_allocation": {
"default": false,
"description": "Complete outputs if stock has not been fully allocated",
"type": "boolean"
},
"location": {
"description": "Location for completed build outputs",
"type": "integer"
},
"notes": {
"type": "string"
},
"outputs": {
"items": {
"$ref": "#/components/schemas/BuildOutput"
},
"type": "array"
},
"status_custom_key": {
"allOf": [
{
"$ref": "#/components/schemas/StatusCustomKey2a7Enum"
}
],
"default": 10,
"title": "Status"
}
},
"required": [
"location",
"outputs"
],
"type": "object"
}
{
"accept_incomplete_allocation": true,
"location": 0,
"notes": "string",
"outputs": [
{
"output": 0
}
],
"status_custom_key": null
}
Schema of the request body
{
"description": "DRF serializer for completing one or more build outputs.",
"properties": {
"accept_incomplete_allocation": {
"default": false,
"description": "Complete outputs if stock has not been fully allocated",
"type": "boolean"
},
"location": {
"description": "Location for completed build outputs",
"type": "integer"
},
"notes": {
"type": "string"
},
"outputs": {
"items": {
"$ref": "#/components/schemas/BuildOutput"
},
"type": "array"
},
"status_custom_key": {
"allOf": [
{
"$ref": "#/components/schemas/StatusCustomKey2a7Enum"
}
],
"default": 10,
"title": "Status"
}
},
"required": [
"location",
"outputs"
],
"type": "object"
}
Response 201 Created
{
"accept_incomplete_allocation": true,
"location": 0,
"notes": "string",
"outputs": [
{
"output": 0
}
],
"status_custom_key": null
}
Schema of the response body
{
"description": "DRF serializer for completing one or more build outputs.",
"properties": {
"accept_incomplete_allocation": {
"default": false,
"description": "Complete outputs if stock has not been fully allocated",
"type": "boolean"
},
"location": {
"description": "Location for completed build outputs",
"type": "integer"
},
"notes": {
"type": "string"
},
"outputs": {
"items": {
"$ref": "#/components/schemas/BuildOutput"
},
"type": "array"
},
"status_custom_key": {
"allOf": [
{
"$ref": "#/components/schemas/StatusCustomKey2a7Enum"
}
],
"default": 10,
"title": "Status"
}
},
"required": [
"location",
"outputs"
],
"type": "object"
}
POST /api/build/{id}/create-output/¶
Description
API endpoint for creating new build output(s).
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"auto_allocate": true,
"batch_code": "string",
"location": 0,
"quantity": "string",
"serial_numbers": "string"
}
Schema of the request body
{
"description": "Serializer for creating a new BuildOutput against a BuildOrder.\n\nURL pattern is \"/api/build/<pk>/create-output/\", where <pk> is the PK of a Build.\n\nThe Build object is provided to the serializer context.",
"properties": {
"auto_allocate": {
"default": false,
"description": "Automatically allocate required items with matching serial numbers",
"nullable": true,
"title": "Auto Allocate Serial Numbers",
"type": "boolean"
},
"batch_code": {
"description": "Batch code for this build output",
"type": "string"
},
"location": {
"description": "Stock location for build output",
"nullable": true,
"type": "integer"
},
"quantity": {
"description": "Enter quantity for build output",
"format": "decimal",
"pattern": "^-?\\d{0,10}(?:\\.\\d{0,5})?$",
"type": "string"
},
"serial_numbers": {
"description": "Enter serial numbers for build outputs",
"type": "string"
}
},
"required": [
"quantity"
],
"type": "object"
}
{
"auto_allocate": true,
"batch_code": "string",
"location": 0,
"quantity": "string",
"serial_numbers": "string"
}
Schema of the request body
{
"description": "Serializer for creating a new BuildOutput against a BuildOrder.\n\nURL pattern is \"/api/build/<pk>/create-output/\", where <pk> is the PK of a Build.\n\nThe Build object is provided to the serializer context.",
"properties": {
"auto_allocate": {
"default": false,
"description": "Automatically allocate required items with matching serial numbers",
"nullable": true,
"title": "Auto Allocate Serial Numbers",
"type": "boolean"
},
"batch_code": {
"description": "Batch code for this build output",
"type": "string"
},
"location": {
"description": "Stock location for build output",
"nullable": true,
"type": "integer"
},
"quantity": {
"description": "Enter quantity for build output",
"format": "decimal",
"pattern": "^-?\\d{0,10}(?:\\.\\d{0,5})?$",
"type": "string"
},
"serial_numbers": {
"description": "Enter serial numbers for build outputs",
"type": "string"
}
},
"required": [
"quantity"
],
"type": "object"
}
{
"auto_allocate": true,
"batch_code": "string",
"location": 0,
"quantity": "string",
"serial_numbers": "string"
}
Schema of the request body
{
"description": "Serializer for creating a new BuildOutput against a BuildOrder.\n\nURL pattern is \"/api/build/<pk>/create-output/\", where <pk> is the PK of a Build.\n\nThe Build object is provided to the serializer context.",
"properties": {
"auto_allocate": {
"default": false,
"description": "Automatically allocate required items with matching serial numbers",
"nullable": true,
"title": "Auto Allocate Serial Numbers",
"type": "boolean"
},
"batch_code": {
"description": "Batch code for this build output",
"type": "string"
},
"location": {
"description": "Stock location for build output",
"nullable": true,
"type": "integer"
},
"quantity": {
"description": "Enter quantity for build output",
"format": "decimal",
"pattern": "^-?\\d{0,10}(?:\\.\\d{0,5})?$",
"type": "string"
},
"serial_numbers": {
"description": "Enter serial numbers for build outputs",
"type": "string"
}
},
"required": [
"quantity"
],
"type": "object"
}
Response 201 Created
{
"auto_allocate": true,
"batch_code": "string",
"location": 0,
"quantity": "string",
"serial_numbers": "string"
}
Schema of the response body
{
"description": "Serializer for creating a new BuildOutput against a BuildOrder.\n\nURL pattern is \"/api/build/<pk>/create-output/\", where <pk> is the PK of a Build.\n\nThe Build object is provided to the serializer context.",
"properties": {
"auto_allocate": {
"default": false,
"description": "Automatically allocate required items with matching serial numbers",
"nullable": true,
"title": "Auto Allocate Serial Numbers",
"type": "boolean"
},
"batch_code": {
"description": "Batch code for this build output",
"type": "string"
},
"location": {
"description": "Stock location for build output",
"nullable": true,
"type": "integer"
},
"quantity": {
"description": "Enter quantity for build output",
"format": "decimal",
"pattern": "^-?\\d{0,10}(?:\\.\\d{0,5})?$",
"type": "string"
},
"serial_numbers": {
"description": "Enter serial numbers for build outputs",
"type": "string"
}
},
"required": [
"quantity"
],
"type": "object"
}
POST /api/build/{id}/delete-outputs/¶
Description
API endpoint for deleting multiple build outputs.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"outputs": [
{
"output": 0
}
]
}
Schema of the request body
{
"description": "DRF serializer for deleting (cancelling) one or more build outputs.",
"properties": {
"outputs": {
"items": {
"$ref": "#/components/schemas/BuildOutput"
},
"type": "array"
}
},
"required": [
"outputs"
],
"type": "object"
}
{
"outputs": [
{
"output": 0
}
]
}
Schema of the request body
{
"description": "DRF serializer for deleting (cancelling) one or more build outputs.",
"properties": {
"outputs": {
"items": {
"$ref": "#/components/schemas/BuildOutput"
},
"type": "array"
}
},
"required": [
"outputs"
],
"type": "object"
}
{
"outputs": [
{
"output": 0
}
]
}
Schema of the request body
{
"description": "DRF serializer for deleting (cancelling) one or more build outputs.",
"properties": {
"outputs": {
"items": {
"$ref": "#/components/schemas/BuildOutput"
},
"type": "array"
}
},
"required": [
"outputs"
],
"type": "object"
}
Response 201 Created
{
"outputs": [
{
"output": 0
}
]
}
Schema of the response body
{
"description": "DRF serializer for deleting (cancelling) one or more build outputs.",
"properties": {
"outputs": {
"items": {
"$ref": "#/components/schemas/BuildOutput"
},
"type": "array"
}
},
"required": [
"outputs"
],
"type": "object"
}
POST /api/build/{id}/finish/¶
Description
API endpoint for marking a build as finished (completed).
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"accept_incomplete": true,
"accept_overallocated": null,
"accept_unallocated": true
}
Schema of the request body
{
"description": "DRF serializer for marking a BuildOrder as complete.",
"properties": {
"accept_incomplete": {
"default": false,
"description": "Accept that the required number of build outputs have not been completed",
"type": "boolean"
},
"accept_overallocated": {
"allOf": [
{
"$ref": "#/components/schemas/AcceptOverallocatedEnum"
}
],
"default": "reject",
"description": "How do you want to handle extra stock items assigned to the build order\n\n* `reject` - Not permitted\n* `accept` - Accept as consumed by this build order\n* `trim` - Deallocate before completing this build order",
"title": "Overallocated Stock"
},
"accept_unallocated": {
"default": false,
"description": "Accept that stock items have not been fully allocated to this build order",
"type": "boolean"
}
},
"type": "object"
}
{
"accept_incomplete": true,
"accept_overallocated": null,
"accept_unallocated": true
}
Schema of the request body
{
"description": "DRF serializer for marking a BuildOrder as complete.",
"properties": {
"accept_incomplete": {
"default": false,
"description": "Accept that the required number of build outputs have not been completed",
"type": "boolean"
},
"accept_overallocated": {
"allOf": [
{
"$ref": "#/components/schemas/AcceptOverallocatedEnum"
}
],
"default": "reject",
"description": "How do you want to handle extra stock items assigned to the build order\n\n* `reject` - Not permitted\n* `accept` - Accept as consumed by this build order\n* `trim` - Deallocate before completing this build order",
"title": "Overallocated Stock"
},
"accept_unallocated": {
"default": false,
"description": "Accept that stock items have not been fully allocated to this build order",
"type": "boolean"
}
},
"type": "object"
}
{
"accept_incomplete": true,
"accept_overallocated": null,
"accept_unallocated": true
}
Schema of the request body
{
"description": "DRF serializer for marking a BuildOrder as complete.",
"properties": {
"accept_incomplete": {
"default": false,
"description": "Accept that the required number of build outputs have not been completed",
"type": "boolean"
},
"accept_overallocated": {
"allOf": [
{
"$ref": "#/components/schemas/AcceptOverallocatedEnum"
}
],
"default": "reject",
"description": "How do you want to handle extra stock items assigned to the build order\n\n* `reject` - Not permitted\n* `accept` - Accept as consumed by this build order\n* `trim` - Deallocate before completing this build order",
"title": "Overallocated Stock"
},
"accept_unallocated": {
"default": false,
"description": "Accept that stock items have not been fully allocated to this build order",
"type": "boolean"
}
},
"type": "object"
}
Response 201 Created
{
"accept_incomplete": true,
"accept_overallocated": null,
"accept_unallocated": true
}
Schema of the response body
{
"description": "DRF serializer for marking a BuildOrder as complete.",
"properties": {
"accept_incomplete": {
"default": false,
"description": "Accept that the required number of build outputs have not been completed",
"type": "boolean"
},
"accept_overallocated": {
"allOf": [
{
"$ref": "#/components/schemas/AcceptOverallocatedEnum"
}
],
"default": "reject",
"description": "How do you want to handle extra stock items assigned to the build order\n\n* `reject` - Not permitted\n* `accept` - Accept as consumed by this build order\n* `trim` - Deallocate before completing this build order",
"title": "Overallocated Stock"
},
"accept_unallocated": {
"default": false,
"description": "Accept that stock items have not been fully allocated to this build order",
"type": "boolean"
}
},
"type": "object"
}
POST /api/build/{id}/hold/¶
Description
API endpoint for placing a BuildOrder on hold.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 201 Created
POST /api/build/{id}/issue/¶
Description
API endpoint for issuing a BuildOrder.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 201 Created
GET /api/build/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PATCH /api/build/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PUT /api/build/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
POST /api/build/{id}/scrap-outputs/¶
Description
API endpoint for scrapping build output(s).
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"discard_allocations": true,
"location": 0,
"notes": "string",
"outputs": [
{
"output": 0,
"quantity": "string"
}
]
}
Schema of the request body
{
"description": "DRF serializer for scrapping one or more build outputs",
"properties": {
"discard_allocations": {
"default": false,
"description": "Discard any stock allocations for scrapped outputs",
"type": "boolean"
},
"location": {
"description": "Stock location for scrapped outputs",
"type": "integer"
},
"notes": {
"description": "Reason for scrapping build output(s)",
"type": "string"
},
"outputs": {
"items": {
"$ref": "#/components/schemas/BuildOutputQuantity"
},
"type": "array"
}
},
"required": [
"location",
"notes",
"outputs"
],
"type": "object"
}
{
"discard_allocations": true,
"location": 0,
"notes": "string",
"outputs": [
{
"output": 0,
"quantity": "string"
}
]
}
Schema of the request body
{
"description": "DRF serializer for scrapping one or more build outputs",
"properties": {
"discard_allocations": {
"default": false,
"description": "Discard any stock allocations for scrapped outputs",
"type": "boolean"
},
"location": {
"description": "Stock location for scrapped outputs",
"type": "integer"
},
"notes": {
"description": "Reason for scrapping build output(s)",
"type": "string"
},
"outputs": {
"items": {
"$ref": "#/components/schemas/BuildOutputQuantity"
},
"type": "array"
}
},
"required": [
"location",
"notes",
"outputs"
],
"type": "object"
}
{
"discard_allocations": true,
"location": 0,
"notes": "string",
"outputs": [
{
"output": 0,
"quantity": "string"
}
]
}
Schema of the request body
{
"description": "DRF serializer for scrapping one or more build outputs",
"properties": {
"discard_allocations": {
"default": false,
"description": "Discard any stock allocations for scrapped outputs",
"type": "boolean"
},
"location": {
"description": "Stock location for scrapped outputs",
"type": "integer"
},
"notes": {
"description": "Reason for scrapping build output(s)",
"type": "string"
},
"outputs": {
"items": {
"$ref": "#/components/schemas/BuildOutputQuantity"
},
"type": "array"
}
},
"required": [
"location",
"notes",
"outputs"
],
"type": "object"
}
Response 201 Created
{
"discard_allocations": true,
"location": 0,
"notes": "string",
"outputs": [
{
"output": 0,
"quantity": "string"
}
]
}
Schema of the response body
{
"description": "DRF serializer for scrapping one or more build outputs",
"properties": {
"discard_allocations": {
"default": false,
"description": "Discard any stock allocations for scrapped outputs",
"type": "boolean"
},
"location": {
"description": "Stock location for scrapped outputs",
"type": "integer"
},
"notes": {
"description": "Reason for scrapping build output(s)",
"type": "string"
},
"outputs": {
"items": {
"$ref": "#/components/schemas/BuildOutputQuantity"
},
"type": "array"
}
},
"required": [
"location",
"notes",
"outputs"
],
"type": "object"
}
POST /api/build/{id}/unallocate/¶
Description
API endpoint for unallocating stock items from a build order.
- The BuildOrder object is specified by the URL
- "output" (StockItem) can optionally be specified
- "bom_item" can optionally be specified
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"build_line": 0,
"output": 0
}
Schema of the request body
{
"description": "DRF serializer for unallocating stock from a BuildOrder.\n\nAllocated stock can be unallocated with a number of filters:\n\n- output: Filter against a particular build output (blank = untracked stock)\n- bom_item: Filter against a particular BOM line item",
"properties": {
"build_line": {
"nullable": true,
"type": "integer"
},
"output": {
"nullable": true,
"title": "Build output",
"type": "integer"
}
},
"type": "object"
}
{
"build_line": 0,
"output": 0
}
Schema of the request body
{
"description": "DRF serializer for unallocating stock from a BuildOrder.\n\nAllocated stock can be unallocated with a number of filters:\n\n- output: Filter against a particular build output (blank = untracked stock)\n- bom_item: Filter against a particular BOM line item",
"properties": {
"build_line": {
"nullable": true,
"type": "integer"
},
"output": {
"nullable": true,
"title": "Build output",
"type": "integer"
}
},
"type": "object"
}
{
"build_line": 0,
"output": 0
}
Schema of the request body
{
"description": "DRF serializer for unallocating stock from a BuildOrder.\n\nAllocated stock can be unallocated with a number of filters:\n\n- output: Filter against a particular build output (blank = untracked stock)\n- bom_item: Filter against a particular BOM line item",
"properties": {
"build_line": {
"nullable": true,
"type": "integer"
},
"output": {
"nullable": true,
"title": "Build output",
"type": "integer"
}
},
"type": "object"
}
Response 201 Created
{
"build_line": 0,
"output": 0
}
Schema of the response body
{
"description": "DRF serializer for unallocating stock from a BuildOrder.\n\nAllocated stock can be unallocated with a number of filters:\n\n- output: Filter against a particular build output (blank = untracked stock)\n- bom_item: Filter against a particular BOM line item",
"properties": {
"build_line": {
"nullable": true,
"type": "integer"
},
"output": {
"nullable": true,
"title": "Build output",
"type": "integer"
}
},
"type": "object"
}
Schemas¶
AcceptOverallocatedEnum¶
Type: string
BomItem¶
| Name | Type |
|---|---|
allow_variants |
boolean |
available_stock |
number(double) |
available_substitute_stock |
number(double) |
available_variant_stock |
number(double) |
building |
number(double) |
can_build |
number(double) |
consumable |
boolean |
external_stock |
number(double) |
inherited |
boolean |
note |
string |
on_order |
number(double) |
optional |
boolean |
overage |
string |
part |
integer |
pk |
integer |
pricing_max |
string(decimal)| null |
pricing_max_total |
string(decimal)| null |
pricing_min |
string(decimal)| null |
pricing_min_total |
string(decimal)| null |
pricing_updated |
string(date-time)| null |
quantity |
number(double) |
reference |
string |
sub_part |
integer |
substitutes |
Array<BomItemSubstitute> |
validated |
boolean |
BomItemSubstitute¶
| Name | Type |
|---|---|
bom_item |
integer |
part |
integer |
part_detail |
|
pk |
integer |
Build¶
| Name | Type |
|---|---|
barcode_hash |
string |
batch |
string| null |
completed |
integer |
completion_date |
string(date)| null |
create_child_builds |
boolean |
creation_date |
string(date) |
destination |
integer| null |
issued_by |
integer| null |
issued_by_detail |
|
level |
integer |
link |
string(uri) |
overdue |
boolean |
parent |
integer| null |
part |
integer |
part_detail |
|
part_name |
string |
pk |
integer |
priority |
integer |
project_code |
integer| null |
project_code_detail |
|
project_code_label |
string |
quantity |
number(double) |
reference |
string |
responsible |
integer| null |
responsible_detail |
|
sales_order |
integer| null |
status |
|
status_custom_key |
|
status_text |
string |
take_from |
integer| null |
target_date |
string(date)| null |
title |
string |
url |
string |
BuildAllocation¶
| Name | Type |
|---|---|
items |
Array<BuildAllocationItem> |
BuildAllocationItem¶
| Name | Type |
|---|---|
build_line |
integer |
output |
integer| null |
quantity |
string(decimal) |
stock_item |
integer |
BuildAutoAllocation¶
| Name | Type |
|---|---|
exclude_location |
integer| null |
interchangeable |
boolean |
location |
integer| null |
optional_items |
boolean |
substitutes |
boolean |
BuildCancel¶
| Name | Type |
|---|---|
remove_allocated_stock |
boolean |
remove_incomplete_outputs |
boolean |
BuildComplete¶
| Name | Type |
|---|---|
accept_incomplete |
boolean |
accept_overallocated |
|
accept_unallocated |
boolean |
BuildItem¶
| Name | Type |
|---|---|
bom_reference |
string |
build |
integer |
build_line |
integer| null |
install_into |
integer| null |
item_serial_number |
string |
location |
integer |
location_detail |
|
part_detail |
|
pk |
integer |
quantity |
number(double) |
stock_item |
integer |
stock_item_detail |
|
supplier_part_detail |
BuildLine¶
| Name | Type |
|---|---|
allocated |
number(double) |
allocations |
Array<BuildItem> |
allow_variants |
boolean |
available_stock |
number(double) |
available_substitute_stock |
number(double) |
available_variant_stock |
number(double) |
bom_item |
integer |
bom_item_detail |
|
build |
integer |
build_reference |
string |
consumable |
boolean |
external_stock |
number(double) |
in_production |
number(double) |
inherited |
boolean |
on_order |
number(double) |
optional |
boolean |
part |
integer |
part_category_id |
integer |
part_detail |
|
part_IPN |
string |
part_name |
string |
pk |
integer |
quantity |
number(double) |
reference |
string |
testable |
boolean |
trackable |
boolean |
BuildOutput¶
| Name | Type |
|---|---|
output |
integer |
BuildOutputComplete¶
| Name | Type |
|---|---|
accept_incomplete_allocation |
boolean |
location |
integer |
notes |
string |
outputs |
Array<BuildOutput> |
status_custom_key |
BuildOutputCreate¶
| Name | Type |
|---|---|
auto_allocate |
boolean| null |
batch_code |
string |
location |
integer| null |
quantity |
string(decimal) |
serial_numbers |
string |
BuildOutputDelete¶
| Name | Type |
|---|---|
outputs |
Array<BuildOutput> |
BuildOutputQuantity¶
| Name | Type |
|---|---|
output |
integer |
quantity |
string(decimal) |
BuildOutputScrap¶
| Name | Type |
|---|---|
discard_allocations |
boolean |
location |
integer |
notes |
string |
outputs |
Array<BuildOutputQuantity> |
BuildUnallocation¶
| Name | Type |
|---|---|
build_line |
integer| null |
output |
integer| null |
LocationBrief¶
| Name | Type |
|---|---|
name |
string |
pathstring |
string |
pk |
integer |
Metadata¶
| Name | Type |
|---|---|
metadata |
NullEnum¶
Type:
Owner¶
| Name | Type |
|---|---|
label |
string |
name |
string |
owner_id |
integer| null |
pk |
integer |
PaginatedBuildItemList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<BuildItem> |
PaginatedBuildLineList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<BuildLine> |
PaginatedBuildList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<Build> |
PartBrief¶
| Name | Type |
|---|---|
active |
boolean |
assembly |
boolean |
barcode_hash |
string |
category_default_location |
integer |
component |
boolean |
default_location |
integer| null |
description |
string |
full_name |
string |
image |
string(uri) |
IPN |
string| null |
is_template |
boolean |
locked |
boolean |
name |
string |
pk |
integer |
purchaseable |
boolean |
revision |
string| null |
salable |
boolean |
testable |
boolean |
thumbnail |
string |
trackable |
boolean |
units |
string| null |
virtual |
boolean |
PatchedBuild¶
| Name | Type |
|---|---|
barcode_hash |
string |
batch |
string| null |
completed |
integer |
completion_date |
string(date)| null |
creation_date |
string(date) |
destination |
integer| null |
issued_by |
integer| null |
issued_by_detail |
|
level |
integer |
link |
string(uri) |
notes |
string| null |
overdue |
boolean |
parent |
integer| null |
part |
integer |
part_detail |
|
part_name |
string |
pk |
integer |
priority |
integer |
project_code |
integer| null |
project_code_detail |
|
project_code_label |
string |
quantity |
number(double) |
reference |
string |
responsible |
integer| null |
responsible_detail |
|
sales_order |
integer| null |
status |
|
status_custom_key |
|
status_text |
string |
take_from |
integer| null |
target_date |
string(date)| null |
title |
string |
url |
string |
PatchedBuildItem¶
| Name | Type |
|---|---|
bom_reference |
string |
build |
integer |
build_line |
integer| null |
install_into |
integer| null |
item_serial_number |
string |
location |
integer |
location_detail |
|
part_detail |
|
pk |
integer |
quantity |
number(double) |
stock_item |
integer |
stock_item_detail |
|
supplier_part_detail |
PatchedBuildLine¶
| Name | Type |
|---|---|
allocated |
number(double) |
allocations |
Array<BuildItem> |
allow_variants |
boolean |
available_stock |
number(double) |
available_substitute_stock |
number(double) |
available_variant_stock |
number(double) |
bom_item |
integer |
bom_item_detail |
|
build |
integer |
build_reference |
string |
consumable |
boolean |
external_stock |
number(double) |
in_production |
number(double) |
inherited |
boolean |
on_order |
number(double) |
optional |
boolean |
part |
integer |
part_category_id |
integer |
part_detail |
|
part_IPN |
string |
part_name |
string |
pk |
integer |
quantity |
number(double) |
reference |
string |
testable |
boolean |
trackable |
boolean |
PatchedMetadata¶
| Name | Type |
|---|---|
metadata |
ProjectCode¶
| Name | Type |
|---|---|
code |
string |
description |
string |
pk |
integer |
responsible |
integer| null |
responsible_detail |
StatusC2fEnum¶
Type: integer
StatusCustomKey2a7Enum¶
Type: integer
StatusCustomKeyC2fEnum¶
Type: integer
StockItemSerializerBrief¶
| Name | Type |
|---|---|
barcode_hash |
string |
batch |
string| null |
location |
integer| null |
part |
integer |
part_name |
string |
pk |
integer |
quantity |
number(double) |
serial |
string| null |
supplier_part |
integer| null |
SupplierPart¶
| Name | Type |
|---|---|
active |
boolean |
barcode_hash |
string |
description |
string| null |
in_stock |
number(double) |
link |
string(uri)| null |
manufacturer |
string |
manufacturer_part |
integer| null |
MPN |
string |
name |
string |
note |
string| null |
notes |
string| null |
on_order |
number(double) |
pack_quantity |
string |
pack_quantity_native |
number(double) |
packaging |
string| null |
part |
integer |
pk |
integer |
SKU |
string |
supplier |
integer |
updated |
string(date-time)| null |
url |
string |
User¶
| Name | Type |
|---|---|
email |
string(email) |
first_name |
string |
last_name |
string |
pk |
integer |
username |
string |
Security schemes¶
| Name | Type | Scheme | Description |
|---|---|---|---|
| basicAuth | http | basic | |
| cookieAuth | apiKey | ||
| tokenAuth | apiKey | Token-based authentication with required prefix "Token" |
More documentation¶
More information about InvenTree in the official docs
For more information: https://docs.inventree.org