Skip to content

The Barcode Scanning section of the InvenTree API schema is documented below.

InvenTree API 291

API for InvenTree - the intuitive open source inventory management system

License: MIT

Servers

Description URL
http://localhost:8000 http://localhost:8000

barcode

POST /api/barcode/

Description

Endpoint for handling generic barcode scan requests.

Barcode data are decoded by the client application, and sent to this endpoint (as a JSON object) for validation.

A barcode could follow the internal InvenTree barcode format, or it could match to a third-party barcode format (e.g. Digikey).

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"

Request body

{
    "barcode": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
{
    "description": "Generic serializer for receiving barcode data.",
    "properties": {
        "barcode": {
            "description": "Scanned barcode data",
            "maxLength": 4095,
            "type": "string"
        }
    },
    "required": [
        "barcode"
    ],
    "type": "object"
}


{
    "barcode": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
{
    "description": "Generic serializer for receiving barcode data.",
    "properties": {
        "barcode": {
            "description": "Scanned barcode data",
            "maxLength": 4095,
            "type": "string"
        }
    },
    "required": [
        "barcode"
    ],
    "type": "object"
}


{
    "barcode": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
{
    "description": "Generic serializer for receiving barcode data.",
    "properties": {
        "barcode": {
            "description": "Scanned barcode data",
            "maxLength": 4095,
            "type": "string"
        }
    },
    "required": [
        "barcode"
    ],
    "type": "object"
}

Response 201 Created 

{
    "barcode": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "description": "Generic serializer for receiving barcode data.",
    "properties": {
        "barcode": {
            "description": "Scanned barcode data",
            "maxLength": 4095,
            "type": "string"
        }
    },
    "required": [
        "barcode"
    ],
    "type": "object"
}

POST /api/barcode/generate/

Description

Endpoint for generating a barcode for a database object.

The barcode is generated by the selected barcode plugin.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"

Request body

{
    "model": "string",
    "pk": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
{
    "description": "Serializer for generating a barcode.",
    "properties": {
        "model": {
            "description": "Model name to generate barcode for",
            "type": "string"
        },
        "pk": {
            "description": "Primary key of model object to generate barcode for",
            "type": "integer"
        }
    },
    "required": [
        "model",
        "pk"
    ],
    "type": "object"
}


{
    "model": "string",
    "pk": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
{
    "description": "Serializer for generating a barcode.",
    "properties": {
        "model": {
            "description": "Model name to generate barcode for",
            "type": "string"
        },
        "pk": {
            "description": "Primary key of model object to generate barcode for",
            "type": "integer"
        }
    },
    "required": [
        "model",
        "pk"
    ],
    "type": "object"
}


{
    "model": "string",
    "pk": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
{
    "description": "Serializer for generating a barcode.",
    "properties": {
        "model": {
            "description": "Model name to generate barcode for",
            "type": "string"
        },
        "pk": {
            "description": "Primary key of model object to generate barcode for",
            "type": "integer"
        }
    },
    "required": [
        "model",
        "pk"
    ],
    "type": "object"
}

Response 200 OK 

{
    "barcode": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "description": "Generic serializer for receiving barcode data.",
    "properties": {
        "barcode": {
            "description": "Scanned barcode data",
            "maxLength": 4095,
            "type": "string"
        }
    },
    "required": [
        "barcode"
    ],
    "type": "object"
}

DELETE /api/barcode/history/

Description

Perform a DELETE operation against this list endpoint.

We expect a list of primary-key (ID) values to be supplied as a JSON object, e.g. { items: [4, 8, 15, 16, 23, 42] }

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"

Response 204 No Content

GET /api/barcode/history/

Description

List API endpoint for BarcodeScan objects.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
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.
result query boolean No
search query string No A search term.
user query integer No

Response 200 OK 

{
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100",
    "results": [
        {
            "context": null,
            "data": "string",
            "endpoint": "string",
            "pk": 0,
            "response": null,
            "result": true,
            "timestamp": "2022-04-13T15:42:05.901Z",
            "user": 0,
            "user_detail": null
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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/BarcodeScanResult"
            },
            "type": "array"
        }
    },
    "type": "object"
}

DELETE /api/barcode/history/{id}/

Description

Detail endpoint for a BarcodeScan object.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Response 204 No Content

GET /api/barcode/history/{id}/

Description

Detail endpoint for a BarcodeScan object.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Response 200 OK 

{
    "context": null,
    "data": "string",
    "endpoint": "string",
    "pk": 0,
    "response": null,
    "result": true,
    "timestamp": "2022-04-13T15:42:05.901Z",
    "user": 0,
    "user_detail": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "description": "Serializer for barcode scan results.",
    "properties": {
        "context": {
            "description": "Context data for the barcode scan",
            "nullable": true,
            "readOnly": true
        },
        "data": {
            "description": "Barcode data",
            "readOnly": true,
            "type": "string"
        },
        "endpoint": {
            "description": "URL endpoint which processed the barcode",
            "nullable": true,
            "readOnly": true,
            "title": "Path",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "response": {
            "description": "Response data from the barcode scan",
            "nullable": true,
            "readOnly": true
        },
        "result": {
            "description": "Was the barcode scan successful?",
            "readOnly": true,
            "type": "boolean"
        },
        "timestamp": {
            "description": "Date and time of the barcode scan",
            "format": "date-time",
            "readOnly": true,
            "type": "string"
        },
        "user": {
            "description": "User who scanned the barcode",
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "user_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "context",
        "data",
        "endpoint",
        "pk",
        "response",
        "result",
        "timestamp",
        "user",
        "user_detail"
    ],
    "type": "object"
}

POST /api/barcode/link/

Description

Endpoint for assigning a barcode to a stock item.

  • This only works if the barcode is not already associated with an object in the database
  • If the barcode does not match an object, then the barcode hash is assigned to the StockItem

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"

Request body

{
    "barcode": "string",
    "build": 0,
    "manufacturerpart": 0,
    "part": 0,
    "purchaseorder": 0,
    "returnorder": 0,
    "salesorder": 0,
    "stockitem": 0,
    "stocklocation": 0,
    "supplierpart": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
{
    "description": "Serializer class for linking a barcode to an internal model.",
    "properties": {
        "barcode": {
            "description": "Scanned barcode data",
            "maxLength": 4095,
            "type": "string"
        },
        "build": {
            "nullable": true,
            "title": "Build Order",
            "type": "integer"
        },
        "manufacturerpart": {
            "nullable": true,
            "title": "Manufacturer Part",
            "type": "integer"
        },
        "part": {
            "nullable": true,
            "type": "integer"
        },
        "purchaseorder": {
            "nullable": true,
            "title": "Purchase Order",
            "type": "integer"
        },
        "returnorder": {
            "nullable": true,
            "title": "Return Order",
            "type": "integer"
        },
        "salesorder": {
            "nullable": true,
            "title": "Sales Order",
            "type": "integer"
        },
        "stockitem": {
            "nullable": true,
            "title": "Stock Item",
            "type": "integer"
        },
        "stocklocation": {
            "nullable": true,
            "title": "Stock Location",
            "type": "integer"
        },
        "supplierpart": {
            "nullable": true,
            "title": "Supplier Part",
            "type": "integer"
        }
    },
    "required": [
        "barcode"
    ],
    "type": "object"
}


{
    "barcode": "string",
    "build": 0,
    "manufacturerpart": 0,
    "part": 0,
    "purchaseorder": 0,
    "returnorder": 0,
    "salesorder": 0,
    "stockitem": 0,
    "stocklocation": 0,
    "supplierpart": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
{
    "description": "Serializer class for linking a barcode to an internal model.",
    "properties": {
        "barcode": {
            "description": "Scanned barcode data",
            "maxLength": 4095,
            "type": "string"
        },
        "build": {
            "nullable": true,
            "title": "Build Order",
            "type": "integer"
        },
        "manufacturerpart": {
            "nullable": true,
            "title": "Manufacturer Part",
            "type": "integer"
        },
        "part": {
            "nullable": true,
            "type": "integer"
        },
        "purchaseorder": {
            "nullable": true,
            "title": "Purchase Order",
            "type": "integer"
        },
        "returnorder": {
            "nullable": true,
            "title": "Return Order",
            "type": "integer"
        },
        "salesorder": {
            "nullable": true,
            "title": "Sales Order",
            "type": "integer"
        },
        "stockitem": {
            "nullable": true,
            "title": "Stock Item",
            "type": "integer"
        },
        "stocklocation": {
            "nullable": true,
            "title": "Stock Location",
            "type": "integer"
        },
        "supplierpart": {
            "nullable": true,
            "title": "Supplier Part",
            "type": "integer"
        }
    },
    "required": [
        "barcode"
    ],
    "type": "object"
}


{
    "barcode": "string",
    "build": 0,
    "manufacturerpart": 0,
    "part": 0,
    "purchaseorder": 0,
    "returnorder": 0,
    "salesorder": 0,
    "stockitem": 0,
    "stocklocation": 0,
    "supplierpart": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
{
    "description": "Serializer class for linking a barcode to an internal model.",
    "properties": {
        "barcode": {
            "description": "Scanned barcode data",
            "maxLength": 4095,
            "type": "string"
        },
        "build": {
            "nullable": true,
            "title": "Build Order",
            "type": "integer"
        },
        "manufacturerpart": {
            "nullable": true,
            "title": "Manufacturer Part",
            "type": "integer"
        },
        "part": {
            "nullable": true,
            "type": "integer"
        },
        "purchaseorder": {
            "nullable": true,
            "title": "Purchase Order",
            "type": "integer"
        },
        "returnorder": {
            "nullable": true,
            "title": "Return Order",
            "type": "integer"
        },
        "salesorder": {
            "nullable": true,
            "title": "Sales Order",
            "type": "integer"
        },
        "stockitem": {
            "nullable": true,
            "title": "Stock Item",
            "type": "integer"
        },
        "stocklocation": {
            "nullable": true,
            "title": "Stock Location",
            "type": "integer"
        },
        "supplierpart": {
            "nullable": true,
            "title": "Supplier Part",
            "type": "integer"
        }
    },
    "required": [
        "barcode"
    ],
    "type": "object"
}

Response 201 Created 

{
    "barcode": "string",
    "build": 0,
    "manufacturerpart": 0,
    "part": 0,
    "purchaseorder": 0,
    "returnorder": 0,
    "salesorder": 0,
    "stockitem": 0,
    "stocklocation": 0,
    "supplierpart": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "description": "Serializer class for linking a barcode to an internal model.",
    "properties": {
        "barcode": {
            "description": "Scanned barcode data",
            "maxLength": 4095,
            "type": "string"
        },
        "build": {
            "nullable": true,
            "title": "Build Order",
            "type": "integer"
        },
        "manufacturerpart": {
            "nullable": true,
            "title": "Manufacturer Part",
            "type": "integer"
        },
        "part": {
            "nullable": true,
            "type": "integer"
        },
        "purchaseorder": {
            "nullable": true,
            "title": "Purchase Order",
            "type": "integer"
        },
        "returnorder": {
            "nullable": true,
            "title": "Return Order",
            "type": "integer"
        },
        "salesorder": {
            "nullable": true,
            "title": "Sales Order",
            "type": "integer"
        },
        "stockitem": {
            "nullable": true,
            "title": "Stock Item",
            "type": "integer"
        },
        "stocklocation": {
            "nullable": true,
            "title": "Stock Location",
            "type": "integer"
        },
        "supplierpart": {
            "nullable": true,
            "title": "Supplier Part",
            "type": "integer"
        }
    },
    "required": [
        "barcode"
    ],
    "type": "object"
}

POST /api/barcode/po-allocate/

Description

Endpoint for allocating parts to a purchase order by scanning their barcode.

Note that the scanned barcode may point to:

  • A Part object
  • A ManufacturerPart object
  • A SupplierPart object

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"

Request body

{
    "barcode": "string",
    "purchase_order": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
{
    "description": "Serializer for allocating items against a purchase order.\n\nThe scanned barcode could be a Part, ManufacturerPart or SupplierPart object",
    "properties": {
        "barcode": {
            "description": "Scanned barcode data",
            "maxLength": 4095,
            "type": "string"
        },
        "purchase_order": {
            "description": "Purchase Order to allocate items against",
            "type": "integer"
        }
    },
    "required": [
        "barcode",
        "purchase_order"
    ],
    "type": "object"
}


{
    "barcode": "string",
    "purchase_order": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
{
    "description": "Serializer for allocating items against a purchase order.\n\nThe scanned barcode could be a Part, ManufacturerPart or SupplierPart object",
    "properties": {
        "barcode": {
            "description": "Scanned barcode data",
            "maxLength": 4095,
            "type": "string"
        },
        "purchase_order": {
            "description": "Purchase Order to allocate items against",
            "type": "integer"
        }
    },
    "required": [
        "barcode",
        "purchase_order"
    ],
    "type": "object"
}


{
    "barcode": "string",
    "purchase_order": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
{
    "description": "Serializer for allocating items against a purchase order.\n\nThe scanned barcode could be a Part, ManufacturerPart or SupplierPart object",
    "properties": {
        "barcode": {
            "description": "Scanned barcode data",
            "maxLength": 4095,
            "type": "string"
        },
        "purchase_order": {
            "description": "Purchase Order to allocate items against",
            "type": "integer"
        }
    },
    "required": [
        "barcode",
        "purchase_order"
    ],
    "type": "object"
}

Response 201 Created 

{
    "barcode": "string",
    "purchase_order": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "description": "Serializer for allocating items against a purchase order.\n\nThe scanned barcode could be a Part, ManufacturerPart or SupplierPart object",
    "properties": {
        "barcode": {
            "description": "Scanned barcode data",
            "maxLength": 4095,
            "type": "string"
        },
        "purchase_order": {
            "description": "Purchase Order to allocate items against",
            "type": "integer"
        }
    },
    "required": [
        "barcode",
        "purchase_order"
    ],
    "type": "object"
}

POST /api/barcode/po-receive/

Description

Endpoint for handling receiving parts by scanning their barcode.

Barcode data are decoded by the client application, and sent to this endpoint (as a JSON object) for validation.

The barcode should follow a third-party barcode format (e.g. Digikey) and ideally contain order_number and quantity information.

The following parameters are available:

  • barcode: The raw barcode data (required)
  • purchase_order: The purchase order containing the item to receive (optional)
  • location: The destination location for the received item (optional)

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"

Request body

{
    "barcode": "string",
    "location": 0,
    "purchase_order": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
{
    "description": "Serializer for receiving items against a purchase order.\n\nThe following additional fields may be specified:\n\n- purchase_order: PurchaseOrder object to receive items against\n- location: Location to receive items into",
    "properties": {
        "barcode": {
            "description": "Scanned barcode data",
            "maxLength": 4095,
            "type": "string"
        },
        "location": {
            "description": "Location to receive items into",
            "nullable": true,
            "type": "integer"
        },
        "purchase_order": {
            "description": "PurchaseOrder to receive items against",
            "nullable": true,
            "type": "integer"
        }
    },
    "required": [
        "barcode"
    ],
    "type": "object"
}


{
    "barcode": "string",
    "location": 0,
    "purchase_order": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
{
    "description": "Serializer for receiving items against a purchase order.\n\nThe following additional fields may be specified:\n\n- purchase_order: PurchaseOrder object to receive items against\n- location: Location to receive items into",
    "properties": {
        "barcode": {
            "description": "Scanned barcode data",
            "maxLength": 4095,
            "type": "string"
        },
        "location": {
            "description": "Location to receive items into",
            "nullable": true,
            "type": "integer"
        },
        "purchase_order": {
            "description": "PurchaseOrder to receive items against",
            "nullable": true,
            "type": "integer"
        }
    },
    "required": [
        "barcode"
    ],
    "type": "object"
}


{
    "barcode": "string",
    "location": 0,
    "purchase_order": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
{
    "description": "Serializer for receiving items against a purchase order.\n\nThe following additional fields may be specified:\n\n- purchase_order: PurchaseOrder object to receive items against\n- location: Location to receive items into",
    "properties": {
        "barcode": {
            "description": "Scanned barcode data",
            "maxLength": 4095,
            "type": "string"
        },
        "location": {
            "description": "Location to receive items into",
            "nullable": true,
            "type": "integer"
        },
        "purchase_order": {
            "description": "PurchaseOrder to receive items against",
            "nullable": true,
            "type": "integer"
        }
    },
    "required": [
        "barcode"
    ],
    "type": "object"
}

Response 201 Created 

{
    "barcode": "string",
    "location": 0,
    "purchase_order": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "description": "Serializer for receiving items against a purchase order.\n\nThe following additional fields may be specified:\n\n- purchase_order: PurchaseOrder object to receive items against\n- location: Location to receive items into",
    "properties": {
        "barcode": {
            "description": "Scanned barcode data",
            "maxLength": 4095,
            "type": "string"
        },
        "location": {
            "description": "Location to receive items into",
            "nullable": true,
            "type": "integer"
        },
        "purchase_order": {
            "description": "PurchaseOrder to receive items against",
            "nullable": true,
            "type": "integer"
        }
    },
    "required": [
        "barcode"
    ],
    "type": "object"
}

POST /api/barcode/so-allocate/

Description

Endpoint for allocating stock to a sales order, by scanning barcode.

The scanned barcode should map to a StockItem object.

Additional fields can be passed to the endpoint:

  • SalesOrder (Required)
  • Line Item
  • Shipment
  • Quantity

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"

Request body

{
    "barcode": "string",
    "line": 0,
    "quantity": 0,
    "sales_order": 0,
    "shipment": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
{
    "description": "Serializr for allocating stock items to a sales order.\n\nThe scanned barcode must map to a StockItem object",
    "properties": {
        "barcode": {
            "description": "Scanned barcode data",
            "maxLength": 4095,
            "type": "string"
        },
        "line": {
            "description": "Sales order line item to allocate items against",
            "nullable": true,
            "type": "integer"
        },
        "quantity": {
            "description": "Quantity to allocate",
            "type": "integer"
        },
        "sales_order": {
            "description": "Sales Order to allocate items against",
            "type": "integer"
        },
        "shipment": {
            "description": "Sales order shipment to allocate items against",
            "nullable": true,
            "type": "integer"
        }
    },
    "required": [
        "barcode",
        "sales_order"
    ],
    "type": "object"
}


{
    "barcode": "string",
    "line": 0,
    "quantity": 0,
    "sales_order": 0,
    "shipment": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
{
    "description": "Serializr for allocating stock items to a sales order.\n\nThe scanned barcode must map to a StockItem object",
    "properties": {
        "barcode": {
            "description": "Scanned barcode data",
            "maxLength": 4095,
            "type": "string"
        },
        "line": {
            "description": "Sales order line item to allocate items against",
            "nullable": true,
            "type": "integer"
        },
        "quantity": {
            "description": "Quantity to allocate",
            "type": "integer"
        },
        "sales_order": {
            "description": "Sales Order to allocate items against",
            "type": "integer"
        },
        "shipment": {
            "description": "Sales order shipment to allocate items against",
            "nullable": true,
            "type": "integer"
        }
    },
    "required": [
        "barcode",
        "sales_order"
    ],
    "type": "object"
}


{
    "barcode": "string",
    "line": 0,
    "quantity": 0,
    "sales_order": 0,
    "shipment": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
{
    "description": "Serializr for allocating stock items to a sales order.\n\nThe scanned barcode must map to a StockItem object",
    "properties": {
        "barcode": {
            "description": "Scanned barcode data",
            "maxLength": 4095,
            "type": "string"
        },
        "line": {
            "description": "Sales order line item to allocate items against",
            "nullable": true,
            "type": "integer"
        },
        "quantity": {
            "description": "Quantity to allocate",
            "type": "integer"
        },
        "sales_order": {
            "description": "Sales Order to allocate items against",
            "type": "integer"
        },
        "shipment": {
            "description": "Sales order shipment to allocate items against",
            "nullable": true,
            "type": "integer"
        }
    },
    "required": [
        "barcode",
        "sales_order"
    ],
    "type": "object"
}

Response 201 Created 

{
    "barcode": "string",
    "line": 0,
    "quantity": 0,
    "sales_order": 0,
    "shipment": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "description": "Serializr for allocating stock items to a sales order.\n\nThe scanned barcode must map to a StockItem object",
    "properties": {
        "barcode": {
            "description": "Scanned barcode data",
            "maxLength": 4095,
            "type": "string"
        },
        "line": {
            "description": "Sales order line item to allocate items against",
            "nullable": true,
            "type": "integer"
        },
        "quantity": {
            "description": "Quantity to allocate",
            "type": "integer"
        },
        "sales_order": {
            "description": "Sales Order to allocate items against",
            "type": "integer"
        },
        "shipment": {
            "description": "Sales order shipment to allocate items against",
            "nullable": true,
            "type": "integer"
        }
    },
    "required": [
        "barcode",
        "sales_order"
    ],
    "type": "object"
}

POST /api/barcode/unlink/

Description

Endpoint for unlinking / unassigning a custom barcode from a database object.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"

Request body

{
    "build": 0,
    "manufacturerpart": 0,
    "part": 0,
    "purchaseorder": 0,
    "returnorder": 0,
    "salesorder": 0,
    "stockitem": 0,
    "stocklocation": 0,
    "supplierpart": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
{
    "description": "Serializer class for unlinking a barcode from an internal model.",
    "properties": {
        "build": {
            "nullable": true,
            "title": "Build Order",
            "type": "integer"
        },
        "manufacturerpart": {
            "nullable": true,
            "title": "Manufacturer Part",
            "type": "integer"
        },
        "part": {
            "nullable": true,
            "type": "integer"
        },
        "purchaseorder": {
            "nullable": true,
            "title": "Purchase Order",
            "type": "integer"
        },
        "returnorder": {
            "nullable": true,
            "title": "Return Order",
            "type": "integer"
        },
        "salesorder": {
            "nullable": true,
            "title": "Sales Order",
            "type": "integer"
        },
        "stockitem": {
            "nullable": true,
            "title": "Stock Item",
            "type": "integer"
        },
        "stocklocation": {
            "nullable": true,
            "title": "Stock Location",
            "type": "integer"
        },
        "supplierpart": {
            "nullable": true,
            "title": "Supplier Part",
            "type": "integer"
        }
    },
    "type": "object"
}


{
    "build": 0,
    "manufacturerpart": 0,
    "part": 0,
    "purchaseorder": 0,
    "returnorder": 0,
    "salesorder": 0,
    "stockitem": 0,
    "stocklocation": 0,
    "supplierpart": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
{
    "description": "Serializer class for unlinking a barcode from an internal model.",
    "properties": {
        "build": {
            "nullable": true,
            "title": "Build Order",
            "type": "integer"
        },
        "manufacturerpart": {
            "nullable": true,
            "title": "Manufacturer Part",
            "type": "integer"
        },
        "part": {
            "nullable": true,
            "type": "integer"
        },
        "purchaseorder": {
            "nullable": true,
            "title": "Purchase Order",
            "type": "integer"
        },
        "returnorder": {
            "nullable": true,
            "title": "Return Order",
            "type": "integer"
        },
        "salesorder": {
            "nullable": true,
            "title": "Sales Order",
            "type": "integer"
        },
        "stockitem": {
            "nullable": true,
            "title": "Stock Item",
            "type": "integer"
        },
        "stocklocation": {
            "nullable": true,
            "title": "Stock Location",
            "type": "integer"
        },
        "supplierpart": {
            "nullable": true,
            "title": "Supplier Part",
            "type": "integer"
        }
    },
    "type": "object"
}


{
    "build": 0,
    "manufacturerpart": 0,
    "part": 0,
    "purchaseorder": 0,
    "returnorder": 0,
    "salesorder": 0,
    "stockitem": 0,
    "stocklocation": 0,
    "supplierpart": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
{
    "description": "Serializer class for unlinking a barcode from an internal model.",
    "properties": {
        "build": {
            "nullable": true,
            "title": "Build Order",
            "type": "integer"
        },
        "manufacturerpart": {
            "nullable": true,
            "title": "Manufacturer Part",
            "type": "integer"
        },
        "part": {
            "nullable": true,
            "type": "integer"
        },
        "purchaseorder": {
            "nullable": true,
            "title": "Purchase Order",
            "type": "integer"
        },
        "returnorder": {
            "nullable": true,
            "title": "Return Order",
            "type": "integer"
        },
        "salesorder": {
            "nullable": true,
            "title": "Sales Order",
            "type": "integer"
        },
        "stockitem": {
            "nullable": true,
            "title": "Stock Item",
            "type": "integer"
        },
        "stocklocation": {
            "nullable": true,
            "title": "Stock Location",
            "type": "integer"
        },
        "supplierpart": {
            "nullable": true,
            "title": "Supplier Part",
            "type": "integer"
        }
    },
    "type": "object"
}

Response 201 Created 

{
    "build": 0,
    "manufacturerpart": 0,
    "part": 0,
    "purchaseorder": 0,
    "returnorder": 0,
    "salesorder": 0,
    "stockitem": 0,
    "stocklocation": 0,
    "supplierpart": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "description": "Serializer class for unlinking a barcode from an internal model.",
    "properties": {
        "build": {
            "nullable": true,
            "title": "Build Order",
            "type": "integer"
        },
        "manufacturerpart": {
            "nullable": true,
            "title": "Manufacturer Part",
            "type": "integer"
        },
        "part": {
            "nullable": true,
            "type": "integer"
        },
        "purchaseorder": {
            "nullable": true,
            "title": "Purchase Order",
            "type": "integer"
        },
        "returnorder": {
            "nullable": true,
            "title": "Return Order",
            "type": "integer"
        },
        "salesorder": {
            "nullable": true,
            "title": "Sales Order",
            "type": "integer"
        },
        "stockitem": {
            "nullable": true,
            "title": "Stock Item",
            "type": "integer"
        },
        "stocklocation": {
            "nullable": true,
            "title": "Stock Location",
            "type": "integer"
        },
        "supplierpart": {
            "nullable": true,
            "title": "Supplier Part",
            "type": "integer"
        }
    },
    "type": "object"
}

Schemas

Barcode

Name Type
barcode string

BarcodeAssign

Name Type
barcode string
build integer| null
manufacturerpart integer| null
part integer| null
purchaseorder integer| null
returnorder integer| null
salesorder integer| null
stockitem integer| null
stocklocation integer| null
supplierpart integer| null

BarcodeGenerate

Name Type
model string
pk integer

BarcodePOAllocate

Name Type
barcode string
purchase_order integer

BarcodePOReceive

Name Type
barcode string
location integer| null
purchase_order integer| null

BarcodeScanResult

Name Type
context
data string
endpoint string| null
pk integer
response
result boolean
timestamp string(date-time)
user integer| null
user_detail

BarcodeSOAllocate

Name Type
barcode string
line integer| null
quantity integer
sales_order integer
shipment integer| null

BarcodeUnassign

Name Type
build integer| null
manufacturerpart integer| null
part integer| null
purchaseorder integer| null
returnorder integer| null
salesorder integer| null
stockitem integer| null
stocklocation integer| null
supplierpart integer| null

PaginatedBarcodeScanResultList

Name Type
count integer
next string(uri)| null
previous string(uri)| null
results Array<BarcodeScanResult>

User

Name Type
email string()
first_name string
last_name string
pk integer
username string

Security schemes

Name Type Scheme Description
basicAuth http basic
cookieAuth apiKey
tokenAuth apiKey Token-based authentication with required prefix "Token"

More documentation

More information about InvenTree in the official docs

For more information: https://docs.inventree.org