Barcode v3
Decode DigiKey 1D and 2D barcodes to retrieve product information or packing list data. Used for receiving workflows and shipment verification.
https://api.digikey.com/Barcoding/v3
OpenAPI spec →
Endpoints
| Method | Path | Description |
|---|---|---|
| GET | /ProductBarcodes/{barcode} |
Product lookup from a 1D barcode |
| GET | /Product2DBarcodes/{barcode} |
Product lookup from a 2D (QR/DataMatrix) barcode |
| GET | /PackListBarcodes/{barcode} |
Packing list lookup from a 1D barcode |
| GET | /PackList2DBarcodes/{barcode} |
Packing list lookup from a 2D barcode |
Packing list retrieval by sales order ID, PO number, or invoice is handled by the Packing List v1 API.
GET /ProductBarcodes/{barcode}
Decodes a 1D barcode from a DigiKey product label (on the anti-static bag or reel).
Path parameter: barcode — the barcode string as scanned.
Query parameter: includes (optional) — comma-separated list of additional fields to include.
Response
{
"DigiKeyPartNumber": "311-10.0KHRCT-ND",
"ManufacturerPartNumber": "RC0603FR-0710KL",
"Manufacturer": { "Id": 13, "Name": "YAGEO" },
"Description": "RES 10K OHM 1% 1/10W 0603",
"Quantity": 100
}
GET /Product2DBarcodes/{barcode}
Decodes a 2D (QR code or Data Matrix) barcode from a DigiKey anti-static bag or spool label. Returns the same product fields as the 1D endpoint.
GET /PackListBarcodes/{barcode}
Decodes a 1D barcode from a DigiKey packing slip to retrieve order reference data.
Response
{
"SalesorderId": 88152456,
"InvoiceId": 106467538,
"PackListNumber": 1,
"PackListDetails": [
{
"DigiKeyPartNumber": "F5146-ND",
"Quantity": 1
}
]
}
GET /PackList2DBarcodes/{barcode}
Decodes a 2D barcode from a DigiKey packing slip. Returns the same packing list fields as the 1D endpoint.
Common workflow: receiving
- Scan the packing slip barcode with
GET /PackListBarcodes/{barcode}— get the sales order and invoice IDs. - For each item, scan the product barcode with
GET /ProductBarcodes/{barcode}— get the part number and quantity. - Use the Packing List v1 API to retrieve the full packing list for receiving verification.
Notes
- Requires 3-legged authentication.
- Pass the raw barcode string in the URL path. URL-encode special characters.
- For packing list retrieval without a physical barcode scan, use Packing List v1 directly.
Models
Request and response object schemas for this API. Error models (ApiErrorResponse, DKProblemDetails) are documented on the Authentication & Concepts page.
PackListBarcodeResponse
Data retrieved from a Packlist.
| Field | Type | Required | Description |
|---|---|---|---|
SalesorderId | integer (int32) | The Id for the Salesorder. | |
InvoiceId | integer (int32) | The Id for the invoice. | |
PackListNumber | integer (int32) | PackList number. | |
PackListDetails | array of PackListDetail | List of PackList Details. |
Product2DBarcodeResponse
Data retrieved from a 2D barcode on a product.
| Field | Type | Required | Description |
|---|---|---|---|
DigiKeyPartNumber | string | The Digi-Key part number. | |
ManufacturerPartNumber | string | The manufacturer part number. | |
ManufacturerName | string | Manufacturer of the product. | |
ProductDescription | string | Catalog description of the product. | |
Quantity | integer (int32) | Quantity of the product. | |
SalesorderId | integer (int32) | The Id for the Salesorder. Note that if the barcode was from a "Prepack" label, this will not be populated. | |
InvoiceId | integer (int32) | The Id for the invoice. Note that if the barcode was from a "Prepack" label, this will not be populated. | |
PurchaseOrder | string | Customer PurchaseOrder (custom notes or identifier) on the order. Note that if the barcode was from a "Prepack" label, this will not be populated. | |
CountryOfOrigin | string | The country that the product orginates from. | |
LotCode | string | The Lot Code | |
DateCode | string | The date code |
ProductBarcodeResponse
Barcode Response model containing a basic product information and the quantity.
| Field | Type | Required | Description |
|---|---|---|---|
DigiKeyPartNumber | string | The Digi-Key part number. | |
ManufacturerPartNumber | string | The manufacturer part number. | |
ManufacturerName | string | Manufacturer of the product. | |
ProductDescription | string | Catalog description of the product. | |
Quantity | integer (int32) | Quantity of the product. |