The Parts and Part Categories section of the InvenTree API schema is documented below.
InvenTree API 477¶
API for InvenTree - the intuitive open source inventory management system
License: MIT
Servers¶
| Description | URL |
|---|---|
| http://localhost:8000 | http://localhost:8000 |
part¶
GET /api/part/¶
Description
Override the GET method to determine export options.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 | ||
ancestor |
query | integer | No | ||
assembly |
query | boolean | No | ||
bom_valid |
query | boolean | No | BOM Valid | |
cascade |
query | boolean | No | If true, include items in child categories of the given category | |
category |
query | integer | No | Filter by numeric category ID or the literal 'null' | |
category_detail |
query | boolean | False | No | |
component |
query | boolean | No | ||
convert_from |
query | integer | No | ||
created_after |
query | string | No | Updated after | |
created_before |
query | string | No | Updated before | |
default_location |
query | integer | No | Default Location | |
depleted_stock |
query | boolean | No | Depleted Stock | |
exclude_id |
query | array | No | Exclude parts with these IDs (comma-separated) | |
exclude_related |
query | number | No | Exclude parts related to this part ID | |
exclude_tree |
query | integer | No | ||
has_ipn |
query | boolean | No | Has IPN | |
has_pricing |
query | boolean | No | Has Pricing | |
has_revisions |
query | boolean | No | Has Revisions | |
has_stock |
query | boolean | No | Has stock | |
has_units |
query | boolean | No | Has units | |
in_bom_for |
query | integer | No | ||
IPN |
query | string | No | Filter by exact IPN (internal part number) | |
IPN_regex |
query | string | No | Filter by regex on IPN (internal part number) | |
is_revision |
query | boolean | No | Is Revision | |
is_template |
query | boolean | No | ||
is_variant |
query | boolean | No | Is Variant | |
limit |
query | integer | No | Number of results to return per page. | |
location_detail |
query | boolean | False | No | Include detailed information about the stock location in the response |
locked |
query | boolean | No | ||
low_stock |
query | boolean | No | Low stock | |
name_regex |
query | string | No | Filter by name (regex) | |
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. | |
parameters |
query | boolean | False | No | Include part parameters in response |
path_detail |
query | boolean | False | No | |
price_breaks |
query | boolean | False | No | |
purchaseable |
query | boolean | No | ||
related |
query | number | No | Show parts related to this part ID | |
revision_of |
query | integer | No | ||
salable |
query | boolean | No | ||
search |
query | string | No | A search term. Searched fields: IPN, category__name, description, keywords, manufacturer_parts__MPN, name, revision, supplier_parts__SKU, tags__name, tags__slug. | |
starred |
query | boolean | No | Starred | |
stock_to_build |
query | boolean | No | Required for Build Order | |
tags |
query | boolean | False | No | |
tags_name |
query | string | No | ||
tags_slug |
query | string | No | ||
testable |
query | boolean | No | ||
trackable |
query | boolean | No | ||
unallocated_stock |
query | boolean | No | Unallocated stock | |
variant_of |
query | integer | No | Variant Of | |
virtual |
query | boolean | No |
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 222,
"default_location": 0,
"default_location_detail": null,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 158,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"pk": 0,
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
],
"pricing_max": "string",
"pricing_min": "string",
"pricing_updated": "2022-04-13T15:42:05.901Z",
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"scheduled_to_build": 10.12,
"starred": true,
"stock_item_count": 0,
"tags": [
"string"
],
"testable": true,
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": 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/Part"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
PATCH /api/part/¶
Description
Perform a PATCH operation against this list endpoint.
Note that the typical DRF list endpoint does not support PATCH, so this method is provided as a custom implementation.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 269,
"default_location": 0,
"default_location_detail": null,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 116,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"pk": 0,
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
],
"pricing_max": "string",
"pricing_min": "string",
"pricing_updated": "2022-04-13T15:42:05.901Z",
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"scheduled_to_build": 10.12,
"starred": true,
"stock_item_count": 0,
"tags": [
"string"
],
"testable": true,
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the request body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"default": "",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"description": "Quantity of this part currently being in production",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"category": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"type": "boolean",
"writeOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "On Order",
"type": "number"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/PartSalePrice"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pricing_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"nullable": true,
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"scheduled_to_build": {
"description": "Outstanding quantity of this part scheduled to be built",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"nullable": true,
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"type": "object"
}
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 34,
"default_location": 0,
"default_location_detail": null,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 79,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"pk": 0,
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
],
"pricing_max": "string",
"pricing_min": "string",
"pricing_updated": "2022-04-13T15:42:05.901Z",
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"scheduled_to_build": 10.12,
"starred": true,
"stock_item_count": 0,
"tags": [
"string"
],
"testable": true,
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the request body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"default": "",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"description": "Quantity of this part currently being in production",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"category": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"type": "boolean",
"writeOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "On Order",
"type": "number"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/PartSalePrice"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pricing_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"nullable": true,
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"scheduled_to_build": {
"description": "Outstanding quantity of this part scheduled to be built",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"nullable": true,
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"type": "object"
}
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 139,
"default_location": 0,
"default_location_detail": null,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 209,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"pk": 0,
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
],
"pricing_max": "string",
"pricing_min": "string",
"pricing_updated": "2022-04-13T15:42:05.901Z",
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"scheduled_to_build": 10.12,
"starred": true,
"stock_item_count": 0,
"tags": [
"string"
],
"testable": true,
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the request body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"default": "",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"description": "Quantity of this part currently being in production",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"category": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"type": "boolean",
"writeOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "On Order",
"type": "number"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/PartSalePrice"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pricing_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"nullable": true,
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"scheduled_to_build": {
"description": "Outstanding quantity of this part scheduled to be built",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"nullable": true,
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"type": "object"
}
Responses
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 106,
"default_location": 0,
"default_location_detail": null,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 252,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"pk": 0,
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
],
"pricing_max": "string",
"pricing_min": "string",
"pricing_updated": "2022-04-13T15:42:05.901Z",
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"scheduled_to_build": 10.12,
"starred": true,
"stock_item_count": 0,
"tags": [
"string"
],
"testable": true,
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the response body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"default": "",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"description": "Quantity of this part currently being in production",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"category": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"type": "boolean",
"writeOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "On Order",
"type": "number"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/PartSalePrice"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pricing_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"nullable": true,
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"scheduled_to_build": {
"description": "Outstanding quantity of this part scheduled to be built",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"nullable": true,
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"required": [
"barcode_hash",
"category_name",
"full_name",
"name",
"pk",
"starred",
"thumbnail"
],
"type": "object"
}
POST /api/part/¶
Description
API endpoint for accessing a list of Part objects, or creating a new Part instance.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 66,
"default_location": 0,
"default_location_detail": null,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 98,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"pk": 0,
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
],
"pricing_max": "string",
"pricing_min": "string",
"pricing_updated": "2022-04-13T15:42:05.901Z",
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"scheduled_to_build": 10.12,
"starred": true,
"stock_item_count": 0,
"tags": [
"string"
],
"testable": true,
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the request body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"default": "",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"description": "Quantity of this part currently being in production",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"category": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"type": "boolean",
"writeOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "On Order",
"type": "number"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/PartSalePrice"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pricing_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"nullable": true,
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"scheduled_to_build": {
"description": "Outstanding quantity of this part scheduled to be built",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"nullable": true,
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"required": [
"barcode_hash",
"category_name",
"full_name",
"name",
"pk",
"starred",
"thumbnail"
],
"type": "object"
}
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 54,
"default_location": 0,
"default_location_detail": null,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 223,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"pk": 0,
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
],
"pricing_max": "string",
"pricing_min": "string",
"pricing_updated": "2022-04-13T15:42:05.901Z",
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"scheduled_to_build": 10.12,
"starred": true,
"stock_item_count": 0,
"tags": [
"string"
],
"testable": true,
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the request body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"default": "",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"description": "Quantity of this part currently being in production",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"category": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"type": "boolean",
"writeOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "On Order",
"type": "number"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/PartSalePrice"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pricing_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"nullable": true,
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"scheduled_to_build": {
"description": "Outstanding quantity of this part scheduled to be built",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"nullable": true,
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"required": [
"barcode_hash",
"category_name",
"full_name",
"name",
"pk",
"starred",
"thumbnail"
],
"type": "object"
}
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 45,
"default_location": 0,
"default_location_detail": null,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 105,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"pk": 0,
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
],
"pricing_max": "string",
"pricing_min": "string",
"pricing_updated": "2022-04-13T15:42:05.901Z",
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"scheduled_to_build": 10.12,
"starred": true,
"stock_item_count": 0,
"tags": [
"string"
],
"testable": true,
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the request body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"default": "",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"description": "Quantity of this part currently being in production",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"category": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"type": "boolean",
"writeOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "On Order",
"type": "number"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/PartSalePrice"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pricing_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"nullable": true,
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"scheduled_to_build": {
"description": "Outstanding quantity of this part scheduled to be built",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"nullable": true,
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"required": [
"barcode_hash",
"category_name",
"full_name",
"name",
"pk",
"starred",
"thumbnail"
],
"type": "object"
}
Responses
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 23,
"default_location": 0,
"default_location_detail": null,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 89,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"pk": 0,
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
],
"pricing_max": "string",
"pricing_min": "string",
"pricing_updated": "2022-04-13T15:42:05.901Z",
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"scheduled_to_build": 10.12,
"starred": true,
"stock_item_count": 0,
"tags": [
"string"
],
"testable": true,
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the response body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"default": "",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"description": "Quantity of this part currently being in production",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"category": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"type": "boolean",
"writeOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "On Order",
"type": "number"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/PartSalePrice"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pricing_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"nullable": true,
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"scheduled_to_build": {
"description": "Outstanding quantity of this part scheduled to be built",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"nullable": true,
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"required": [
"barcode_hash",
"category_name",
"full_name",
"name",
"pk",
"starred",
"thumbnail"
],
"type": "object"
}
PUT /api/part/¶
Description
Perform a PUT operation against this list endpoint.
Simply redirects to the PATCH method.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 202,
"default_location": 0,
"default_location_detail": null,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 207,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"pk": 0,
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
],
"pricing_max": "string",
"pricing_min": "string",
"pricing_updated": "2022-04-13T15:42:05.901Z",
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"scheduled_to_build": 10.12,
"starred": true,
"stock_item_count": 0,
"tags": [
"string"
],
"testable": true,
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the request body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"default": "",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"description": "Quantity of this part currently being in production",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"category": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"type": "boolean",
"writeOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "On Order",
"type": "number"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/PartSalePrice"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pricing_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"nullable": true,
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"scheduled_to_build": {
"description": "Outstanding quantity of this part scheduled to be built",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"nullable": true,
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"required": [
"barcode_hash",
"category_name",
"full_name",
"name",
"pk",
"starred",
"thumbnail"
],
"type": "object"
}
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 71,
"default_location": 0,
"default_location_detail": null,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 283,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"pk": 0,
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
],
"pricing_max": "string",
"pricing_min": "string",
"pricing_updated": "2022-04-13T15:42:05.901Z",
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"scheduled_to_build": 10.12,
"starred": true,
"stock_item_count": 0,
"tags": [
"string"
],
"testable": true,
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the request body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"default": "",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"description": "Quantity of this part currently being in production",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"category": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"type": "boolean",
"writeOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "On Order",
"type": "number"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/PartSalePrice"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pricing_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"nullable": true,
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"scheduled_to_build": {
"description": "Outstanding quantity of this part scheduled to be built",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"nullable": true,
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"required": [
"barcode_hash",
"category_name",
"full_name",
"name",
"pk",
"starred",
"thumbnail"
],
"type": "object"
}
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 284,
"default_location": 0,
"default_location_detail": null,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 196,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"pk": 0,
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
],
"pricing_max": "string",
"pricing_min": "string",
"pricing_updated": "2022-04-13T15:42:05.901Z",
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"scheduled_to_build": 10.12,
"starred": true,
"stock_item_count": 0,
"tags": [
"string"
],
"testable": true,
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the request body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"default": "",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"description": "Quantity of this part currently being in production",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"category": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"type": "boolean",
"writeOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "On Order",
"type": "number"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/PartSalePrice"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pricing_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"nullable": true,
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"scheduled_to_build": {
"description": "Outstanding quantity of this part scheduled to be built",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"nullable": true,
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"required": [
"barcode_hash",
"category_name",
"full_name",
"name",
"pk",
"starred",
"thumbnail"
],
"type": "object"
}
Responses
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 201,
"default_location": 0,
"default_location_detail": null,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 189,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"pk": 0,
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
],
"pricing_max": "string",
"pricing_min": "string",
"pricing_updated": "2022-04-13T15:42:05.901Z",
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"scheduled_to_build": 10.12,
"starred": true,
"stock_item_count": 0,
"tags": [
"string"
],
"testable": true,
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the response body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"default": "",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"description": "Quantity of this part currently being in production",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"category": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"type": "boolean",
"writeOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "On Order",
"type": "number"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/PartSalePrice"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pricing_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"nullable": true,
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"scheduled_to_build": {
"description": "Outstanding quantity of this part scheduled to be built",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"nullable": true,
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"required": [
"barcode_hash",
"category_name",
"full_name",
"name",
"pk",
"starred",
"thumbnail"
],
"type": "object"
}
GET /api/part/category/¶
Description
Override the GET method to determine export options.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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" |
cascade |
query | boolean | No | Include sub-categories in filtered results | |
depth |
query | number | No | Filter by category depth | |
exclude_tree |
query | integer | No | ||
limit |
query | integer | No | Number of results to return per page. | |
name |
query | string | No | ||
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. | |
parent |
query | integer | No | Filter by parent category | |
path_detail |
query | boolean | False | No | |
search |
query | string | No | A search term. Searched fields: description, name, pathstring. | |
starred |
query | boolean | No | Filter by starred categories | |
structural |
query | boolean | No | ||
top_level |
query | boolean | No | Filter by top-level categories |
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
]
}
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/Category"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
PATCH /api/part/category/¶
Description
Perform a PATCH operation against this list endpoint.
Note that the typical DRF list endpoint does not support PATCH, so this method is provided as a custom implementation.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
Schema of the request body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"part_count": {
"nullable": true,
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"nullable": true,
"readOnly": true,
"type": "integer"
}
},
"type": "object"
}
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
Schema of the request body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"part_count": {
"nullable": true,
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"nullable": true,
"readOnly": true,
"type": "integer"
}
},
"type": "object"
}
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
Schema of the request body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"part_count": {
"nullable": true,
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"nullable": true,
"readOnly": true,
"type": "integer"
}
},
"type": "object"
}
Responses
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
Schema of the response body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"part_count": {
"nullable": true,
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"nullable": true,
"readOnly": true,
"type": "integer"
}
},
"required": [
"level",
"name",
"pathstring",
"pk",
"starred"
],
"type": "object"
}
POST /api/part/category/¶
Description
API endpoint for accessing a list of PartCategory objects.
- GET: Return a list of PartCategory objects
- POST: Create a new PartCategory object
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
Schema of the request body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"part_count": {
"nullable": true,
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"nullable": true,
"readOnly": true,
"type": "integer"
}
},
"required": [
"level",
"name",
"pathstring",
"pk",
"starred"
],
"type": "object"
}
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
Schema of the request body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"part_count": {
"nullable": true,
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"nullable": true,
"readOnly": true,
"type": "integer"
}
},
"required": [
"level",
"name",
"pathstring",
"pk",
"starred"
],
"type": "object"
}
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
Schema of the request body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"part_count": {
"nullable": true,
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"nullable": true,
"readOnly": true,
"type": "integer"
}
},
"required": [
"level",
"name",
"pathstring",
"pk",
"starred"
],
"type": "object"
}
Responses
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
Schema of the response body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"part_count": {
"nullable": true,
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"nullable": true,
"readOnly": true,
"type": "integer"
}
},
"required": [
"level",
"name",
"pathstring",
"pk",
"starred"
],
"type": "object"
}
PUT /api/part/category/¶
Description
Perform a PUT operation against this list endpoint.
Simply redirects to the PATCH method.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
Schema of the request body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"part_count": {
"nullable": true,
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"nullable": true,
"readOnly": true,
"type": "integer"
}
},
"required": [
"level",
"name",
"pathstring",
"pk",
"starred"
],
"type": "object"
}
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
Schema of the request body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"part_count": {
"nullable": true,
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"nullable": true,
"readOnly": true,
"type": "integer"
}
},
"required": [
"level",
"name",
"pathstring",
"pk",
"starred"
],
"type": "object"
}
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
Schema of the request body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"part_count": {
"nullable": true,
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"nullable": true,
"readOnly": true,
"type": "integer"
}
},
"required": [
"level",
"name",
"pathstring",
"pk",
"starred"
],
"type": "object"
}
Responses
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
Schema of the response body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"part_count": {
"nullable": true,
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"nullable": true,
"readOnly": true,
"type": "integer"
}
},
"required": [
"level",
"name",
"pathstring",
"pk",
"starred"
],
"type": "object"
}
GET /api/part/category/parameters/¶
Description
Override the GET method to determine export options.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. |
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"category": 0,
"category_detail": null,
"default_value": "string",
"pk": 0,
"template": 0,
"template_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/CategoryParameterTemplate"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
POST /api/part/category/parameters/¶
Description
API endpoint for accessing a list of PartCategoryParameterTemplate objects.
- GET: Return a list of PartCategoryParameterTemplate objects
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"category": 0,
"category_detail": null,
"default_value": "string",
"pk": 0,
"template": 0,
"template_detail": null
}
Schema of the request body
{
"description": "Serializer for the PartCategoryParameterTemplate model.",
"properties": {
"category": {
"description": "Part Category",
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"default_value": {
"description": "Default Parameter Value",
"maxLength": 500,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ParameterTemplate"
}
],
"readOnly": true
}
},
"required": [
"category",
"pk",
"template",
"template_detail"
],
"type": "object"
}
{
"category": 0,
"category_detail": null,
"default_value": "string",
"pk": 0,
"template": 0,
"template_detail": null
}
Schema of the request body
{
"description": "Serializer for the PartCategoryParameterTemplate model.",
"properties": {
"category": {
"description": "Part Category",
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"default_value": {
"description": "Default Parameter Value",
"maxLength": 500,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ParameterTemplate"
}
],
"readOnly": true
}
},
"required": [
"category",
"pk",
"template",
"template_detail"
],
"type": "object"
}
{
"category": 0,
"category_detail": null,
"default_value": "string",
"pk": 0,
"template": 0,
"template_detail": null
}
Schema of the request body
{
"description": "Serializer for the PartCategoryParameterTemplate model.",
"properties": {
"category": {
"description": "Part Category",
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"default_value": {
"description": "Default Parameter Value",
"maxLength": 500,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ParameterTemplate"
}
],
"readOnly": true
}
},
"required": [
"category",
"pk",
"template",
"template_detail"
],
"type": "object"
}
Responses
{
"category": 0,
"category_detail": null,
"default_value": "string",
"pk": 0,
"template": 0,
"template_detail": null
}
Schema of the response body
{
"description": "Serializer for the PartCategoryParameterTemplate model.",
"properties": {
"category": {
"description": "Part Category",
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"default_value": {
"description": "Default Parameter Value",
"maxLength": 500,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ParameterTemplate"
}
],
"readOnly": true
}
},
"required": [
"category",
"pk",
"template",
"template_detail"
],
"type": "object"
}
DELETE /api/part/category/parameters/{id}/¶
Description
Detail endpoint for the PartCategoryParameterTemplate model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
Responses
GET /api/part/category/parameters/{id}/¶
Description
Detail endpoint for the PartCategoryParameterTemplate model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
Responses
{
"category": 0,
"category_detail": null,
"default_value": "string",
"pk": 0,
"template": 0,
"template_detail": null
}
Schema of the response body
{
"description": "Serializer for the PartCategoryParameterTemplate model.",
"properties": {
"category": {
"description": "Part Category",
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"default_value": {
"description": "Default Parameter Value",
"maxLength": 500,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ParameterTemplate"
}
],
"readOnly": true
}
},
"required": [
"category",
"pk",
"template",
"template_detail"
],
"type": "object"
}
PATCH /api/part/category/parameters/{id}/¶
Description
Detail endpoint for the PartCategoryParameterTemplate model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"category": 0,
"category_detail": null,
"default_value": "string",
"pk": 0,
"template": 0,
"template_detail": null
}
Schema of the request body
{
"description": "Serializer for the PartCategoryParameterTemplate model.",
"properties": {
"category": {
"description": "Part Category",
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"default_value": {
"description": "Default Parameter Value",
"maxLength": 500,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ParameterTemplate"
}
],
"readOnly": true
}
},
"type": "object"
}
{
"category": 0,
"category_detail": null,
"default_value": "string",
"pk": 0,
"template": 0,
"template_detail": null
}
Schema of the request body
{
"description": "Serializer for the PartCategoryParameterTemplate model.",
"properties": {
"category": {
"description": "Part Category",
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"default_value": {
"description": "Default Parameter Value",
"maxLength": 500,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ParameterTemplate"
}
],
"readOnly": true
}
},
"type": "object"
}
{
"category": 0,
"category_detail": null,
"default_value": "string",
"pk": 0,
"template": 0,
"template_detail": null
}
Schema of the request body
{
"description": "Serializer for the PartCategoryParameterTemplate model.",
"properties": {
"category": {
"description": "Part Category",
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"default_value": {
"description": "Default Parameter Value",
"maxLength": 500,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ParameterTemplate"
}
],
"readOnly": true
}
},
"type": "object"
}
Responses
{
"category": 0,
"category_detail": null,
"default_value": "string",
"pk": 0,
"template": 0,
"template_detail": null
}
Schema of the response body
{
"description": "Serializer for the PartCategoryParameterTemplate model.",
"properties": {
"category": {
"description": "Part Category",
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"default_value": {
"description": "Default Parameter Value",
"maxLength": 500,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ParameterTemplate"
}
],
"readOnly": true
}
},
"required": [
"category",
"pk",
"template",
"template_detail"
],
"type": "object"
}
PUT /api/part/category/parameters/{id}/¶
Description
Detail endpoint for the PartCategoryParameterTemplate model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"category": 0,
"category_detail": null,
"default_value": "string",
"pk": 0,
"template": 0,
"template_detail": null
}
Schema of the request body
{
"description": "Serializer for the PartCategoryParameterTemplate model.",
"properties": {
"category": {
"description": "Part Category",
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"default_value": {
"description": "Default Parameter Value",
"maxLength": 500,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ParameterTemplate"
}
],
"readOnly": true
}
},
"required": [
"category",
"pk",
"template",
"template_detail"
],
"type": "object"
}
{
"category": 0,
"category_detail": null,
"default_value": "string",
"pk": 0,
"template": 0,
"template_detail": null
}
Schema of the request body
{
"description": "Serializer for the PartCategoryParameterTemplate model.",
"properties": {
"category": {
"description": "Part Category",
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"default_value": {
"description": "Default Parameter Value",
"maxLength": 500,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ParameterTemplate"
}
],
"readOnly": true
}
},
"required": [
"category",
"pk",
"template",
"template_detail"
],
"type": "object"
}
{
"category": 0,
"category_detail": null,
"default_value": "string",
"pk": 0,
"template": 0,
"template_detail": null
}
Schema of the request body
{
"description": "Serializer for the PartCategoryParameterTemplate model.",
"properties": {
"category": {
"description": "Part Category",
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"default_value": {
"description": "Default Parameter Value",
"maxLength": 500,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ParameterTemplate"
}
],
"readOnly": true
}
},
"required": [
"category",
"pk",
"template",
"template_detail"
],
"type": "object"
}
Responses
{
"category": 0,
"category_detail": null,
"default_value": "string",
"pk": 0,
"template": 0,
"template_detail": null
}
Schema of the response body
{
"description": "Serializer for the PartCategoryParameterTemplate model.",
"properties": {
"category": {
"description": "Part Category",
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"default_value": {
"description": "Default Parameter Value",
"maxLength": 500,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ParameterTemplate"
}
],
"readOnly": true
}
},
"required": [
"category",
"pk",
"template",
"template_detail"
],
"type": "object"
}
GET /api/part/category/tree/¶
Description
API endpoint for accessing a list of PartCategory objects ready for rendering a tree.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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" |
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. |
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"icon": "string",
"name": "string",
"parent": 0,
"pk": 0,
"structural": true,
"subcategories": 0
}
]
}
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/CategoryTree"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
DELETE /api/part/category/{id}/¶
Description
Custom delete method to pass kwargs.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
Responses
GET /api/part/category/{id}/¶
Description
Custom get method to pass kwargs.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 | ||
path_detail |
query | boolean | False | No |
Responses
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
Schema of the response body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"part_count": {
"nullable": true,
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"nullable": true,
"readOnly": true,
"type": "integer"
}
},
"required": [
"level",
"name",
"pathstring",
"pk",
"starred"
],
"type": "object"
}
PATCH /api/part/category/{id}/¶
Description
Custom patch method to pass kwargs.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
Schema of the request body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"part_count": {
"nullable": true,
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"nullable": true,
"readOnly": true,
"type": "integer"
}
},
"type": "object"
}
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
Schema of the request body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"part_count": {
"nullable": true,
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"nullable": true,
"readOnly": true,
"type": "integer"
}
},
"type": "object"
}
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
Schema of the request body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"part_count": {
"nullable": true,
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"nullable": true,
"readOnly": true,
"type": "integer"
}
},
"type": "object"
}
Responses
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
Schema of the response body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"part_count": {
"nullable": true,
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"nullable": true,
"readOnly": true,
"type": "integer"
}
},
"required": [
"level",
"name",
"pathstring",
"pk",
"starred"
],
"type": "object"
}
PUT /api/part/category/{id}/¶
Description
Custom put method to pass kwargs.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
Schema of the request body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"part_count": {
"nullable": true,
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"nullable": true,
"readOnly": true,
"type": "integer"
}
},
"required": [
"level",
"name",
"pathstring",
"pk",
"starred"
],
"type": "object"
}
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
Schema of the request body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"part_count": {
"nullable": true,
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"nullable": true,
"readOnly": true,
"type": "integer"
}
},
"required": [
"level",
"name",
"pathstring",
"pk",
"starred"
],
"type": "object"
}
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
Schema of the request body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"part_count": {
"nullable": true,
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"nullable": true,
"readOnly": true,
"type": "integer"
}
},
"required": [
"level",
"name",
"pathstring",
"pk",
"starred"
],
"type": "object"
}
Responses
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
Schema of the response body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"part_count": {
"nullable": true,
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"nullable": true,
"readOnly": true,
"type": "integer"
}
},
"required": [
"level",
"name",
"pathstring",
"pk",
"starred"
],
"type": "object"
}
GET /api/part/internal-price/¶
Description
Override the GET method to determine export options.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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" |
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 | ||
search |
query | string | No | A search term. |
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
]
}
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/PartInternalPrice"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
POST /api/part/internal-price/¶
Description
API endpoint for list view of PartInternalPriceBreak model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for internal prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Purchase currency of this stock item\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for internal prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Purchase currency of this stock item\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for internal prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Purchase currency of this stock item\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
Responses
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
Schema of the response body
{
"description": "Serializer for internal prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Purchase currency of this stock item\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
DELETE /api/part/internal-price/{id}/¶
Description
Detail endpoint for PartInternalPriceBreak model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
Responses
GET /api/part/internal-price/{id}/¶
Description
Detail endpoint for PartInternalPriceBreak model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
Responses
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
Schema of the response body
{
"description": "Serializer for internal prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Purchase currency of this stock item\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
PATCH /api/part/internal-price/{id}/¶
Description
Detail endpoint for PartInternalPriceBreak model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for internal prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Purchase currency of this stock item\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"type": "object"
}
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for internal prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Purchase currency of this stock item\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"type": "object"
}
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for internal prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Purchase currency of this stock item\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"type": "object"
}
Responses
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
Schema of the response body
{
"description": "Serializer for internal prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Purchase currency of this stock item\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
PUT /api/part/internal-price/{id}/¶
Description
Detail endpoint for PartInternalPriceBreak model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for internal prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Purchase currency of this stock item\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for internal prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Purchase currency of this stock item\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for internal prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Purchase currency of this stock item\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
Responses
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
Schema of the response body
{
"description": "Serializer for internal prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Purchase currency of this stock item\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
GET /api/part/related/¶
Description
API endpoint for accessing a list of PartRelated objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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" |
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 | |
part_1 |
query | integer | No | ||
part_2 |
query | integer | No | ||
search |
query | string | No | A search term. Searched fields: part_1__name, part_2__name. |
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"note": "string",
"part_1": 0,
"part_1_detail": null,
"part_2": 0,
"part_2_detail": null,
"pk": 0
}
]
}
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/PartRelation"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
POST /api/part/related/¶
Description
API endpoint for accessing a list of PartRelated objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"note": "string",
"part_1": 0,
"part_1_detail": null,
"part_2": 0,
"part_2_detail": null,
"pk": 0
}
Schema of the request body
{
"description": "Serializer for a PartRelated model.",
"properties": {
"note": {
"description": "Note for this relationship",
"maxLength": 500,
"type": "string"
},
"part_1": {
"type": "integer"
},
"part_1_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"part_2": {
"description": "Select Related Part",
"type": "integer"
},
"part_2_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"part_1",
"part_1_detail",
"part_2",
"part_2_detail",
"pk"
],
"type": "object"
}
{
"note": "string",
"part_1": 0,
"part_1_detail": null,
"part_2": 0,
"part_2_detail": null,
"pk": 0
}
Schema of the request body
{
"description": "Serializer for a PartRelated model.",
"properties": {
"note": {
"description": "Note for this relationship",
"maxLength": 500,
"type": "string"
},
"part_1": {
"type": "integer"
},
"part_1_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"part_2": {
"description": "Select Related Part",
"type": "integer"
},
"part_2_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"part_1",
"part_1_detail",
"part_2",
"part_2_detail",
"pk"
],
"type": "object"
}
{
"note": "string",
"part_1": 0,
"part_1_detail": null,
"part_2": 0,
"part_2_detail": null,
"pk": 0
}
Schema of the request body
{
"description": "Serializer for a PartRelated model.",
"properties": {
"note": {
"description": "Note for this relationship",
"maxLength": 500,
"type": "string"
},
"part_1": {
"type": "integer"
},
"part_1_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"part_2": {
"description": "Select Related Part",
"type": "integer"
},
"part_2_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"part_1",
"part_1_detail",
"part_2",
"part_2_detail",
"pk"
],
"type": "object"
}
Responses
{
"note": "string",
"part_1": 0,
"part_1_detail": null,
"part_2": 0,
"part_2_detail": null,
"pk": 0
}
Schema of the response body
{
"description": "Serializer for a PartRelated model.",
"properties": {
"note": {
"description": "Note for this relationship",
"maxLength": 500,
"type": "string"
},
"part_1": {
"type": "integer"
},
"part_1_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"part_2": {
"description": "Select Related Part",
"type": "integer"
},
"part_2_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"part_1",
"part_1_detail",
"part_2",
"part_2_detail",
"pk"
],
"type": "object"
}
DELETE /api/part/related/{id}/¶
Description
API endpoint for accessing detail view of a PartRelated object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
Responses
GET /api/part/related/{id}/¶
Description
API endpoint for accessing detail view of a PartRelated object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
Responses
{
"note": "string",
"part_1": 0,
"part_1_detail": null,
"part_2": 0,
"part_2_detail": null,
"pk": 0
}
Schema of the response body
{
"description": "Serializer for a PartRelated model.",
"properties": {
"note": {
"description": "Note for this relationship",
"maxLength": 500,
"type": "string"
},
"part_1": {
"type": "integer"
},
"part_1_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"part_2": {
"description": "Select Related Part",
"type": "integer"
},
"part_2_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"part_1",
"part_1_detail",
"part_2",
"part_2_detail",
"pk"
],
"type": "object"
}
PATCH /api/part/related/{id}/¶
Description
API endpoint for accessing detail view of a PartRelated object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"note": "string",
"part_1": 0,
"part_1_detail": null,
"part_2": 0,
"part_2_detail": null,
"pk": 0
}
Schema of the request body
{
"description": "Serializer for a PartRelated model.",
"properties": {
"note": {
"description": "Note for this relationship",
"maxLength": 500,
"type": "string"
},
"part_1": {
"type": "integer"
},
"part_1_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"part_2": {
"description": "Select Related Part",
"type": "integer"
},
"part_2_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"type": "object"
}
{
"note": "string",
"part_1": 0,
"part_1_detail": null,
"part_2": 0,
"part_2_detail": null,
"pk": 0
}
Schema of the request body
{
"description": "Serializer for a PartRelated model.",
"properties": {
"note": {
"description": "Note for this relationship",
"maxLength": 500,
"type": "string"
},
"part_1": {
"type": "integer"
},
"part_1_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"part_2": {
"description": "Select Related Part",
"type": "integer"
},
"part_2_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"type": "object"
}
{
"note": "string",
"part_1": 0,
"part_1_detail": null,
"part_2": 0,
"part_2_detail": null,
"pk": 0
}
Schema of the request body
{
"description": "Serializer for a PartRelated model.",
"properties": {
"note": {
"description": "Note for this relationship",
"maxLength": 500,
"type": "string"
},
"part_1": {
"type": "integer"
},
"part_1_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"part_2": {
"description": "Select Related Part",
"type": "integer"
},
"part_2_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"type": "object"
}
Responses
{
"note": "string",
"part_1": 0,
"part_1_detail": null,
"part_2": 0,
"part_2_detail": null,
"pk": 0
}
Schema of the response body
{
"description": "Serializer for a PartRelated model.",
"properties": {
"note": {
"description": "Note for this relationship",
"maxLength": 500,
"type": "string"
},
"part_1": {
"type": "integer"
},
"part_1_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"part_2": {
"description": "Select Related Part",
"type": "integer"
},
"part_2_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"part_1",
"part_1_detail",
"part_2",
"part_2_detail",
"pk"
],
"type": "object"
}
PUT /api/part/related/{id}/¶
Description
API endpoint for accessing detail view of a PartRelated object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"note": "string",
"part_1": 0,
"part_1_detail": null,
"part_2": 0,
"part_2_detail": null,
"pk": 0
}
Schema of the request body
{
"description": "Serializer for a PartRelated model.",
"properties": {
"note": {
"description": "Note for this relationship",
"maxLength": 500,
"type": "string"
},
"part_1": {
"type": "integer"
},
"part_1_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"part_2": {
"description": "Select Related Part",
"type": "integer"
},
"part_2_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"part_1",
"part_1_detail",
"part_2",
"part_2_detail",
"pk"
],
"type": "object"
}
{
"note": "string",
"part_1": 0,
"part_1_detail": null,
"part_2": 0,
"part_2_detail": null,
"pk": 0
}
Schema of the request body
{
"description": "Serializer for a PartRelated model.",
"properties": {
"note": {
"description": "Note for this relationship",
"maxLength": 500,
"type": "string"
},
"part_1": {
"type": "integer"
},
"part_1_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"part_2": {
"description": "Select Related Part",
"type": "integer"
},
"part_2_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"part_1",
"part_1_detail",
"part_2",
"part_2_detail",
"pk"
],
"type": "object"
}
{
"note": "string",
"part_1": 0,
"part_1_detail": null,
"part_2": 0,
"part_2_detail": null,
"pk": 0
}
Schema of the request body
{
"description": "Serializer for a PartRelated model.",
"properties": {
"note": {
"description": "Note for this relationship",
"maxLength": 500,
"type": "string"
},
"part_1": {
"type": "integer"
},
"part_1_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"part_2": {
"description": "Select Related Part",
"type": "integer"
},
"part_2_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"part_1",
"part_1_detail",
"part_2",
"part_2_detail",
"pk"
],
"type": "object"
}
Responses
{
"note": "string",
"part_1": 0,
"part_1_detail": null,
"part_2": 0,
"part_2_detail": null,
"pk": 0
}
Schema of the response body
{
"description": "Serializer for a PartRelated model.",
"properties": {
"note": {
"description": "Note for this relationship",
"maxLength": 500,
"type": "string"
},
"part_1": {
"type": "integer"
},
"part_1_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"part_2": {
"description": "Select Related Part",
"type": "integer"
},
"part_2_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"part_1",
"part_1_detail",
"part_2",
"part_2_detail",
"pk"
],
"type": "object"
}
GET /api/part/sale-price/¶
Description
Override the GET method to determine export options.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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" |
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 | ||
search |
query | string | No | A search term. |
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
]
}
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/PartSalePrice"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
POST /api/part/sale-price/¶
Description
API endpoint for list view of PartSalePriceBreak model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for sale prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Purchase currency of this stock item\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for sale prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Purchase currency of this stock item\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for sale prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Purchase currency of this stock item\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
Responses
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
Schema of the response body
{
"description": "Serializer for sale prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Purchase currency of this stock item\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
DELETE /api/part/sale-price/{id}/¶
Description
Detail endpoint for PartSellPriceBreak model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
Responses
GET /api/part/sale-price/{id}/¶
Description
Detail endpoint for PartSellPriceBreak model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
Responses
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
Schema of the response body
{
"description": "Serializer for sale prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Purchase currency of this stock item\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
PATCH /api/part/sale-price/{id}/¶
Description
Detail endpoint for PartSellPriceBreak model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for sale prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Purchase currency of this stock item\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"type": "object"
}
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for sale prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Purchase currency of this stock item\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"type": "object"
}
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for sale prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Purchase currency of this stock item\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"type": "object"
}
Responses
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
Schema of the response body
{
"description": "Serializer for sale prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Purchase currency of this stock item\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
PUT /api/part/sale-price/{id}/¶
Description
Detail endpoint for PartSellPriceBreak model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for sale prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Purchase currency of this stock item\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for sale prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Purchase currency of this stock item\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for sale prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Purchase currency of this stock item\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
Responses
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
Schema of the response body
{
"description": "Serializer for sale prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Purchase currency of this stock item\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
DELETE /api/part/stocktake/¶
Description
Perform a DELETE operation against this list endpoint.
Note that the typical DRF list endpoint does not support DELETE, so this method is provided as a custom implementation.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
Responses
GET /api/part/stocktake/¶
Description
Override the GET method to determine export options.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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" |
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 |
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"cost_max": "string",
"cost_max_currency": "string",
"cost_min": "string",
"cost_min_currency": "string",
"date": "2022-04-13",
"item_count": 73,
"part": 0,
"part_description": "string",
"part_detail": null,
"part_ipn": "string",
"part_name": "string",
"pk": 0,
"quantity": 10.12
}
]
}
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/PartStocktake"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
POST /api/part/stocktake/¶
Description
API endpoint for listing part stocktake information.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"cost_max": "string",
"cost_max_currency": "string",
"cost_min": "string",
"cost_min_currency": "string",
"date": "2022-04-13",
"item_count": 205,
"part": 0,
"part_description": "string",
"part_detail": null,
"part_ipn": "string",
"part_name": "string",
"pk": 0,
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for the PartStocktake model.",
"properties": {
"cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_max_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_min_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"date": {
"description": "Date stocktake was performed",
"format": "date",
"readOnly": true,
"type": "string"
},
"item_count": {
"description": "Number of individual stock entries at time of stocktake",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "integer"
},
"part": {
"description": "Part for stocktake",
"type": "integer"
},
"part_description": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"part_ipn": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"date",
"part",
"part_name",
"pk",
"quantity"
],
"type": "object"
}
{
"cost_max": "string",
"cost_max_currency": "string",
"cost_min": "string",
"cost_min_currency": "string",
"date": "2022-04-13",
"item_count": 263,
"part": 0,
"part_description": "string",
"part_detail": null,
"part_ipn": "string",
"part_name": "string",
"pk": 0,
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for the PartStocktake model.",
"properties": {
"cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_max_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_min_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"date": {
"description": "Date stocktake was performed",
"format": "date",
"readOnly": true,
"type": "string"
},
"item_count": {
"description": "Number of individual stock entries at time of stocktake",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "integer"
},
"part": {
"description": "Part for stocktake",
"type": "integer"
},
"part_description": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"part_ipn": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"date",
"part",
"part_name",
"pk",
"quantity"
],
"type": "object"
}
{
"cost_max": "string",
"cost_max_currency": "string",
"cost_min": "string",
"cost_min_currency": "string",
"date": "2022-04-13",
"item_count": 192,
"part": 0,
"part_description": "string",
"part_detail": null,
"part_ipn": "string",
"part_name": "string",
"pk": 0,
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for the PartStocktake model.",
"properties": {
"cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_max_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_min_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"date": {
"description": "Date stocktake was performed",
"format": "date",
"readOnly": true,
"type": "string"
},
"item_count": {
"description": "Number of individual stock entries at time of stocktake",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "integer"
},
"part": {
"description": "Part for stocktake",
"type": "integer"
},
"part_description": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"part_ipn": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"date",
"part",
"part_name",
"pk",
"quantity"
],
"type": "object"
}
Responses
{
"cost_max": "string",
"cost_max_currency": "string",
"cost_min": "string",
"cost_min_currency": "string",
"date": "2022-04-13",
"item_count": 215,
"part": 0,
"part_description": "string",
"part_detail": null,
"part_ipn": "string",
"part_name": "string",
"pk": 0,
"quantity": 10.12
}
Schema of the response body
{
"description": "Serializer for the PartStocktake model.",
"properties": {
"cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_max_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_min_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"date": {
"description": "Date stocktake was performed",
"format": "date",
"readOnly": true,
"type": "string"
},
"item_count": {
"description": "Number of individual stock entries at time of stocktake",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "integer"
},
"part": {
"description": "Part for stocktake",
"type": "integer"
},
"part_description": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"part_ipn": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"date",
"part",
"part_name",
"pk",
"quantity"
],
"type": "object"
}
POST /api/part/stocktake/generate/¶
Description
Perform stocktake generation on POST request.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"category": 0,
"generate_entry": true,
"generate_report": true,
"location": 0,
"output": null,
"part": 0
}
Schema of the request body
{
"description": "Serializer for generating PartStocktake entries.",
"properties": {
"category": {
"description": "Select a category to include all parts within that category (and subcategories)",
"nullable": true,
"type": "integer"
},
"generate_entry": {
"default": false,
"description": "Save stocktake entries for the selected parts",
"title": "Generate Stocktake Entries",
"type": "boolean",
"writeOnly": true
},
"generate_report": {
"default": false,
"description": "Generate a stocktake report for the selected parts",
"type": "boolean",
"writeOnly": true
},
"location": {
"description": "Select a location to include all parts with stock in that location (including sub-locations)",
"nullable": true,
"type": "integer"
},
"output": {
"allOf": [
{
"$ref": "#/components/schemas/DataOutput"
}
],
"readOnly": true
},
"part": {
"description": "Select a part to generate stocktake information for that part (and any variant parts)",
"nullable": true,
"type": "integer"
}
},
"required": [
"output"
],
"type": "object"
}
{
"category": 0,
"generate_entry": true,
"generate_report": true,
"location": 0,
"output": null,
"part": 0
}
Schema of the request body
{
"description": "Serializer for generating PartStocktake entries.",
"properties": {
"category": {
"description": "Select a category to include all parts within that category (and subcategories)",
"nullable": true,
"type": "integer"
},
"generate_entry": {
"default": false,
"description": "Save stocktake entries for the selected parts",
"title": "Generate Stocktake Entries",
"type": "boolean",
"writeOnly": true
},
"generate_report": {
"default": false,
"description": "Generate a stocktake report for the selected parts",
"type": "boolean",
"writeOnly": true
},
"location": {
"description": "Select a location to include all parts with stock in that location (including sub-locations)",
"nullable": true,
"type": "integer"
},
"output": {
"allOf": [
{
"$ref": "#/components/schemas/DataOutput"
}
],
"readOnly": true
},
"part": {
"description": "Select a part to generate stocktake information for that part (and any variant parts)",
"nullable": true,
"type": "integer"
}
},
"required": [
"output"
],
"type": "object"
}
{
"category": 0,
"generate_entry": true,
"generate_report": true,
"location": 0,
"output": null,
"part": 0
}
Schema of the request body
{
"description": "Serializer for generating PartStocktake entries.",
"properties": {
"category": {
"description": "Select a category to include all parts within that category (and subcategories)",
"nullable": true,
"type": "integer"
},
"generate_entry": {
"default": false,
"description": "Save stocktake entries for the selected parts",
"title": "Generate Stocktake Entries",
"type": "boolean",
"writeOnly": true
},
"generate_report": {
"default": false,
"description": "Generate a stocktake report for the selected parts",
"type": "boolean",
"writeOnly": true
},
"location": {
"description": "Select a location to include all parts with stock in that location (including sub-locations)",
"nullable": true,
"type": "integer"
},
"output": {
"allOf": [
{
"$ref": "#/components/schemas/DataOutput"
}
],
"readOnly": true
},
"part": {
"description": "Select a part to generate stocktake information for that part (and any variant parts)",
"nullable": true,
"type": "integer"
}
},
"required": [
"output"
],
"type": "object"
}
Responses
{
"category": 0,
"generate_entry": true,
"generate_report": true,
"location": 0,
"output": null,
"part": 0
}
Schema of the response body
{
"description": "Serializer for generating PartStocktake entries.",
"properties": {
"category": {
"description": "Select a category to include all parts within that category (and subcategories)",
"nullable": true,
"type": "integer"
},
"generate_entry": {
"default": false,
"description": "Save stocktake entries for the selected parts",
"title": "Generate Stocktake Entries",
"type": "boolean",
"writeOnly": true
},
"generate_report": {
"default": false,
"description": "Generate a stocktake report for the selected parts",
"type": "boolean",
"writeOnly": true
},
"location": {
"description": "Select a location to include all parts with stock in that location (including sub-locations)",
"nullable": true,
"type": "integer"
},
"output": {
"allOf": [
{
"$ref": "#/components/schemas/DataOutput"
}
],
"readOnly": true
},
"part": {
"description": "Select a part to generate stocktake information for that part (and any variant parts)",
"nullable": true,
"type": "integer"
}
},
"required": [
"output"
],
"type": "object"
}
DELETE /api/part/stocktake/{id}/¶
Description
Detail API endpoint for a single PartStocktake instance.
Note: Only staff (admin) users can access this endpoint.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
Responses
GET /api/part/stocktake/{id}/¶
Description
Detail API endpoint for a single PartStocktake instance.
Note: Only staff (admin) users can access this endpoint.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
Responses
{
"cost_max": "string",
"cost_max_currency": "string",
"cost_min": "string",
"cost_min_currency": "string",
"date": "2022-04-13",
"item_count": 110,
"part": 0,
"part_description": "string",
"part_detail": null,
"part_ipn": "string",
"part_name": "string",
"pk": 0,
"quantity": 10.12
}
Schema of the response body
{
"description": "Serializer for the PartStocktake model.",
"properties": {
"cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_max_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_min_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"date": {
"description": "Date stocktake was performed",
"format": "date",
"readOnly": true,
"type": "string"
},
"item_count": {
"description": "Number of individual stock entries at time of stocktake",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "integer"
},
"part": {
"description": "Part for stocktake",
"type": "integer"
},
"part_description": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"part_ipn": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"date",
"part",
"part_name",
"pk",
"quantity"
],
"type": "object"
}
PATCH /api/part/stocktake/{id}/¶
Description
Detail API endpoint for a single PartStocktake instance.
Note: Only staff (admin) users can access this endpoint.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"cost_max": "string",
"cost_max_currency": "string",
"cost_min": "string",
"cost_min_currency": "string",
"date": "2022-04-13",
"item_count": 138,
"part": 0,
"part_description": "string",
"part_detail": null,
"part_ipn": "string",
"part_name": "string",
"pk": 0,
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for the PartStocktake model.",
"properties": {
"cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_max_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_min_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"date": {
"description": "Date stocktake was performed",
"format": "date",
"readOnly": true,
"type": "string"
},
"item_count": {
"description": "Number of individual stock entries at time of stocktake",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "integer"
},
"part": {
"description": "Part for stocktake",
"type": "integer"
},
"part_description": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"part_ipn": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"type": "object"
}
{
"cost_max": "string",
"cost_max_currency": "string",
"cost_min": "string",
"cost_min_currency": "string",
"date": "2022-04-13",
"item_count": 119,
"part": 0,
"part_description": "string",
"part_detail": null,
"part_ipn": "string",
"part_name": "string",
"pk": 0,
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for the PartStocktake model.",
"properties": {
"cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_max_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_min_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"date": {
"description": "Date stocktake was performed",
"format": "date",
"readOnly": true,
"type": "string"
},
"item_count": {
"description": "Number of individual stock entries at time of stocktake",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "integer"
},
"part": {
"description": "Part for stocktake",
"type": "integer"
},
"part_description": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"part_ipn": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"type": "object"
}
{
"cost_max": "string",
"cost_max_currency": "string",
"cost_min": "string",
"cost_min_currency": "string",
"date": "2022-04-13",
"item_count": 211,
"part": 0,
"part_description": "string",
"part_detail": null,
"part_ipn": "string",
"part_name": "string",
"pk": 0,
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for the PartStocktake model.",
"properties": {
"cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_max_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_min_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"date": {
"description": "Date stocktake was performed",
"format": "date",
"readOnly": true,
"type": "string"
},
"item_count": {
"description": "Number of individual stock entries at time of stocktake",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "integer"
},
"part": {
"description": "Part for stocktake",
"type": "integer"
},
"part_description": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"part_ipn": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"type": "object"
}
Responses
{
"cost_max": "string",
"cost_max_currency": "string",
"cost_min": "string",
"cost_min_currency": "string",
"date": "2022-04-13",
"item_count": 87,
"part": 0,
"part_description": "string",
"part_detail": null,
"part_ipn": "string",
"part_name": "string",
"pk": 0,
"quantity": 10.12
}
Schema of the response body
{
"description": "Serializer for the PartStocktake model.",
"properties": {
"cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_max_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_min_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"date": {
"description": "Date stocktake was performed",
"format": "date",
"readOnly": true,
"type": "string"
},
"item_count": {
"description": "Number of individual stock entries at time of stocktake",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "integer"
},
"part": {
"description": "Part for stocktake",
"type": "integer"
},
"part_description": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"part_ipn": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"date",
"part",
"part_name",
"pk",
"quantity"
],
"type": "object"
}
PUT /api/part/stocktake/{id}/¶
Description
Detail API endpoint for a single PartStocktake instance.
Note: Only staff (admin) users can access this endpoint.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"cost_max": "string",
"cost_max_currency": "string",
"cost_min": "string",
"cost_min_currency": "string",
"date": "2022-04-13",
"item_count": 159,
"part": 0,
"part_description": "string",
"part_detail": null,
"part_ipn": "string",
"part_name": "string",
"pk": 0,
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for the PartStocktake model.",
"properties": {
"cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_max_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_min_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"date": {
"description": "Date stocktake was performed",
"format": "date",
"readOnly": true,
"type": "string"
},
"item_count": {
"description": "Number of individual stock entries at time of stocktake",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "integer"
},
"part": {
"description": "Part for stocktake",
"type": "integer"
},
"part_description": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"part_ipn": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"date",
"part",
"part_name",
"pk",
"quantity"
],
"type": "object"
}
{
"cost_max": "string",
"cost_max_currency": "string",
"cost_min": "string",
"cost_min_currency": "string",
"date": "2022-04-13",
"item_count": 124,
"part": 0,
"part_description": "string",
"part_detail": null,
"part_ipn": "string",
"part_name": "string",
"pk": 0,
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for the PartStocktake model.",
"properties": {
"cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_max_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_min_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"date": {
"description": "Date stocktake was performed",
"format": "date",
"readOnly": true,
"type": "string"
},
"item_count": {
"description": "Number of individual stock entries at time of stocktake",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "integer"
},
"part": {
"description": "Part for stocktake",
"type": "integer"
},
"part_description": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"part_ipn": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"date",
"part",
"part_name",
"pk",
"quantity"
],
"type": "object"
}
{
"cost_max": "string",
"cost_max_currency": "string",
"cost_min": "string",
"cost_min_currency": "string",
"date": "2022-04-13",
"item_count": 133,
"part": 0,
"part_description": "string",
"part_detail": null,
"part_ipn": "string",
"part_name": "string",
"pk": 0,
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for the PartStocktake model.",
"properties": {
"cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_max_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_min_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"date": {
"description": "Date stocktake was performed",
"format": "date",
"readOnly": true,
"type": "string"
},
"item_count": {
"description": "Number of individual stock entries at time of stocktake",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "integer"
},
"part": {
"description": "Part for stocktake",
"type": "integer"
},
"part_description": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"part_ipn": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"date",
"part",
"part_name",
"pk",
"quantity"
],
"type": "object"
}
Responses
{
"cost_max": "string",
"cost_max_currency": "string",
"cost_min": "string",
"cost_min_currency": "string",
"date": "2022-04-13",
"item_count": 238,
"part": 0,
"part_description": "string",
"part_detail": null,
"part_ipn": "string",
"part_name": "string",
"pk": 0,
"quantity": 10.12
}
Schema of the response body
{
"description": "Serializer for the PartStocktake model.",
"properties": {
"cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_max_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_min_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"date": {
"description": "Date stocktake was performed",
"format": "date",
"readOnly": true,
"type": "string"
},
"item_count": {
"description": "Number of individual stock entries at time of stocktake",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "integer"
},
"part": {
"description": "Part for stocktake",
"type": "integer"
},
"part_description": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"part_ipn": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"part_name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"date",
"part",
"part_name",
"pk",
"quantity"
],
"type": "object"
}
GET /api/part/test-template/¶
Description
Override the GET method to determine export options.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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" |
enabled |
query | boolean | No | ||
has_results |
query | boolean | No | Has Results | |
key |
query | string | 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 | |
required |
query | boolean | No | ||
requires_attachment |
query | boolean | No | ||
requires_value |
query | boolean | No | ||
search |
query | string | No | A search term. Searched fields: description, test_name. |
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"choices": "string",
"description": "string",
"enabled": true,
"key": "string",
"part": 0,
"pk": 0,
"required": true,
"requires_attachment": true,
"requires_value": true,
"results": 0,
"test_name": "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/PartTestTemplate"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
POST /api/part/test-template/¶
Description
API endpoint for listing (and creating) a PartTestTemplate.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"choices": "string",
"description": "string",
"enabled": true,
"key": "string",
"part": 0,
"pk": 0,
"required": true,
"requires_attachment": true,
"requires_value": true,
"results": 0,
"test_name": "string"
}
Schema of the request body
{
"description": "Serializer for the PartTestTemplate class.",
"properties": {
"choices": {
"description": "Valid choices for this test (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Enter description for this test",
"maxLength": 100,
"nullable": true,
"title": "Test Description",
"type": "string"
},
"enabled": {
"description": "Is this test enabled?",
"type": "boolean"
},
"key": {
"readOnly": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"description": "Is this test required to pass?",
"type": "boolean"
},
"requires_attachment": {
"description": "Does this test require a file attachment when adding a test result?",
"type": "boolean"
},
"requires_value": {
"description": "Does this test require a value when adding a test result?",
"type": "boolean"
},
"results": {
"description": "Number of results recorded against this template",
"readOnly": true,
"type": "integer"
},
"test_name": {
"description": "Enter a name for the test",
"maxLength": 100,
"type": "string"
}
},
"required": [
"key",
"part",
"pk",
"results",
"test_name"
],
"type": "object"
}
{
"choices": "string",
"description": "string",
"enabled": true,
"key": "string",
"part": 0,
"pk": 0,
"required": true,
"requires_attachment": true,
"requires_value": true,
"results": 0,
"test_name": "string"
}
Schema of the request body
{
"description": "Serializer for the PartTestTemplate class.",
"properties": {
"choices": {
"description": "Valid choices for this test (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Enter description for this test",
"maxLength": 100,
"nullable": true,
"title": "Test Description",
"type": "string"
},
"enabled": {
"description": "Is this test enabled?",
"type": "boolean"
},
"key": {
"readOnly": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"description": "Is this test required to pass?",
"type": "boolean"
},
"requires_attachment": {
"description": "Does this test require a file attachment when adding a test result?",
"type": "boolean"
},
"requires_value": {
"description": "Does this test require a value when adding a test result?",
"type": "boolean"
},
"results": {
"description": "Number of results recorded against this template",
"readOnly": true,
"type": "integer"
},
"test_name": {
"description": "Enter a name for the test",
"maxLength": 100,
"type": "string"
}
},
"required": [
"key",
"part",
"pk",
"results",
"test_name"
],
"type": "object"
}
{
"choices": "string",
"description": "string",
"enabled": true,
"key": "string",
"part": 0,
"pk": 0,
"required": true,
"requires_attachment": true,
"requires_value": true,
"results": 0,
"test_name": "string"
}
Schema of the request body
{
"description": "Serializer for the PartTestTemplate class.",
"properties": {
"choices": {
"description": "Valid choices for this test (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Enter description for this test",
"maxLength": 100,
"nullable": true,
"title": "Test Description",
"type": "string"
},
"enabled": {
"description": "Is this test enabled?",
"type": "boolean"
},
"key": {
"readOnly": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"description": "Is this test required to pass?",
"type": "boolean"
},
"requires_attachment": {
"description": "Does this test require a file attachment when adding a test result?",
"type": "boolean"
},
"requires_value": {
"description": "Does this test require a value when adding a test result?",
"type": "boolean"
},
"results": {
"description": "Number of results recorded against this template",
"readOnly": true,
"type": "integer"
},
"test_name": {
"description": "Enter a name for the test",
"maxLength": 100,
"type": "string"
}
},
"required": [
"key",
"part",
"pk",
"results",
"test_name"
],
"type": "object"
}
Responses
{
"choices": "string",
"description": "string",
"enabled": true,
"key": "string",
"part": 0,
"pk": 0,
"required": true,
"requires_attachment": true,
"requires_value": true,
"results": 0,
"test_name": "string"
}
Schema of the response body
{
"description": "Serializer for the PartTestTemplate class.",
"properties": {
"choices": {
"description": "Valid choices for this test (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Enter description for this test",
"maxLength": 100,
"nullable": true,
"title": "Test Description",
"type": "string"
},
"enabled": {
"description": "Is this test enabled?",
"type": "boolean"
},
"key": {
"readOnly": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"description": "Is this test required to pass?",
"type": "boolean"
},
"requires_attachment": {
"description": "Does this test require a file attachment when adding a test result?",
"type": "boolean"
},
"requires_value": {
"description": "Does this test require a value when adding a test result?",
"type": "boolean"
},
"results": {
"description": "Number of results recorded against this template",
"readOnly": true,
"type": "integer"
},
"test_name": {
"description": "Enter a name for the test",
"maxLength": 100,
"type": "string"
}
},
"required": [
"key",
"part",
"pk",
"results",
"test_name"
],
"type": "object"
}
DELETE /api/part/test-template/{id}/¶
Description
Detail endpoint for PartTestTemplate model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
Responses
GET /api/part/test-template/{id}/¶
Description
Detail endpoint for PartTestTemplate model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
Responses
{
"choices": "string",
"description": "string",
"enabled": true,
"key": "string",
"part": 0,
"pk": 0,
"required": true,
"requires_attachment": true,
"requires_value": true,
"results": 0,
"test_name": "string"
}
Schema of the response body
{
"description": "Serializer for the PartTestTemplate class.",
"properties": {
"choices": {
"description": "Valid choices for this test (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Enter description for this test",
"maxLength": 100,
"nullable": true,
"title": "Test Description",
"type": "string"
},
"enabled": {
"description": "Is this test enabled?",
"type": "boolean"
},
"key": {
"readOnly": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"description": "Is this test required to pass?",
"type": "boolean"
},
"requires_attachment": {
"description": "Does this test require a file attachment when adding a test result?",
"type": "boolean"
},
"requires_value": {
"description": "Does this test require a value when adding a test result?",
"type": "boolean"
},
"results": {
"description": "Number of results recorded against this template",
"readOnly": true,
"type": "integer"
},
"test_name": {
"description": "Enter a name for the test",
"maxLength": 100,
"type": "string"
}
},
"required": [
"key",
"part",
"pk",
"results",
"test_name"
],
"type": "object"
}
PATCH /api/part/test-template/{id}/¶
Description
Detail endpoint for PartTestTemplate model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"choices": "string",
"description": "string",
"enabled": true,
"key": "string",
"part": 0,
"pk": 0,
"required": true,
"requires_attachment": true,
"requires_value": true,
"results": 0,
"test_name": "string"
}
Schema of the request body
{
"description": "Serializer for the PartTestTemplate class.",
"properties": {
"choices": {
"description": "Valid choices for this test (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Enter description for this test",
"maxLength": 100,
"nullable": true,
"title": "Test Description",
"type": "string"
},
"enabled": {
"description": "Is this test enabled?",
"type": "boolean"
},
"key": {
"readOnly": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"description": "Is this test required to pass?",
"type": "boolean"
},
"requires_attachment": {
"description": "Does this test require a file attachment when adding a test result?",
"type": "boolean"
},
"requires_value": {
"description": "Does this test require a value when adding a test result?",
"type": "boolean"
},
"results": {
"description": "Number of results recorded against this template",
"readOnly": true,
"type": "integer"
},
"test_name": {
"description": "Enter a name for the test",
"maxLength": 100,
"type": "string"
}
},
"type": "object"
}
{
"choices": "string",
"description": "string",
"enabled": true,
"key": "string",
"part": 0,
"pk": 0,
"required": true,
"requires_attachment": true,
"requires_value": true,
"results": 0,
"test_name": "string"
}
Schema of the request body
{
"description": "Serializer for the PartTestTemplate class.",
"properties": {
"choices": {
"description": "Valid choices for this test (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Enter description for this test",
"maxLength": 100,
"nullable": true,
"title": "Test Description",
"type": "string"
},
"enabled": {
"description": "Is this test enabled?",
"type": "boolean"
},
"key": {
"readOnly": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"description": "Is this test required to pass?",
"type": "boolean"
},
"requires_attachment": {
"description": "Does this test require a file attachment when adding a test result?",
"type": "boolean"
},
"requires_value": {
"description": "Does this test require a value when adding a test result?",
"type": "boolean"
},
"results": {
"description": "Number of results recorded against this template",
"readOnly": true,
"type": "integer"
},
"test_name": {
"description": "Enter a name for the test",
"maxLength": 100,
"type": "string"
}
},
"type": "object"
}
{
"choices": "string",
"description": "string",
"enabled": true,
"key": "string",
"part": 0,
"pk": 0,
"required": true,
"requires_attachment": true,
"requires_value": true,
"results": 0,
"test_name": "string"
}
Schema of the request body
{
"description": "Serializer for the PartTestTemplate class.",
"properties": {
"choices": {
"description": "Valid choices for this test (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Enter description for this test",
"maxLength": 100,
"nullable": true,
"title": "Test Description",
"type": "string"
},
"enabled": {
"description": "Is this test enabled?",
"type": "boolean"
},
"key": {
"readOnly": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"description": "Is this test required to pass?",
"type": "boolean"
},
"requires_attachment": {
"description": "Does this test require a file attachment when adding a test result?",
"type": "boolean"
},
"requires_value": {
"description": "Does this test require a value when adding a test result?",
"type": "boolean"
},
"results": {
"description": "Number of results recorded against this template",
"readOnly": true,
"type": "integer"
},
"test_name": {
"description": "Enter a name for the test",
"maxLength": 100,
"type": "string"
}
},
"type": "object"
}
Responses
{
"choices": "string",
"description": "string",
"enabled": true,
"key": "string",
"part": 0,
"pk": 0,
"required": true,
"requires_attachment": true,
"requires_value": true,
"results": 0,
"test_name": "string"
}
Schema of the response body
{
"description": "Serializer for the PartTestTemplate class.",
"properties": {
"choices": {
"description": "Valid choices for this test (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Enter description for this test",
"maxLength": 100,
"nullable": true,
"title": "Test Description",
"type": "string"
},
"enabled": {
"description": "Is this test enabled?",
"type": "boolean"
},
"key": {
"readOnly": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"description": "Is this test required to pass?",
"type": "boolean"
},
"requires_attachment": {
"description": "Does this test require a file attachment when adding a test result?",
"type": "boolean"
},
"requires_value": {
"description": "Does this test require a value when adding a test result?",
"type": "boolean"
},
"results": {
"description": "Number of results recorded against this template",
"readOnly": true,
"type": "integer"
},
"test_name": {
"description": "Enter a name for the test",
"maxLength": 100,
"type": "string"
}
},
"required": [
"key",
"part",
"pk",
"results",
"test_name"
],
"type": "object"
}
PUT /api/part/test-template/{id}/¶
Description
Detail endpoint for PartTestTemplate model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"choices": "string",
"description": "string",
"enabled": true,
"key": "string",
"part": 0,
"pk": 0,
"required": true,
"requires_attachment": true,
"requires_value": true,
"results": 0,
"test_name": "string"
}
Schema of the request body
{
"description": "Serializer for the PartTestTemplate class.",
"properties": {
"choices": {
"description": "Valid choices for this test (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Enter description for this test",
"maxLength": 100,
"nullable": true,
"title": "Test Description",
"type": "string"
},
"enabled": {
"description": "Is this test enabled?",
"type": "boolean"
},
"key": {
"readOnly": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"description": "Is this test required to pass?",
"type": "boolean"
},
"requires_attachment": {
"description": "Does this test require a file attachment when adding a test result?",
"type": "boolean"
},
"requires_value": {
"description": "Does this test require a value when adding a test result?",
"type": "boolean"
},
"results": {
"description": "Number of results recorded against this template",
"readOnly": true,
"type": "integer"
},
"test_name": {
"description": "Enter a name for the test",
"maxLength": 100,
"type": "string"
}
},
"required": [
"key",
"part",
"pk",
"results",
"test_name"
],
"type": "object"
}
{
"choices": "string",
"description": "string",
"enabled": true,
"key": "string",
"part": 0,
"pk": 0,
"required": true,
"requires_attachment": true,
"requires_value": true,
"results": 0,
"test_name": "string"
}
Schema of the request body
{
"description": "Serializer for the PartTestTemplate class.",
"properties": {
"choices": {
"description": "Valid choices for this test (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Enter description for this test",
"maxLength": 100,
"nullable": true,
"title": "Test Description",
"type": "string"
},
"enabled": {
"description": "Is this test enabled?",
"type": "boolean"
},
"key": {
"readOnly": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"description": "Is this test required to pass?",
"type": "boolean"
},
"requires_attachment": {
"description": "Does this test require a file attachment when adding a test result?",
"type": "boolean"
},
"requires_value": {
"description": "Does this test require a value when adding a test result?",
"type": "boolean"
},
"results": {
"description": "Number of results recorded against this template",
"readOnly": true,
"type": "integer"
},
"test_name": {
"description": "Enter a name for the test",
"maxLength": 100,
"type": "string"
}
},
"required": [
"key",
"part",
"pk",
"results",
"test_name"
],
"type": "object"
}
{
"choices": "string",
"description": "string",
"enabled": true,
"key": "string",
"part": 0,
"pk": 0,
"required": true,
"requires_attachment": true,
"requires_value": true,
"results": 0,
"test_name": "string"
}
Schema of the request body
{
"description": "Serializer for the PartTestTemplate class.",
"properties": {
"choices": {
"description": "Valid choices for this test (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Enter description for this test",
"maxLength": 100,
"nullable": true,
"title": "Test Description",
"type": "string"
},
"enabled": {
"description": "Is this test enabled?",
"type": "boolean"
},
"key": {
"readOnly": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"description": "Is this test required to pass?",
"type": "boolean"
},
"requires_attachment": {
"description": "Does this test require a file attachment when adding a test result?",
"type": "boolean"
},
"requires_value": {
"description": "Does this test require a value when adding a test result?",
"type": "boolean"
},
"results": {
"description": "Number of results recorded against this template",
"readOnly": true,
"type": "integer"
},
"test_name": {
"description": "Enter a name for the test",
"maxLength": 100,
"type": "string"
}
},
"required": [
"key",
"part",
"pk",
"results",
"test_name"
],
"type": "object"
}
Responses
{
"choices": "string",
"description": "string",
"enabled": true,
"key": "string",
"part": 0,
"pk": 0,
"required": true,
"requires_attachment": true,
"requires_value": true,
"results": 0,
"test_name": "string"
}
Schema of the response body
{
"description": "Serializer for the PartTestTemplate class.",
"properties": {
"choices": {
"description": "Valid choices for this test (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Enter description for this test",
"maxLength": 100,
"nullable": true,
"title": "Test Description",
"type": "string"
},
"enabled": {
"description": "Is this test enabled?",
"type": "boolean"
},
"key": {
"readOnly": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"description": "Is this test required to pass?",
"type": "boolean"
},
"requires_attachment": {
"description": "Does this test require a file attachment when adding a test result?",
"type": "boolean"
},
"requires_value": {
"description": "Does this test require a value when adding a test result?",
"type": "boolean"
},
"results": {
"description": "Number of results recorded against this template",
"readOnly": true,
"type": "integer"
},
"test_name": {
"description": "Enter a name for the test",
"maxLength": 100,
"type": "string"
}
},
"required": [
"key",
"part",
"pk",
"results",
"test_name"
],
"type": "object"
}
GET /api/part/thumbs/¶
Description
API endpoint for retrieving information on available Part thumbnails.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
search |
query | string | No | A search term. Searched fields: IPN, category__name, description, keywords, name, revision. |
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"count": 0,
"image": "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/PartThumb"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
GET /api/part/thumbs/{id}/¶
Description
API endpoint for updating Part thumbnails.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
Responses
{
"image": "string"
}
Schema of the response body
{
"description": "Serializer for updating Part thumbnail.",
"properties": {
"image": {
"format": "uri",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
}
PATCH /api/part/thumbs/{id}/¶
Description
API endpoint for updating Part thumbnails.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"image": "string"
}
Schema of the request body
{
"description": "Serializer for updating Part thumbnail.",
"properties": {
"image": {
"format": "uri",
"type": "string"
}
},
"type": "object"
}
{
"image": "string"
}
Schema of the request body
{
"description": "Serializer for updating Part thumbnail.",
"properties": {
"image": {
"format": "uri",
"type": "string"
}
},
"type": "object"
}
{
"image": "string"
}
Schema of the request body
{
"description": "Serializer for updating Part thumbnail.",
"properties": {
"image": {
"format": "uri",
"type": "string"
}
},
"type": "object"
}
Responses
{
"image": "string"
}
Schema of the response body
{
"description": "Serializer for updating Part thumbnail.",
"properties": {
"image": {
"format": "uri",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
}
PUT /api/part/thumbs/{id}/¶
Description
API endpoint for updating Part thumbnails.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"image": "string"
}
Schema of the request body
{
"description": "Serializer for updating Part thumbnail.",
"properties": {
"image": {
"format": "uri",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
}
{
"image": "string"
}
Schema of the request body
{
"description": "Serializer for updating Part thumbnail.",
"properties": {
"image": {
"format": "uri",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
}
{
"image": "string"
}
Schema of the request body
{
"description": "Serializer for updating Part thumbnail.",
"properties": {
"image": {
"format": "uri",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
}
Responses
{
"image": "string"
}
Schema of the response body
{
"description": "Serializer for updating Part thumbnail.",
"properties": {
"image": {
"format": "uri",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
}
DELETE /api/part/{id}/¶
Description
API endpoint for detail view of a single Part object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
Responses
GET /api/part/{id}/¶
Description
API endpoint for detail view of a single Part object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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" |
category_detail |
query | boolean | False | No | |
id |
path | integer | No | ||
location_detail |
query | boolean | False | No | Include detailed information about the stock location in the response |
parameters |
query | boolean | False | No | Include part parameters in response |
path_detail |
query | boolean | False | No | |
price_breaks |
query | boolean | False | No | |
tags |
query | boolean | False | No |
Responses
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 32,
"default_location": 0,
"default_location_detail": null,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 251,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"pk": 0,
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
],
"pricing_max": "string",
"pricing_min": "string",
"pricing_updated": "2022-04-13T15:42:05.901Z",
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"scheduled_to_build": 10.12,
"starred": true,
"stock_item_count": 0,
"tags": [
"string"
],
"testable": true,
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the response body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"default": "",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"description": "Quantity of this part currently being in production",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"category": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"type": "boolean",
"writeOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "On Order",
"type": "number"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/PartSalePrice"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pricing_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"nullable": true,
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"scheduled_to_build": {
"description": "Outstanding quantity of this part scheduled to be built",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"nullable": true,
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"required": [
"barcode_hash",
"category_name",
"full_name",
"name",
"pk",
"starred",
"thumbnail"
],
"type": "object"
}
PATCH /api/part/{id}/¶
Description
API endpoint for detail view of a single Part object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 140,
"default_location": 0,
"default_location_detail": null,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 70,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"pk": 0,
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
],
"pricing_max": "string",
"pricing_min": "string",
"pricing_updated": "2022-04-13T15:42:05.901Z",
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"scheduled_to_build": 10.12,
"starred": true,
"stock_item_count": 0,
"tags": [
"string"
],
"testable": true,
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the request body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"default": "",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"description": "Quantity of this part currently being in production",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"category": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"type": "boolean",
"writeOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "On Order",
"type": "number"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/PartSalePrice"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pricing_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"nullable": true,
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"scheduled_to_build": {
"description": "Outstanding quantity of this part scheduled to be built",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"nullable": true,
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"type": "object"
}
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 295,
"default_location": 0,
"default_location_detail": null,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 85,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"pk": 0,
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
],
"pricing_max": "string",
"pricing_min": "string",
"pricing_updated": "2022-04-13T15:42:05.901Z",
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"scheduled_to_build": 10.12,
"starred": true,
"stock_item_count": 0,
"tags": [
"string"
],
"testable": true,
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the request body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"default": "",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"description": "Quantity of this part currently being in production",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"category": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"type": "boolean",
"writeOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "On Order",
"type": "number"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/PartSalePrice"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pricing_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"nullable": true,
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"scheduled_to_build": {
"description": "Outstanding quantity of this part scheduled to be built",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"nullable": true,
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"type": "object"
}
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 139,
"default_location": 0,
"default_location_detail": null,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 10,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"pk": 0,
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
],
"pricing_max": "string",
"pricing_min": "string",
"pricing_updated": "2022-04-13T15:42:05.901Z",
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"scheduled_to_build": 10.12,
"starred": true,
"stock_item_count": 0,
"tags": [
"string"
],
"testable": true,
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the request body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"default": "",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"description": "Quantity of this part currently being in production",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"category": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"type": "boolean",
"writeOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "On Order",
"type": "number"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/PartSalePrice"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pricing_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"nullable": true,
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"scheduled_to_build": {
"description": "Outstanding quantity of this part scheduled to be built",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"nullable": true,
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"type": "object"
}
Responses
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 144,
"default_location": 0,
"default_location_detail": null,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 156,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"pk": 0,
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
],
"pricing_max": "string",
"pricing_min": "string",
"pricing_updated": "2022-04-13T15:42:05.901Z",
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"scheduled_to_build": 10.12,
"starred": true,
"stock_item_count": 0,
"tags": [
"string"
],
"testable": true,
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the response body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"default": "",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"description": "Quantity of this part currently being in production",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"category": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"type": "boolean",
"writeOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "On Order",
"type": "number"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/PartSalePrice"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pricing_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"nullable": true,
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"scheduled_to_build": {
"description": "Outstanding quantity of this part scheduled to be built",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"nullable": true,
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"required": [
"barcode_hash",
"category_name",
"full_name",
"name",
"pk",
"starred",
"thumbnail"
],
"type": "object"
}
PUT /api/part/{id}/¶
Description
API endpoint for detail view of a single Part object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 163,
"default_location": 0,
"default_location_detail": null,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 150,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"pk": 0,
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
],
"pricing_max": "string",
"pricing_min": "string",
"pricing_updated": "2022-04-13T15:42:05.901Z",
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"scheduled_to_build": 10.12,
"starred": true,
"stock_item_count": 0,
"tags": [
"string"
],
"testable": true,
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the request body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"default": "",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"description": "Quantity of this part currently being in production",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"category": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"type": "boolean",
"writeOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "On Order",
"type": "number"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/PartSalePrice"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pricing_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"nullable": true,
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"scheduled_to_build": {
"description": "Outstanding quantity of this part scheduled to be built",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"nullable": true,
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"required": [
"barcode_hash",
"category_name",
"full_name",
"name",
"pk",
"starred",
"thumbnail"
],
"type": "object"
}
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 164,
"default_location": 0,
"default_location_detail": null,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 274,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"pk": 0,
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
],
"pricing_max": "string",
"pricing_min": "string",
"pricing_updated": "2022-04-13T15:42:05.901Z",
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"scheduled_to_build": 10.12,
"starred": true,
"stock_item_count": 0,
"tags": [
"string"
],
"testable": true,
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the request body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"default": "",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"description": "Quantity of this part currently being in production",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"category": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"type": "boolean",
"writeOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "On Order",
"type": "number"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/PartSalePrice"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pricing_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"nullable": true,
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"scheduled_to_build": {
"description": "Outstanding quantity of this part scheduled to be built",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"nullable": true,
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"required": [
"barcode_hash",
"category_name",
"full_name",
"name",
"pk",
"starred",
"thumbnail"
],
"type": "object"
}
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 120,
"default_location": 0,
"default_location_detail": null,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 180,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"pk": 0,
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
],
"pricing_max": "string",
"pricing_min": "string",
"pricing_updated": "2022-04-13T15:42:05.901Z",
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"scheduled_to_build": 10.12,
"starred": true,
"stock_item_count": 0,
"tags": [
"string"
],
"testable": true,
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the request body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"default": "",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"description": "Quantity of this part currently being in production",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"category": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"type": "boolean",
"writeOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "On Order",
"type": "number"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/PartSalePrice"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pricing_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"nullable": true,
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"scheduled_to_build": {
"description": "Outstanding quantity of this part scheduled to be built",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"nullable": true,
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"required": [
"barcode_hash",
"category_name",
"full_name",
"name",
"pk",
"starred",
"thumbnail"
],
"type": "object"
}
Responses
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 198,
"default_location": 0,
"default_location_detail": null,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 193,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"pk": 0,
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12
}
],
"pricing_max": "string",
"pricing_min": "string",
"pricing_updated": "2022-04-13T15:42:05.901Z",
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"scheduled_to_build": 10.12,
"starred": true,
"stock_item_count": 0,
"tags": [
"string"
],
"testable": true,
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the response body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"default": "",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"description": "Quantity of this part currently being in production",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"category": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"type": "boolean",
"writeOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"format": "int64",
"maximum": 9223372036854775807,
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "On Order",
"type": "number"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/PartSalePrice"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pricing_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"nullable": true,
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"scheduled_to_build": {
"description": "Outstanding quantity of this part scheduled to be built",
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"nullable": true,
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"required": [
"barcode_hash",
"category_name",
"full_name",
"name",
"pk",
"starred",
"thumbnail"
],
"type": "object"
}
POST /api/part/{id}/bom-copy/¶
Description
API endpoint for duplicating a BOM.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"copy_substitutes": true,
"include_inherited": true,
"part": 0,
"remove_existing": true,
"skip_invalid": true
}
Schema of the request body
{
"description": "Serializer for copying a BOM from another part.",
"properties": {
"copy_substitutes": {
"default": true,
"description": "Copy substitute parts when duplicate BOM items",
"title": "Copy Substitute Parts",
"type": "boolean"
},
"include_inherited": {
"default": false,
"description": "Include BOM items which are inherited from templated parts",
"type": "boolean"
},
"part": {
"description": "Select part to copy BOM from",
"type": "integer"
},
"remove_existing": {
"default": true,
"description": "Remove existing BOM items before copying",
"title": "Remove Existing Data",
"type": "boolean"
},
"skip_invalid": {
"default": false,
"description": "Enable this option to skip invalid rows",
"title": "Skip Invalid Rows",
"type": "boolean"
}
},
"required": [
"part"
],
"type": "object"
}
{
"copy_substitutes": true,
"include_inherited": true,
"part": 0,
"remove_existing": true,
"skip_invalid": true
}
Schema of the request body
{
"description": "Serializer for copying a BOM from another part.",
"properties": {
"copy_substitutes": {
"default": true,
"description": "Copy substitute parts when duplicate BOM items",
"title": "Copy Substitute Parts",
"type": "boolean"
},
"include_inherited": {
"default": false,
"description": "Include BOM items which are inherited from templated parts",
"type": "boolean"
},
"part": {
"description": "Select part to copy BOM from",
"type": "integer"
},
"remove_existing": {
"default": true,
"description": "Remove existing BOM items before copying",
"title": "Remove Existing Data",
"type": "boolean"
},
"skip_invalid": {
"default": false,
"description": "Enable this option to skip invalid rows",
"title": "Skip Invalid Rows",
"type": "boolean"
}
},
"required": [
"part"
],
"type": "object"
}
{
"copy_substitutes": true,
"include_inherited": true,
"part": 0,
"remove_existing": true,
"skip_invalid": true
}
Schema of the request body
{
"description": "Serializer for copying a BOM from another part.",
"properties": {
"copy_substitutes": {
"default": true,
"description": "Copy substitute parts when duplicate BOM items",
"title": "Copy Substitute Parts",
"type": "boolean"
},
"include_inherited": {
"default": false,
"description": "Include BOM items which are inherited from templated parts",
"type": "boolean"
},
"part": {
"description": "Select part to copy BOM from",
"type": "integer"
},
"remove_existing": {
"default": true,
"description": "Remove existing BOM items before copying",
"title": "Remove Existing Data",
"type": "boolean"
},
"skip_invalid": {
"default": false,
"description": "Enable this option to skip invalid rows",
"title": "Skip Invalid Rows",
"type": "boolean"
}
},
"required": [
"part"
],
"type": "object"
}
Responses
{
"copy_substitutes": true,
"include_inherited": true,
"part": 0,
"remove_existing": true,
"skip_invalid": true
}
Schema of the response body
{
"description": "Serializer for copying a BOM from another part.",
"properties": {
"copy_substitutes": {
"default": true,
"description": "Copy substitute parts when duplicate BOM items",
"title": "Copy Substitute Parts",
"type": "boolean"
},
"include_inherited": {
"default": false,
"description": "Include BOM items which are inherited from templated parts",
"type": "boolean"
},
"part": {
"description": "Select part to copy BOM from",
"type": "integer"
},
"remove_existing": {
"default": true,
"description": "Remove existing BOM items before copying",
"title": "Remove Existing Data",
"type": "boolean"
},
"skip_invalid": {
"default": false,
"description": "Enable this option to skip invalid rows",
"title": "Skip Invalid Rows",
"type": "boolean"
}
},
"required": [
"part"
],
"type": "object"
}
GET /api/part/{id}/bom-validate/¶
Description
API endpoint for 'validating' the BOM for a given Part.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
Responses
{
"bom_checked_by": 0,
"bom_checked_by_detail": null,
"bom_checked_date": "2022-04-13",
"bom_checksum": "string",
"bom_validated": true,
"pk": 0,
"valid": true
}
Schema of the response body
{
"description": "Serializer for Part BOM information.",
"properties": {
"bom_checked_by": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"bom_checked_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"nullable": true,
"readOnly": true
},
"bom_checked_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"bom_checksum": {
"description": "Stored BOM checksum",
"readOnly": true,
"type": "string"
},
"bom_validated": {
"description": "Is the BOM for this part valid?",
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"valid": {
"default": false,
"description": "Validate entire Bill of Materials",
"type": "boolean",
"writeOnly": true
}
},
"required": [
"bom_checksum",
"bom_validated",
"pk"
],
"type": "object"
}
PATCH /api/part/{id}/bom-validate/¶
Description
API endpoint for 'validating' the BOM for a given Part.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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_checked_by": 0,
"bom_checked_by_detail": null,
"bom_checked_date": "2022-04-13",
"bom_checksum": "string",
"bom_validated": true,
"pk": 0,
"valid": true
}
Schema of the request body
{
"description": "Serializer for Part BOM information.",
"properties": {
"bom_checked_by": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"bom_checked_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"nullable": true,
"readOnly": true
},
"bom_checked_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"bom_checksum": {
"description": "Stored BOM checksum",
"readOnly": true,
"type": "string"
},
"bom_validated": {
"description": "Is the BOM for this part valid?",
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"valid": {
"default": false,
"description": "Validate entire Bill of Materials",
"type": "boolean",
"writeOnly": true
}
},
"type": "object"
}
{
"bom_checked_by": 0,
"bom_checked_by_detail": null,
"bom_checked_date": "2022-04-13",
"bom_checksum": "string",
"bom_validated": true,
"pk": 0,
"valid": true
}
Schema of the request body
{
"description": "Serializer for Part BOM information.",
"properties": {
"bom_checked_by": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"bom_checked_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"nullable": true,
"readOnly": true
},
"bom_checked_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"bom_checksum": {
"description": "Stored BOM checksum",
"readOnly": true,
"type": "string"
},
"bom_validated": {
"description": "Is the BOM for this part valid?",
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"valid": {
"default": false,
"description": "Validate entire Bill of Materials",
"type": "boolean",
"writeOnly": true
}
},
"type": "object"
}
{
"bom_checked_by": 0,
"bom_checked_by_detail": null,
"bom_checked_date": "2022-04-13",
"bom_checksum": "string",
"bom_validated": true,
"pk": 0,
"valid": true
}
Schema of the request body
{
"description": "Serializer for Part BOM information.",
"properties": {
"bom_checked_by": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"bom_checked_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"nullable": true,
"readOnly": true
},
"bom_checked_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"bom_checksum": {
"description": "Stored BOM checksum",
"readOnly": true,
"type": "string"
},
"bom_validated": {
"description": "Is the BOM for this part valid?",
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"valid": {
"default": false,
"description": "Validate entire Bill of Materials",
"type": "boolean",
"writeOnly": true
}
},
"type": "object"
}
Responses
{
"bom_checked_by": 0,
"bom_checked_by_detail": null,
"bom_checked_date": "2022-04-13",
"bom_checksum": "string",
"bom_validated": true,
"pk": 0,
"valid": true
}
Schema of the response body
{
"description": "Serializer for Part BOM information.",
"properties": {
"bom_checked_by": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"bom_checked_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"nullable": true,
"readOnly": true
},
"bom_checked_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"bom_checksum": {
"description": "Stored BOM checksum",
"readOnly": true,
"type": "string"
},
"bom_validated": {
"description": "Is the BOM for this part valid?",
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"valid": {
"default": false,
"description": "Validate entire Bill of Materials",
"type": "boolean",
"writeOnly": true
}
},
"required": [
"bom_checksum",
"bom_validated",
"pk"
],
"type": "object"
}
PUT /api/part/{id}/bom-validate/¶
Description
API endpoint for 'validating' the BOM for a given Part.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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_checked_by": 0,
"bom_checked_by_detail": null,
"bom_checked_date": "2022-04-13",
"bom_checksum": "string",
"bom_validated": true,
"pk": 0,
"valid": true
}
Schema of the request body
{
"description": "Serializer for Part BOM information.",
"properties": {
"bom_checked_by": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"bom_checked_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"nullable": true,
"readOnly": true
},
"bom_checked_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"bom_checksum": {
"description": "Stored BOM checksum",
"readOnly": true,
"type": "string"
},
"bom_validated": {
"description": "Is the BOM for this part valid?",
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"valid": {
"default": false,
"description": "Validate entire Bill of Materials",
"type": "boolean",
"writeOnly": true
}
},
"required": [
"bom_checksum",
"bom_validated",
"pk"
],
"type": "object"
}
{
"bom_checked_by": 0,
"bom_checked_by_detail": null,
"bom_checked_date": "2022-04-13",
"bom_checksum": "string",
"bom_validated": true,
"pk": 0,
"valid": true
}
Schema of the request body
{
"description": "Serializer for Part BOM information.",
"properties": {
"bom_checked_by": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"bom_checked_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"nullable": true,
"readOnly": true
},
"bom_checked_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"bom_checksum": {
"description": "Stored BOM checksum",
"readOnly": true,
"type": "string"
},
"bom_validated": {
"description": "Is the BOM for this part valid?",
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"valid": {
"default": false,
"description": "Validate entire Bill of Materials",
"type": "boolean",
"writeOnly": true
}
},
"required": [
"bom_checksum",
"bom_validated",
"pk"
],
"type": "object"
}
{
"bom_checked_by": 0,
"bom_checked_by_detail": null,
"bom_checked_date": "2022-04-13",
"bom_checksum": "string",
"bom_validated": true,
"pk": 0,
"valid": true
}
Schema of the request body
{
"description": "Serializer for Part BOM information.",
"properties": {
"bom_checked_by": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"bom_checked_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"nullable": true,
"readOnly": true
},
"bom_checked_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"bom_checksum": {
"description": "Stored BOM checksum",
"readOnly": true,
"type": "string"
},
"bom_validated": {
"description": "Is the BOM for this part valid?",
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"valid": {
"default": false,
"description": "Validate entire Bill of Materials",
"type": "boolean",
"writeOnly": true
}
},
"required": [
"bom_checksum",
"bom_validated",
"pk"
],
"type": "object"
}
Responses
{
"bom_checked_by": 0,
"bom_checked_by_detail": null,
"bom_checked_date": "2022-04-13",
"bom_checksum": "string",
"bom_validated": true,
"pk": 0,
"valid": true
}
Schema of the response body
{
"description": "Serializer for Part BOM information.",
"properties": {
"bom_checked_by": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"bom_checked_by_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"nullable": true,
"readOnly": true
},
"bom_checked_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"bom_checksum": {
"description": "Stored BOM checksum",
"readOnly": true,
"type": "string"
},
"bom_validated": {
"description": "Is the BOM for this part valid?",
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"valid": {
"default": false,
"description": "Validate entire Bill of Materials",
"type": "boolean",
"writeOnly": true
}
},
"required": [
"bom_checksum",
"bom_validated",
"pk"
],
"type": "object"
}
GET /api/part/{id}/pricing/¶
Description
API endpoint for viewing part pricing data.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
Responses
{
"bom_cost_max": "string",
"bom_cost_min": "string",
"currency": "string",
"internal_cost_max": "string",
"internal_cost_min": "string",
"overall_max": "string",
"overall_min": "string",
"override_max": "string",
"override_max_currency": "string",
"override_min": "string",
"override_min_currency": "string",
"purchase_cost_max": "string",
"purchase_cost_min": "string",
"sale_history_max": "string",
"sale_history_min": "string",
"sale_price_max": "string",
"sale_price_min": "string",
"scheduled_for_update": true,
"supplier_price_max": "string",
"supplier_price_min": "string",
"update": true,
"updated": "2022-04-13T15:42:05.901Z",
"variant_cost_max": "string",
"variant_cost_min": "string"
}
Schema of the response body
{
"description": "Serializer for Part pricing information.",
"properties": {
"bom_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"bom_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"currency": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"internal_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"internal_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"override_max": {
"description": "Override calculated value for maximum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Maximum Price",
"type": "string"
},
"override_max_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Maximum price currency",
"type": "string"
},
"override_min": {
"description": "Override calculated value for minimum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Minimum Price",
"type": "string"
},
"override_min_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Minimum price currency",
"type": "string"
},
"purchase_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"purchase_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"scheduled_for_update": {
"readOnly": true,
"type": "boolean"
},
"supplier_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"supplier_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"update": {
"default": false,
"description": "Update pricing for this part",
"nullable": true,
"type": "boolean",
"writeOnly": true
},
"updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"variant_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"variant_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"scheduled_for_update"
],
"type": "object"
}
PATCH /api/part/{id}/pricing/¶
Description
API endpoint for viewing part pricing data.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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_cost_max": "string",
"bom_cost_min": "string",
"currency": "string",
"internal_cost_max": "string",
"internal_cost_min": "string",
"overall_max": "string",
"overall_min": "string",
"override_max": "string",
"override_max_currency": "string",
"override_min": "string",
"override_min_currency": "string",
"purchase_cost_max": "string",
"purchase_cost_min": "string",
"sale_history_max": "string",
"sale_history_min": "string",
"sale_price_max": "string",
"sale_price_min": "string",
"scheduled_for_update": true,
"supplier_price_max": "string",
"supplier_price_min": "string",
"update": true,
"updated": "2022-04-13T15:42:05.901Z",
"variant_cost_max": "string",
"variant_cost_min": "string"
}
Schema of the request body
{
"description": "Serializer for Part pricing information.",
"properties": {
"bom_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"bom_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"currency": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"internal_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"internal_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"override_max": {
"description": "Override calculated value for maximum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Maximum Price",
"type": "string"
},
"override_max_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Maximum price currency",
"type": "string"
},
"override_min": {
"description": "Override calculated value for minimum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Minimum Price",
"type": "string"
},
"override_min_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Minimum price currency",
"type": "string"
},
"purchase_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"purchase_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"scheduled_for_update": {
"readOnly": true,
"type": "boolean"
},
"supplier_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"supplier_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"update": {
"default": false,
"description": "Update pricing for this part",
"nullable": true,
"type": "boolean",
"writeOnly": true
},
"updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"variant_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"variant_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
{
"bom_cost_max": "string",
"bom_cost_min": "string",
"currency": "string",
"internal_cost_max": "string",
"internal_cost_min": "string",
"overall_max": "string",
"overall_min": "string",
"override_max": "string",
"override_max_currency": "string",
"override_min": "string",
"override_min_currency": "string",
"purchase_cost_max": "string",
"purchase_cost_min": "string",
"sale_history_max": "string",
"sale_history_min": "string",
"sale_price_max": "string",
"sale_price_min": "string",
"scheduled_for_update": true,
"supplier_price_max": "string",
"supplier_price_min": "string",
"update": true,
"updated": "2022-04-13T15:42:05.901Z",
"variant_cost_max": "string",
"variant_cost_min": "string"
}
Schema of the request body
{
"description": "Serializer for Part pricing information.",
"properties": {
"bom_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"bom_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"currency": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"internal_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"internal_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"override_max": {
"description": "Override calculated value for maximum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Maximum Price",
"type": "string"
},
"override_max_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Maximum price currency",
"type": "string"
},
"override_min": {
"description": "Override calculated value for minimum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Minimum Price",
"type": "string"
},
"override_min_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Minimum price currency",
"type": "string"
},
"purchase_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"purchase_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"scheduled_for_update": {
"readOnly": true,
"type": "boolean"
},
"supplier_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"supplier_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"update": {
"default": false,
"description": "Update pricing for this part",
"nullable": true,
"type": "boolean",
"writeOnly": true
},
"updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"variant_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"variant_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
{
"bom_cost_max": "string",
"bom_cost_min": "string",
"currency": "string",
"internal_cost_max": "string",
"internal_cost_min": "string",
"overall_max": "string",
"overall_min": "string",
"override_max": "string",
"override_max_currency": "string",
"override_min": "string",
"override_min_currency": "string",
"purchase_cost_max": "string",
"purchase_cost_min": "string",
"sale_history_max": "string",
"sale_history_min": "string",
"sale_price_max": "string",
"sale_price_min": "string",
"scheduled_for_update": true,
"supplier_price_max": "string",
"supplier_price_min": "string",
"update": true,
"updated": "2022-04-13T15:42:05.901Z",
"variant_cost_max": "string",
"variant_cost_min": "string"
}
Schema of the request body
{
"description": "Serializer for Part pricing information.",
"properties": {
"bom_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"bom_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"currency": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"internal_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"internal_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"override_max": {
"description": "Override calculated value for maximum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Maximum Price",
"type": "string"
},
"override_max_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Maximum price currency",
"type": "string"
},
"override_min": {
"description": "Override calculated value for minimum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Minimum Price",
"type": "string"
},
"override_min_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Minimum price currency",
"type": "string"
},
"purchase_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"purchase_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"scheduled_for_update": {
"readOnly": true,
"type": "boolean"
},
"supplier_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"supplier_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"update": {
"default": false,
"description": "Update pricing for this part",
"nullable": true,
"type": "boolean",
"writeOnly": true
},
"updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"variant_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"variant_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
Responses
{
"bom_cost_max": "string",
"bom_cost_min": "string",
"currency": "string",
"internal_cost_max": "string",
"internal_cost_min": "string",
"overall_max": "string",
"overall_min": "string",
"override_max": "string",
"override_max_currency": "string",
"override_min": "string",
"override_min_currency": "string",
"purchase_cost_max": "string",
"purchase_cost_min": "string",
"sale_history_max": "string",
"sale_history_min": "string",
"sale_price_max": "string",
"sale_price_min": "string",
"scheduled_for_update": true,
"supplier_price_max": "string",
"supplier_price_min": "string",
"update": true,
"updated": "2022-04-13T15:42:05.901Z",
"variant_cost_max": "string",
"variant_cost_min": "string"
}
Schema of the response body
{
"description": "Serializer for Part pricing information.",
"properties": {
"bom_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"bom_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"currency": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"internal_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"internal_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"override_max": {
"description": "Override calculated value for maximum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Maximum Price",
"type": "string"
},
"override_max_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Maximum price currency",
"type": "string"
},
"override_min": {
"description": "Override calculated value for minimum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Minimum Price",
"type": "string"
},
"override_min_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Minimum price currency",
"type": "string"
},
"purchase_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"purchase_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"scheduled_for_update": {
"readOnly": true,
"type": "boolean"
},
"supplier_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"supplier_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"update": {
"default": false,
"description": "Update pricing for this part",
"nullable": true,
"type": "boolean",
"writeOnly": true
},
"updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"variant_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"variant_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"scheduled_for_update"
],
"type": "object"
}
PUT /api/part/{id}/pricing/¶
Description
API endpoint for viewing part pricing data.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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_cost_max": "string",
"bom_cost_min": "string",
"currency": "string",
"internal_cost_max": "string",
"internal_cost_min": "string",
"overall_max": "string",
"overall_min": "string",
"override_max": "string",
"override_max_currency": "string",
"override_min": "string",
"override_min_currency": "string",
"purchase_cost_max": "string",
"purchase_cost_min": "string",
"sale_history_max": "string",
"sale_history_min": "string",
"sale_price_max": "string",
"sale_price_min": "string",
"scheduled_for_update": true,
"supplier_price_max": "string",
"supplier_price_min": "string",
"update": true,
"updated": "2022-04-13T15:42:05.901Z",
"variant_cost_max": "string",
"variant_cost_min": "string"
}
Schema of the request body
{
"description": "Serializer for Part pricing information.",
"properties": {
"bom_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"bom_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"currency": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"internal_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"internal_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"override_max": {
"description": "Override calculated value for maximum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Maximum Price",
"type": "string"
},
"override_max_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Maximum price currency",
"type": "string"
},
"override_min": {
"description": "Override calculated value for minimum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Minimum Price",
"type": "string"
},
"override_min_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Minimum price currency",
"type": "string"
},
"purchase_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"purchase_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"scheduled_for_update": {
"readOnly": true,
"type": "boolean"
},
"supplier_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"supplier_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"update": {
"default": false,
"description": "Update pricing for this part",
"nullable": true,
"type": "boolean",
"writeOnly": true
},
"updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"variant_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"variant_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"scheduled_for_update"
],
"type": "object"
}
{
"bom_cost_max": "string",
"bom_cost_min": "string",
"currency": "string",
"internal_cost_max": "string",
"internal_cost_min": "string",
"overall_max": "string",
"overall_min": "string",
"override_max": "string",
"override_max_currency": "string",
"override_min": "string",
"override_min_currency": "string",
"purchase_cost_max": "string",
"purchase_cost_min": "string",
"sale_history_max": "string",
"sale_history_min": "string",
"sale_price_max": "string",
"sale_price_min": "string",
"scheduled_for_update": true,
"supplier_price_max": "string",
"supplier_price_min": "string",
"update": true,
"updated": "2022-04-13T15:42:05.901Z",
"variant_cost_max": "string",
"variant_cost_min": "string"
}
Schema of the request body
{
"description": "Serializer for Part pricing information.",
"properties": {
"bom_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"bom_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"currency": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"internal_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"internal_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"override_max": {
"description": "Override calculated value for maximum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Maximum Price",
"type": "string"
},
"override_max_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Maximum price currency",
"type": "string"
},
"override_min": {
"description": "Override calculated value for minimum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Minimum Price",
"type": "string"
},
"override_min_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Minimum price currency",
"type": "string"
},
"purchase_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"purchase_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"scheduled_for_update": {
"readOnly": true,
"type": "boolean"
},
"supplier_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"supplier_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"update": {
"default": false,
"description": "Update pricing for this part",
"nullable": true,
"type": "boolean",
"writeOnly": true
},
"updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"variant_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"variant_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"scheduled_for_update"
],
"type": "object"
}
{
"bom_cost_max": "string",
"bom_cost_min": "string",
"currency": "string",
"internal_cost_max": "string",
"internal_cost_min": "string",
"overall_max": "string",
"overall_min": "string",
"override_max": "string",
"override_max_currency": "string",
"override_min": "string",
"override_min_currency": "string",
"purchase_cost_max": "string",
"purchase_cost_min": "string",
"sale_history_max": "string",
"sale_history_min": "string",
"sale_price_max": "string",
"sale_price_min": "string",
"scheduled_for_update": true,
"supplier_price_max": "string",
"supplier_price_min": "string",
"update": true,
"updated": "2022-04-13T15:42:05.901Z",
"variant_cost_max": "string",
"variant_cost_min": "string"
}
Schema of the request body
{
"description": "Serializer for Part pricing information.",
"properties": {
"bom_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"bom_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"currency": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"internal_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"internal_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"override_max": {
"description": "Override calculated value for maximum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Maximum Price",
"type": "string"
},
"override_max_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Maximum price currency",
"type": "string"
},
"override_min": {
"description": "Override calculated value for minimum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Minimum Price",
"type": "string"
},
"override_min_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Minimum price currency",
"type": "string"
},
"purchase_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"purchase_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"scheduled_for_update": {
"readOnly": true,
"type": "boolean"
},
"supplier_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"supplier_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"update": {
"default": false,
"description": "Update pricing for this part",
"nullable": true,
"type": "boolean",
"writeOnly": true
},
"updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"variant_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"variant_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"scheduled_for_update"
],
"type": "object"
}
Responses
{
"bom_cost_max": "string",
"bom_cost_min": "string",
"currency": "string",
"internal_cost_max": "string",
"internal_cost_min": "string",
"overall_max": "string",
"overall_min": "string",
"override_max": "string",
"override_max_currency": "string",
"override_min": "string",
"override_min_currency": "string",
"purchase_cost_max": "string",
"purchase_cost_min": "string",
"sale_history_max": "string",
"sale_history_min": "string",
"sale_price_max": "string",
"sale_price_min": "string",
"scheduled_for_update": true,
"supplier_price_max": "string",
"supplier_price_min": "string",
"update": true,
"updated": "2022-04-13T15:42:05.901Z",
"variant_cost_max": "string",
"variant_cost_min": "string"
}
Schema of the response body
{
"description": "Serializer for Part pricing information.",
"properties": {
"bom_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"bom_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"currency": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"internal_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"internal_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"override_max": {
"description": "Override calculated value for maximum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Maximum Price",
"type": "string"
},
"override_max_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Maximum price currency",
"type": "string"
},
"override_min": {
"description": "Override calculated value for minimum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Minimum Price",
"type": "string"
},
"override_min_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Minimum price currency",
"type": "string"
},
"purchase_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"purchase_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"scheduled_for_update": {
"readOnly": true,
"type": "boolean"
},
"supplier_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"supplier_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"update": {
"default": false,
"description": "Update pricing for this part",
"nullable": true,
"type": "boolean",
"writeOnly": true
},
"updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"variant_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"variant_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"scheduled_for_update"
],
"type": "object"
}
GET /api/part/{id}/requirements/¶
Description
API endpoint detailing 'requirements' information for a particular part.
This endpoint returns information on upcoming requirements for:
- Sales Orders
- Build Orders
- Total requirements
- How many of this part can be assembled with available stock
As this data is somewhat complex to calculate, is it not included in the default API
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
Responses
{
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"building": 10.12,
"can_build": 10.12,
"ordering": 10.12,
"required_for_build_orders": 10.12,
"required_for_sales_orders": 10.12,
"scheduled_to_build": 0,
"total_stock": 10.12,
"unallocated_stock": 10.12
}
Schema of the response body
{
"description": "Serializer for Part requirements.",
"properties": {
"allocated_to_build_orders": {
"format": "double",
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"description": "Return the allocated sales order quantity.",
"format": "double",
"readOnly": true,
"type": "number"
},
"building": {
"format": "double",
"readOnly": true,
"title": "In Production",
"type": "number"
},
"can_build": {
"format": "double",
"readOnly": true,
"type": "number"
},
"ordering": {
"format": "double",
"readOnly": true,
"title": "On Order",
"type": "number"
},
"required_for_build_orders": {
"format": "double",
"readOnly": true,
"type": "number"
},
"required_for_sales_orders": {
"format": "double",
"readOnly": true,
"type": "number"
},
"scheduled_to_build": {
"readOnly": true,
"type": "integer"
},
"total_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"unallocated_stock": {
"format": "double",
"readOnly": true,
"title": "Available Stock",
"type": "number"
}
},
"required": [
"allocated_to_build_orders",
"allocated_to_sales_orders",
"building",
"can_build",
"ordering",
"required_for_build_orders",
"required_for_sales_orders",
"scheduled_to_build",
"total_stock",
"unallocated_stock"
],
"type": "object"
}
GET /api/part/{id}/serial-numbers/¶
Description
API endpoint for returning extra serial number information about a particular part.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
Responses
{
"latest": "string",
"next": "string"
}
Schema of the response body
{
"description": "Serializer for Part serial number information.",
"properties": {
"latest": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"next": {
"readOnly": true,
"type": "string"
}
},
"required": [
"next"
],
"type": "object"
}
Schemas¶
BlankEnum¶
Type:
BulkRequest¶
| Name | Type | Description |
|---|---|---|
filters |
||
items |
Array<integer> |
Category¶
| Name | Type | Description |
|---|---|---|
default_keywords |
string | null | Default keywords for parts in this category |
default_location |
integer | null | Default location for parts in this category |
description |
string | Description (optional) |
icon |
string | null | Icon (optional) |
level |
integer | |
name |
string | Name |
parent |
integer | null | Parent part category |
parent_default_location |
integer | null | |
part_count |
integer | null | |
path |
Array<> | |
pathstring |
string | Path |
pk |
integer | |
starred |
boolean | Return True if the category is directly "starred" by the current user. |
structural |
boolean | Parts may not be directly assigned to a structural category, but may be assigned to child categories. |
subcategories |
integer | null |
CategoryParameterTemplate¶
| Name | Type | Description |
|---|---|---|
category |
integer | Part Category |
category_detail |
||
default_value |
string | Default Parameter Value |
pk |
integer | |
template |
integer | |
template_detail |
CategoryTree¶
| Name | Type | Description |
|---|---|---|
icon |
string | Icon (optional) |
name |
string | Name |
parent |
integer | null | |
pk |
integer | |
structural |
boolean | Parts may not be directly assigned to a structural category, but may be assigned to child categories. |
subcategories |
integer |
DataOutput¶
| Name | Type | Description |
|---|---|---|
complete |
boolean | |
created |
string(date) | |
errors |
||
output |
string(uri) | null | |
output_type |
string | null | |
pk |
integer | |
plugin |
string | null | |
progress |
integer(int64) | |
template_name |
string | null | |
total |
integer(int64) | |
user |
integer | null | |
user_detail |
DefaultLocation¶
| Name | Type | Description |
|---|---|---|
name |
string | Name |
pathstring |
string | Path |
pk |
integer |
DuplicatePart¶
| Name | Type | Description |
|---|---|---|
copy_bom |
boolean | Copy bill of materials from original part |
copy_image |
boolean | Copy image from original part |
copy_notes |
boolean | Copy notes from original part |
copy_parameters |
boolean | Copy parameter data from original part |
copy_tests |
boolean | Copy test templates from original part |
part |
integer | Select original part to duplicate |
InitialStock¶
| Name | Type | Description |
|---|---|---|
location |
integer | null | Specify initial stock location for this Part |
quantity |
string(decimal) | Specify initial stock quantity for this Part. If quantity is zero, no stock is added. |
InitialSupplier¶
| Name | Type | Description |
|---|---|---|
manufacturer |
integer | null | Select manufacturer (or leave blank to skip) |
mpn |
string | Manufacturer part number |
sku |
string | Supplier stock keeping unit |
supplier |
integer | null | Select supplier (or leave blank to skip) |
ModelType054Enum¶
Type: string
NullEnum¶
Type:
PaginatedCategoryList¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
next |
string(uri) | null | |
previous |
string(uri) | null | |
results |
Array<Category> |
PaginatedCategoryParameterTemplateList¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
next |
string(uri) | null | |
previous |
string(uri) | null | |
results |
Array<CategoryParameterTemplate> |
PaginatedCategoryTreeList¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
next |
string(uri) | null | |
previous |
string(uri) | null | |
results |
Array<CategoryTree> |
PaginatedPartInternalPriceList¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
next |
string(uri) | null | |
previous |
string(uri) | null | |
results |
Array<PartInternalPrice> |
PaginatedPartList¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
next |
string(uri) | null | |
previous |
string(uri) | null | |
results |
Array<Part> |
PaginatedPartRelationList¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
next |
string(uri) | null | |
previous |
string(uri) | null | |
results |
Array<PartRelation> |
PaginatedPartSalePriceList¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
next |
string(uri) | null | |
previous |
string(uri) | null | |
results |
Array<PartSalePrice> |
PaginatedPartStocktakeList¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
next |
string(uri) | null | |
previous |
string(uri) | null | |
results |
Array<PartStocktake> |
PaginatedPartTestTemplateList¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
next |
string(uri) | null | |
previous |
string(uri) | null | |
results |
Array<PartTestTemplate> |
PaginatedPartThumbList¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
next |
string(uri) | null | |
previous |
string(uri) | null | |
results |
Array<PartThumb> |
Parameter¶
| Name | Type | Description |
|---|---|---|
data |
string | Parameter Value |
data_numeric |
number(double) | null | |
model_id |
integer(int64) | ID of the target model for this parameter |
model_type |
||
note |
string | Optional note field |
pk |
integer | |
template |
integer | Parameter template |
template_detail |
||
updated |
string(date-time) | null | Timestamp of last update |
updated_by |
integer | null | User who last updated this object |
updated_by_detail |
ParameterTemplate¶
| Name | Type | Description |
|---|---|---|
checkbox |
boolean | Is this parameter a checkbox? |
choices |
string | Valid choices for this parameter (comma-separated) |
description |
string | Parameter description |
enabled |
boolean | Is this parameter template enabled? |
model_type |
||
name |
string | Parameter Name |
pk |
integer | |
selectionlist |
integer | null | Selection list for this parameter |
units |
string | Physical units for this parameter |
Part¶
| Name | Type | Description |
|---|---|---|
active |
boolean | Is this part active? |
allocated_to_build_orders |
number(double) | null | |
allocated_to_sales_orders |
number(double) | null | |
assembly |
boolean | Can this part be built from other parts? |
barcode_hash |
string | Unique hash of barcode data |
building |
number(double) | null | Quantity of this part currently being in production |
category |
integer | null | |
category_default_location |
integer | null | |
category_detail |
||
category_name |
string | |
category_path |
Array<> | |
component |
boolean | Can this part be used to build other parts? |
copy_category_parameters |
boolean | Copy parameter templates from selected part category |
creation_date |
string(date) | null | |
creation_user |
integer | null | |
default_expiry |
integer(int64) | Expiry time (in days) for stock items of this part |
default_location |
integer | null | Where is this item normally stored? |
default_location_detail |
||
description |
string | Part description (optional) |
duplicate |
Copy initial data from another Part | |
existing_image |
string | Filename of an existing part image |
external_stock |
number(double) | null | |
full_name |
string | Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings. |
image |
string(uri) | null | |
in_stock |
number(double) | null | |
initial_stock |
Create Part with initial stock quantity | |
initial_supplier |
Add initial supplier information for this part | |
IPN |
string | |
is_template |
boolean | Is this part a template part? |
keywords |
string | null | Part keywords to improve visibility in search results |
link |
string(uri) | null | Link to external URL |
locked |
boolean | Locked parts cannot be edited |
minimum_stock |
number(double) | |
name |
string | Part name |
notes |
string | null | Markdown notes (optional) |
ordering |
number(double) | null | |
parameters |
Array<Parameter> | |
pk |
integer | |
price_breaks |
Array<PartSalePrice> | |
pricing_max |
string(decimal) | null | |
pricing_min |
string(decimal) | null | |
pricing_updated |
string(date-time) | null | |
purchaseable |
boolean | Can this part be purchased from external suppliers? |
remote_image |
string(uri) | URL of remote image file |
required_for_build_orders |
integer | null | |
required_for_sales_orders |
integer | null | |
responsible |
integer | null | |
revision |
string | null | |
revision_count |
integer | null | |
revision_of |
integer | null | Is this part a revision of another part? |
salable |
boolean | Can this part be sold to customers? |
scheduled_to_build |
number(double) | null | Outstanding quantity of this part scheduled to be built |
starred |
boolean | Return "true" if the part is starred by the current user. |
stock_item_count |
integer | null | |
tags |
Array<string> | |
testable |
boolean | Can this part have test results recorded against it? |
thumbnail |
string | |
total_in_stock |
number(double) | null | |
trackable |
boolean | Does this part have tracking for unique items? |
unallocated_stock |
number(double) | null | |
units |
string | null | Units of measure for this part |
variant_of |
integer | null | Is this part a variant of another part? |
variant_stock |
number(double) | null | |
virtual |
boolean | Is this a virtual part, such as a software product or license? |
PartBomValidate¶
| Name | Type | Description |
|---|---|---|
bom_checked_by |
integer | null | |
bom_checked_by_detail |
||
bom_checked_date |
string(date) | null | |
bom_checksum |
string | Stored BOM checksum |
bom_validated |
boolean | Is the BOM for this part valid? |
pk |
integer | |
valid |
boolean | Validate entire Bill of Materials |
PartBrief¶
| Name | Type | Description |
|---|---|---|
active |
boolean | Is this part active? |
assembly |
boolean | Can this part be built from other parts? |
barcode_hash |
string | Unique hash of barcode data |
category_default_location |
integer | null | |
component |
boolean | Can this part be used to build other parts? |
default_expiry |
integer(int64) | Expiry time (in days) for stock items of this part |
default_location |
integer | null | Where is this item normally stored? |
description |
string | Part description (optional) |
full_name |
string | Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings. |
image |
string(uri) | null | |
IPN |
string | null | Internal Part Number |
is_template |
boolean | Is this part a template part? |
locked |
boolean | Locked parts cannot be edited |
minimum_stock |
string(decimal) | Minimum allowed stock level |
name |
string | Part name |
pk |
integer | |
pricing_max |
string(decimal) | null | |
pricing_min |
string(decimal) | null | |
purchaseable |
boolean | Can this part be purchased from external suppliers? |
revision |
string | null | |
salable |
boolean | Can this part be sold to customers? |
testable |
boolean | Can this part have test results recorded against it? |
thumbnail |
string | |
trackable |
boolean | Does this part have tracking for unique items? |
units |
string | null | Units of measure for this part |
virtual |
boolean | Is this a virtual part, such as a software product or license? |
PartCopyBOM¶
| Name | Type | Description |
|---|---|---|
copy_substitutes |
boolean | Copy substitute parts when duplicate BOM items |
include_inherited |
boolean | Include BOM items which are inherited from templated parts |
part |
integer | Select part to copy BOM from |
remove_existing |
boolean | Remove existing BOM items before copying |
skip_invalid |
boolean | Enable this option to skip invalid rows |
PartInternalPrice¶
| Name | Type | Description |
|---|---|---|
part |
integer | |
pk |
integer | |
price |
string(decimal) | null | |
price_currency |
string | Purchase currency of this stock item * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting. |
quantity |
number(double) |
PartPricing¶
| Name | Type | Description |
|---|---|---|
bom_cost_max |
string(decimal) | null | |
bom_cost_min |
string(decimal) | null | |
currency |
string | null | |
internal_cost_max |
string(decimal) | null | |
internal_cost_min |
string(decimal) | null | |
overall_max |
string(decimal) | null | |
overall_min |
string(decimal) | null | |
override_max |
string(decimal) | null | Override calculated value for maximum price |
override_max_currency |
string | Select currency from available options * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting. |
override_min |
string(decimal) | null | Override calculated value for minimum price |
override_min_currency |
string | Select currency from available options * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting. |
purchase_cost_max |
string(decimal) | null | |
purchase_cost_min |
string(decimal) | null | |
sale_history_max |
string(decimal) | null | |
sale_history_min |
string(decimal) | null | |
sale_price_max |
string(decimal) | null | |
sale_price_min |
string(decimal) | null | |
scheduled_for_update |
boolean | |
supplier_price_max |
string(decimal) | null | |
supplier_price_min |
string(decimal) | null | |
update |
boolean | null | Update pricing for this part |
updated |
string(date-time) | null | |
variant_cost_max |
string(decimal) | null | |
variant_cost_min |
string(decimal) | null |
PartRelation¶
| Name | Type | Description |
|---|---|---|
note |
string | Note for this relationship |
part_1 |
integer | |
part_1_detail |
||
part_2 |
integer | Select Related Part |
part_2_detail |
||
pk |
integer |
PartRequirements¶
| Name | Type | Description |
|---|---|---|
allocated_to_build_orders |
number(double) | |
allocated_to_sales_orders |
number(double) | Return the allocated sales order quantity. |
building |
number(double) | |
can_build |
number(double) | |
ordering |
number(double) | |
required_for_build_orders |
number(double) | |
required_for_sales_orders |
number(double) | |
scheduled_to_build |
integer | |
total_stock |
number(double) | |
unallocated_stock |
number(double) |
PartSalePrice¶
| Name | Type | Description |
|---|---|---|
part |
integer | |
pk |
integer | |
price |
string(decimal) | null | |
price_currency |
string | Purchase currency of this stock item * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting. |
quantity |
number(double) |
PartSerialNumber¶
| Name | Type | Description |
|---|---|---|
latest |
string | null | |
next |
string |
PartStocktake¶
| Name | Type | Description |
|---|---|---|
cost_max |
string(decimal) | null | |
cost_max_currency |
string | Select currency from available options * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting. |
cost_min |
string(decimal) | null | |
cost_min_currency |
string | Select currency from available options * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting. |
date |
string(date) | Date stocktake was performed |
item_count |
integer(int64) | Number of individual stock entries at time of stocktake |
part |
integer | Part for stocktake |
part_description |
string | null | |
part_detail |
||
part_ipn |
string | null | |
part_name |
string | |
pk |
integer | |
quantity |
number(double) |
PartStocktakeGenerate¶
| Name | Type | Description |
|---|---|---|
category |
integer | null | Select a category to include all parts within that category (and subcategories) |
generate_entry |
boolean | Save stocktake entries for the selected parts |
generate_report |
boolean | Generate a stocktake report for the selected parts |
location |
integer | null | Select a location to include all parts with stock in that location (including sub-locations) |
output |
||
part |
integer | null | Select a part to generate stocktake information for that part (and any variant parts) |
PartTestTemplate¶
| Name | Type | Description |
|---|---|---|
choices |
string | Valid choices for this test (comma-separated) |
description |
string | null | Enter description for this test |
enabled |
boolean | Is this test enabled? |
key |
string | |
part |
integer | |
pk |
integer | |
required |
boolean | Is this test required to pass? |
requires_attachment |
boolean | Does this test require a file attachment when adding a test result? |
requires_value |
boolean | Does this test require a value when adding a test result? |
results |
integer | Number of results recorded against this template |
test_name |
string | Enter a name for the test |
PartThumb¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
image |
string(uri) |
PartThumbSerializerUpdate¶
| Name | Type | Description |
|---|---|---|
image |
string(uri) |
PatchedCategory¶
| Name | Type | Description |
|---|---|---|
default_keywords |
string | null | Default keywords for parts in this category |
default_location |
integer | null | Default location for parts in this category |
description |
string | Description (optional) |
icon |
string | null | Icon (optional) |
level |
integer | |
name |
string | Name |
parent |
integer | null | Parent part category |
parent_default_location |
integer | null | |
part_count |
integer | null | |
path |
Array<> | |
pathstring |
string | Path |
pk |
integer | |
starred |
boolean | Return True if the category is directly "starred" by the current user. |
structural |
boolean | Parts may not be directly assigned to a structural category, but may be assigned to child categories. |
subcategories |
integer | null |
PatchedCategoryParameterTemplate¶
| Name | Type | Description |
|---|---|---|
category |
integer | Part Category |
category_detail |
||
default_value |
string | Default Parameter Value |
pk |
integer | |
template |
integer | |
template_detail |
PatchedPart¶
| Name | Type | Description |
|---|---|---|
active |
boolean | Is this part active? |
allocated_to_build_orders |
number(double) | null | |
allocated_to_sales_orders |
number(double) | null | |
assembly |
boolean | Can this part be built from other parts? |
barcode_hash |
string | Unique hash of barcode data |
building |
number(double) | null | Quantity of this part currently being in production |
category |
integer | null | |
category_default_location |
integer | null | |
category_detail |
||
category_name |
string | |
category_path |
Array<> | |
component |
boolean | Can this part be used to build other parts? |
copy_category_parameters |
boolean | Copy parameter templates from selected part category |
creation_date |
string(date) | null | |
creation_user |
integer | null | |
default_expiry |
integer(int64) | Expiry time (in days) for stock items of this part |
default_location |
integer | null | Where is this item normally stored? |
default_location_detail |
||
description |
string | Part description (optional) |
duplicate |
Copy initial data from another Part | |
existing_image |
string | Filename of an existing part image |
external_stock |
number(double) | null | |
full_name |
string | Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings. |
image |
string(uri) | null | |
in_stock |
number(double) | null | |
initial_stock |
Create Part with initial stock quantity | |
initial_supplier |
Add initial supplier information for this part | |
IPN |
string | |
is_template |
boolean | Is this part a template part? |
keywords |
string | null | Part keywords to improve visibility in search results |
link |
string(uri) | null | Link to external URL |
locked |
boolean | Locked parts cannot be edited |
minimum_stock |
number(double) | |
name |
string | Part name |
notes |
string | null | Markdown notes (optional) |
ordering |
number(double) | null | |
parameters |
Array<Parameter> | |
pk |
integer | |
price_breaks |
Array<PartSalePrice> | |
pricing_max |
string(decimal) | null | |
pricing_min |
string(decimal) | null | |
pricing_updated |
string(date-time) | null | |
purchaseable |
boolean | Can this part be purchased from external suppliers? |
remote_image |
string(uri) | URL of remote image file |
required_for_build_orders |
integer | null | |
required_for_sales_orders |
integer | null | |
responsible |
integer | null | |
revision |
string | null | |
revision_count |
integer | null | |
revision_of |
integer | null | Is this part a revision of another part? |
salable |
boolean | Can this part be sold to customers? |
scheduled_to_build |
number(double) | null | Outstanding quantity of this part scheduled to be built |
starred |
boolean | Return "true" if the part is starred by the current user. |
stock_item_count |
integer | null | |
tags |
Array<string> | |
testable |
boolean | Can this part have test results recorded against it? |
thumbnail |
string | |
total_in_stock |
number(double) | null | |
trackable |
boolean | Does this part have tracking for unique items? |
unallocated_stock |
number(double) | null | |
units |
string | null | Units of measure for this part |
variant_of |
integer | null | Is this part a variant of another part? |
variant_stock |
number(double) | null | |
virtual |
boolean | Is this a virtual part, such as a software product or license? |
PatchedPartBomValidate¶
| Name | Type | Description |
|---|---|---|
bom_checked_by |
integer | null | |
bom_checked_by_detail |
||
bom_checked_date |
string(date) | null | |
bom_checksum |
string | Stored BOM checksum |
bom_validated |
boolean | Is the BOM for this part valid? |
pk |
integer | |
valid |
boolean | Validate entire Bill of Materials |
PatchedPartInternalPrice¶
| Name | Type | Description |
|---|---|---|
part |
integer | |
pk |
integer | |
price |
string(decimal) | null | |
price_currency |
string | Purchase currency of this stock item * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting. |
quantity |
number(double) |
PatchedPartPricing¶
| Name | Type | Description |
|---|---|---|
bom_cost_max |
string(decimal) | null | |
bom_cost_min |
string(decimal) | null | |
currency |
string | null | |
internal_cost_max |
string(decimal) | null | |
internal_cost_min |
string(decimal) | null | |
overall_max |
string(decimal) | null | |
overall_min |
string(decimal) | null | |
override_max |
string(decimal) | null | Override calculated value for maximum price |
override_max_currency |
string | Select currency from available options * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting. |
override_min |
string(decimal) | null | Override calculated value for minimum price |
override_min_currency |
string | Select currency from available options * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting. |
purchase_cost_max |
string(decimal) | null | |
purchase_cost_min |
string(decimal) | null | |
sale_history_max |
string(decimal) | null | |
sale_history_min |
string(decimal) | null | |
sale_price_max |
string(decimal) | null | |
sale_price_min |
string(decimal) | null | |
scheduled_for_update |
boolean | |
supplier_price_max |
string(decimal) | null | |
supplier_price_min |
string(decimal) | null | |
update |
boolean | null | Update pricing for this part |
updated |
string(date-time) | null | |
variant_cost_max |
string(decimal) | null | |
variant_cost_min |
string(decimal) | null |
PatchedPartRelation¶
| Name | Type | Description |
|---|---|---|
note |
string | Note for this relationship |
part_1 |
integer | |
part_1_detail |
||
part_2 |
integer | Select Related Part |
part_2_detail |
||
pk |
integer |
PatchedPartSalePrice¶
| Name | Type | Description |
|---|---|---|
part |
integer | |
pk |
integer | |
price |
string(decimal) | null | |
price_currency |
string | Purchase currency of this stock item * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting. |
quantity |
number(double) |
PatchedPartStocktake¶
| Name | Type | Description |
|---|---|---|
cost_max |
string(decimal) | null | |
cost_max_currency |
string | Select currency from available options * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting. |
cost_min |
string(decimal) | null | |
cost_min_currency |
string | Select currency from available options * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting. |
date |
string(date) | Date stocktake was performed |
item_count |
integer(int64) | Number of individual stock entries at time of stocktake |
part |
integer | Part for stocktake |
part_description |
string | null | |
part_detail |
||
part_ipn |
string | null | |
part_name |
string | |
pk |
integer | |
quantity |
number(double) |
PatchedPartTestTemplate¶
| Name | Type | Description |
|---|---|---|
choices |
string | Valid choices for this test (comma-separated) |
description |
string | null | Enter description for this test |
enabled |
boolean | Is this test enabled? |
key |
string | |
part |
integer | |
pk |
integer | |
required |
boolean | Is this test required to pass? |
requires_attachment |
boolean | Does this test require a file attachment when adding a test result? |
requires_value |
boolean | Does this test require a value when adding a test result? |
results |
integer | Number of results recorded against this template |
test_name |
string | Enter a name for the test |
PatchedPartThumbSerializerUpdate¶
| Name | Type | Description |
|---|---|---|
image |
string(uri) |
User¶
| Name | Type | Description |
|---|---|---|
email |
string(email) | Email address of the user |
first_name |
string | First name of the user |
last_name |
string | Last name of the user |
pk |
integer | |
username |
string | Username |
Common responses¶
This section describes common responses that are reused across operations.
allauth.AddAuthenticatorConflict¶
The account prohibits adding an authenticator, e.g. because of an unverified email address.
Schema of the response body
null
allauth.AddWebAuthnAuthenticator¶
A WebAuthn authenticator.
{
"data": null,
"meta": {
"recovery_codes_generated": true
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.WebAuthnAuthenticator"
},
"meta": {
"properties": {
"recovery_codes_generated": {
"description": "Whether or not recovery codes where generated automatically.\n",
"type": "boolean"
}
},
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data",
"meta"
],
"type": "object"
}
allauth.Authenticated¶
The user is authenticated.
Schema of the response body
null
allauth.AuthenticatedByCode¶
Authenticated by code.
{
"summary": "Authenticated by code.\n",
"value": {
"data": {
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "code"
}
],
"user": {
"display": "Magic Wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdW",
"is_authenticated": true,
"session_token": "ufwcig0zen9skyd545jc0fkq813ghar2"
},
"status": 200
}
}
Schema of the response body
null
allauth.AuthenticatedByPassword¶
Authenticated by password.
{
"summary": "Authenticated by password.\n",
"value": {
"data": {
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "password"
}
],
"user": {
"display": "Magic Wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdW",
"is_authenticated": true,
"session_token": "ufwcig0zen9skyd545jc0fkq813ghar2"
},
"status": 200
}
}
Schema of the response body
null
allauth.AuthenticatedByPasswordAnd2FA¶
Authenticated by password and 2FA.
{
"summary": "Fully authenticated using by password and 2FA.\n",
"value": {
"data": {
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "password"
},
{
"at": 1711555060.9375854,
"id": 66,
"method": "mfa",
"type": "totp"
}
],
"user": {
"display": "Magic Wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdW",
"is_authenticated": true,
"session_token": "ufwcig0zen9skyd545jc0fkq813ghar2"
},
"status": 200
}
}
Schema of the response body
null
allauth.Authentication¶
Not authenticated.
{
"summary": "Reauthentication required\n",
"value": {
"data": {
"flows": [
{
"id": "reauthenticate"
},
{
"id": "mfa_reauthenticate"
}
],
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "password"
},
{
"at": 1711555060.9375854,
"id": 66,
"method": "mfa",
"type": "totp"
}
],
"user": {
"display": "Magic Wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"is_authenticated": true
},
"status": 401
}
}
{
"summary": "Unauthenticated: Initial\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
{
"summary": "Unauthenticated: pending 2FA\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
},
{
"id": "mfa_authenticate",
"is_pending": true
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
{
"summary": "Unauthenticated: pending email verification\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
},
{
"id": "verify_email",
"is_pending": true
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
{
"summary": "Unauthenticated: pending provider signup\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
},
{
"id": "provider_signup",
"is_pending": true,
"provider": {
"client_id": "123.apps.googleusercontent.com",
"flows": [
"provider_redirect",
"provider_token"
],
"id": "google",
"name": "Google"
}
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
Schema of the response body
null
allauth.AuthenticationOrReauthentication¶
The response indicates authentication or re-authentication is required.
Schema of the response body
{
"oneOf": [
{
"$ref": "#/components/schemas/allauth.AuthenticationResponse"
},
{
"$ref": "#/components/schemas/allauth.ReauthenticationResponse"
}
]
}
allauth.Authenticators¶
List of authenticators.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.AuthenticatorList"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.Configuration¶
The django-allauth configuration.
Schema of the response body
null
allauth.EmailAddresses¶
List of email addresses.
{
"data": [
null
],
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/allauth.EmailAddress"
},
"type": "array"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.EmailVerificationInfo¶
Email verification information.
Schema of the response body
null
allauth.Error¶
An input error occurred.
Schema of the response body
null
allauth.Forbidden¶
A forbidden response.
Schema of the response body
null
allauth.NotFound¶
Not found.
{
"status": 404
}
Schema of the response body
{
"properties": {
"status": {
"enum": [
404
],
"type": "integer"
}
},
"required": [
"status"
],
"type": "object"
}
allauth.PasswordResetInfo¶
Information about the password reset key.
{
"data": {
"user": null
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"properties": {
"user": {
"$ref": "#/components/schemas/allauth.User"
}
},
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.PhoneNumbers¶
List of phone numbers.
Schema of the response body
null
allauth.ProviderAccounts¶
List of third-party provider accounts.
{
"data": [
null
],
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/allauth.ProviderAccount"
},
"type": "array"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.ProviderSignup¶
Information relating to the pending provider signup.
{
"data": {
"account": null,
"email": [
null
],
"user": null
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"properties": {
"account": {
"$ref": "#/components/schemas/allauth.ProviderAccount"
},
"email": {
"items": {
"$ref": "#/components/schemas/allauth.EmailAddress"
},
"type": "array"
},
"user": {
"$ref": "#/components/schemas/allauth.User"
}
},
"required": [
"email",
"account",
"user"
],
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.ReauthenticationRequired¶
The response indicates reauthentication is required.
{
"data": {
"flows": [
{
"id": "reauthenticate"
},
{
"id": "mfa_reauthenticate"
}
],
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "password"
},
{
"at": 1711555060.9375854,
"id": 66,
"method": "mfa",
"type": "totp"
}
],
"user": {
"display": "Magic Wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"is_authenticated": true
},
"status": 401
}
Schema of the response body
null
allauth.RecoveryCodes¶
Information on the recovery codes.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.SensitiveRecoveryCodesAuthenticator"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.RefreshToken¶
A new access token (and optionally new refresh token).
{
"data": {
"access_token": null,
"refresh_token": null
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"properties": {
"access_token": {
"$ref": "#/components/schemas/allauth.AccessToken"
},
"refresh_token": {
"$ref": "#/components/schemas/allauth.RefreshToken"
}
},
"required": [
"access_token"
],
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"data",
"status"
],
"type": "object"
}
allauth.SessionGone¶
The response indicates session is invalid or no longer exists.
{
"summary": "Unauthenticated: Initial\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
Schema of the response body
null
allauth.Sessions¶
List of sessions.
{
"data": [
null
],
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/allauth.Session"
},
"type": "array"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.StatusOK¶
A success response.
{
"status": null
}
Schema of the response body
{
"properties": {
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status"
],
"type": "object"
}
allauth.TOTPAuthenticator¶
Information on the TOTP authenticator.
{
"data": null,
"meta": {
"recovery_codes_generated": true
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.TOTPAuthenticator"
},
"meta": {
"properties": {
"recovery_codes_generated": {
"description": "Whether or not recovery codes where generated automatically.",
"type": "boolean"
}
},
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.TOTPAuthenticatorNotFound¶
No TOTP authenticator has been set up.
{
"meta": {
"secret": "J4ZKKXTK7NOVU7EPUVY23LCDV4T2QZYM",
"totp_url": "otpauth://totp/Example:alice@fsf.org?secret=JBSWY3DPEHPK3PXP&issuer=Example"
},
"status": 404
}
Schema of the response body
{
"properties": {
"meta": {
"properties": {
"secret": {
"description": "A TOTP secret that can be used to setup a new authenticator.\n",
"example": "J4ZKKXTK7NOVU7EPUVY23LCDV4T2QZYM",
"type": "string"
},
"totp_url": {
"description": "otpauth URI from which a QR code can be generated and scanned by OTP clients.\n",
"example": "otpauth://totp/Example:alice@fsf.org?secret=JBSWY3DPEHPK3PXP&issuer=Example",
"type": "string"
}
},
"required": [
"secret",
"totp_url"
],
"type": "object"
},
"status": {
"enum": [
404
],
"type": "integer"
}
},
"required": [
"status",
"meta"
],
"type": "object"
}
allauth.TooManyRequests¶
Too many requests.
{
"status": 429
}
Schema of the response body
{
"properties": {
"status": {
"enum": [
429
],
"type": "integer"
}
},
"required": [
"status"
],
"type": "object"
}
allauth.Unauthenticated¶
There is no authenticated session.
{
"summary": "Unauthenticated: Initial\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
Schema of the response body
null
allauth.WebAuthnAuthenticator¶
A WebAuthn authenticator.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.WebAuthnAuthenticator"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.WebAuthnCreationOptionsResponse¶
WebAuthn credential creation options.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.WebAuthnCredentialCreationOptions"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.WebAuthnRequestOptionsResponse¶
WebAuthn credential request options.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.WebAuthnCredentialRequestOptions"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
Common parameters¶
This section describes common parameters that are reused across operations.
allauth.EmailVerificationKey¶
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
X-Email-Verification-Key |
header | string | No |
allauth.PasswordLess¶
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
passwordless |
query | boolean | No |
allauth.PasswordResetKey¶
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
X-Password-Reset-Key |
header | string | No |
Security schemes¶
| Name | Type | Scheme | Description |
|---|---|---|---|
| basicAuth | http | basic | |
| cookieAuth | apiKey | ||
| oauth2 | oauth2 | ||
| 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