/ Barcoding


API Summary:

Retrieve package information from the barcode.

Resource URL: sandbox-api.digikey.com/Barcoding/v3/PackListBarcodes/{barcode}

GET
sandbox-api.digikey.com/Barcoding/v3/ Barcoding/PackListBarcode
Converts a pack list barcode to information about the order. The barcode this takes in is a one-dimensional barcode located in the lower left corner of the pack list.

Parameters

NameDescription
barcode *
string
(path)
Pack list barcode located on the pack list in the lower left corner.
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: "Salesorder"

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
{
  "SalesorderId": 12345,
  "InvoiceId": 12345,
  "PackListNumber": 1,
  "PackListDetails": [
    {
      "DigiKeyPartNumber": "P189-ND",
      "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