/ Barcoding
API Summary:
Retrieve package information from the barcode.
Resource URL: api.digikey.com/Barcoding/v3/ProductBarcodes/{barcode}
GET
api.digikey.com/Barcoding/v3/ Barcoding/ProductBarcode
Converts a legacy product barcode to Digi-Key and Manufacturer part number and quantity. The barcode this takes in
is a one-dimensional barcode that was previously located on the label on the anti-static bag. This barcode can
still be found on older products.
Parameters
| Name | Description | |
|---|---|---|
barcode * string (path) | Product barcode located on the product's anti-static bag. | |
includes string (query) | Comma separated list of fields to return. Used to customize response to reduce bandwidth by | |
Authorization * string (header) | OAuth Bearer Token. Please see OAuth 2.0 Documentation page for more info. | |
X-DIGIKEY-Client-Id * string (header) | The Client Id for your App. |
Responses
| Code | Description |
| 200 | Success {
"DigiKeyPartNumber": "P189-ND",
"ManufacturerPartNumber": "CR2032",
"ManufacturerName": "Panasonic - BSG",
"ProductDescription": "BATTERY LITHIUM 3V COIN 20MM",
"Quantity": 5
} |
| 400 | Bad Request - The input model is invalid or malformed {
"ErrorResponseVersion": "string",
"StatusCode": 0,
"ErrorMessage": "string",
"ErrorDetails": "string",
"RequestId": "string",
"ValidationErrors": [
{
"Field": "string",
"Message": "string"
}
]
} |
| 401 | Unauthorized - Token is expired or Client Id or subscription are invalid {
"ErrorResponseVersion": "string",
"StatusCode": 0,
"ErrorMessage": "string",
"ErrorDetails": "string",
"RequestId": "string",
"ValidationErrors": [
{
"Field": "string",
"Message": "string"
}
]
} |
| 429 | Too Many Requests - Your rate limit has been exceeded {
"ErrorResponseVersion": "string",
"StatusCode": 0,
"ErrorMessage": "string",
"ErrorDetails": "string",
"RequestId": "string",
"ValidationErrors": [
{
"Field": "string",
"Message": "string"
}
]
} |
| 503 | Service Unavailable - The service is temporarily unavailable {
"ErrorResponseVersion": "string",
"StatusCode": 0,
"ErrorMessage": "string",
"ErrorDetails": "string",
"RequestId": "string",
"ValidationErrors": [
{
"Field": "string",
"Message": "string"
}
]
} |
Models
ProductBarcodeResponse
ApiValidationError
ApiErrorResponse
Product2DBarcodeResponse
PackListDetail
PackListBarcodeResponse