Barcode
Barcoding
ProductBarcode
Product2DBarcode
PackListBarcode
PackList2DBarcode
ProductTracing
PackingList
Switch to Sandbox Mode
Production Mode
Download Swagger File

/ Barcoding


API Summary:

Retrieve package information from the barcode.

Resource URL: api.digikey.com/Barcoding/v3/Product2DBarcodes/{barcode}

GET
api.digikey.com/Barcoding/v3/ Barcoding/Product2DBarcode
Converts a product 2D barcode to Digi-Key and Manufacturer part number and quantity. The barcode this takes in QR Code located on the label on the anti-static bag. The QR Code contains special ASCII symbols. These MUST be encoded to be sent through the API. Please ensure the Record Separator character is encoded as \u241E and the Group Separator character is encoded as \u241D

Parameters

NameDescription
barcode *
string
(path)

QR Code from a Digi-Key product label. The QR Code contains special ASCII symbols. These MUST be
encoded to be sent through the API. Please ensure the Record Separator character is encoded as \u241E and the Group
Separator character is encoded as \u241D

includes
string
(query)

Comma separated list of fields to return. Used to customize response to reduce bandwidth by
selecting fields that you wish to receive. For example: "DigiKeyPartNumber,Quantity"

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

CodeDescription
200
Success
{
  "DigiKeyPartNumber": "P189-ND",
  "ManufacturerPartNumber": "CR2032",
  "ManufacturerName": "Panasonic - BSG",
  "ProductDescription": "BATTERY LITHIUM 3V COIN 20MM",
  "Quantity": 5,
  "SalesorderId": 12345,
  "InvoiceId": 12345,
  "PurchaseOrder": "April batch 1",
  "CountryOfOrigin": "China",
  "LotCode": "string",
  "DateCode": "string"
}
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