Digi-Key

Digi-Key Barcoding API

The Barcoding API from Digi-Key — 4 operation(s) for barcoding.

Documentation GitHub OpenAPI

Operations 4

GET /ProductBarcodes/{barcode} Converts a legacy product barcode to Digi-Key and Manufacturer part number and… #

GET /Product2DBarcodes/{barcode} Converts a product 2D barcode to Digi-Key and Manufacturer part number and… #

GET /PackListBarcodes/{barcode} Converts a pack list barcode to information about the order. #

GET /PackList2DBarcodes/{barcode} Converts a pack list 2D barcode to information about the order. #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/digi-key:digi-key-barcoding-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Digi Key Barcoding API
  version: v3
  contact:
    name: API Support
    url: https://developer.digikey.com/support
  description: 'Operations tagged Barcoding across 2 of this provider''s published API definitions: digi-key-barcoding-barcoding-v3.json, digi-key-barcoding-barcoding-v3-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.digikey.com/Barcoding/v3
security:
- apiKeySecurity: []
  oauth2AccessCodeSecurity: []
tags:
- name: Barcoding
paths:
  /ProductBarcodes/{barcode}:
    get:
      tags:
      - Barcoding
      summary: Converts a legacy product barcode to Digi-Key and Manufacturer part number and…
      operationId: ProductBarcode
      parameters:
      - in: path
        name: barcode
        description: Product barcode located on the product's anti-static bag.
        required: true
        schema:
          type: string
      - in: query
        name: includes
        description: '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".'
        schema:
          type: string
      - in: header
        name: Authorization
        description: OAuth Bearer Token. Please see<a href= "https://developer.digikey.com/documentation/oauth" target= "_blank" > OAuth 2.0 Documentation </a > page for more info.
        required: true
        schema:
          type: string
      - in: header
        name: X-DIGIKEY-Client-Id
        description: The Client Id for your App.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductBarcodeResponse'
        '400':
          description: Bad Request - The input model is invalid or malformed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '401':
          description: Unauthorized - Token is expired or Client Id or subscription are invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '429':
          description: Too Many Requests - Your rate limit has been exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '503':
          description: Service Unavailable - The service is temporarily unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
    servers:
    - url: https://api.digikey.com/Barcoding/v3
  /Product2DBarcodes/{barcode}:
    get:
      tags:
      - Barcoding
      summary: Converts a product 2D barcode to Digi-Key and Manufacturer part number and…
      operationId: Product2DBarcode
      parameters:
      - in: path
        name: barcode
        description: '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'
        required: true
        schema:
          type: string
      - in: query
        name: includes
        description: '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"'
        schema:
          type: string
      - in: header
        name: Authorization
        description: OAuth Bearer Token. Please see<a href= "https://developer.digikey.com/documentation/oauth" target= "_blank" > OAuth 2.0 Documentation </a > page for more info.
        required: true
        schema:
          type: string
      - in: header
        name: X-DIGIKEY-Client-Id
        description: The Client Id for your App.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Product2DBarcodeResponse'
        '400':
          description: Bad Request - The input model is invalid or malformed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '401':
          description: Unauthorized - Token is expired or Client Id or subscription are invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '429':
          description: Too Many Requests - Your rate limit has been exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '503':
          description: Service Unavailable - The service is temporarily unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
    servers:
    - url: https://api.digikey.com/Barcoding/v3
  /PackListBarcodes/{barcode}:
    get:
      tags:
      - Barcoding
      summary: Converts a pack list barcode to information about the order.
      operationId: PackListBarcode
      parameters:
      - in: path
        name: barcode
        description: Pack list barcode located on the pack list in the lower left corner.
        required: true
        schema:
          type: string
      - in: query
        name: includes
        description: '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"'
        schema:
          type: string
      - in: header
        name: Authorization
        description: OAuth Bearer Token. Please see<a href= "https://developer.digikey.com/documentation/oauth" target= "_blank" > OAuth 2.0 Documentation </a > page for more info.
        required: true
        schema:
          type: string
      - in: header
        name: X-DIGIKEY-Client-Id
        description: The Client Id for your App.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackListBarcodeResponse'
        '400':
          description: Bad Request - The input model is invalid or malformed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '401':
          description: Unauthorized - Token is expired or Client Id or subscription are invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '429':
          description: Too Many Requests - Your rate limit has been exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '503':
          description: Service Unavailable - The service is temporarily unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
    servers:
    - url: https://api.digikey.com/Barcoding/v3
  /PackList2DBarcodes/{barcode}:
    get:
      tags:
      - Barcoding
      summary: Converts a pack list 2D barcode to information about the order.
      operationId: PackList2DBarcode
      parameters:
      - in: path
        name: barcode
        description: Pack list barcode located on the pack list in the upper right corner.
        required: true
        schema:
          type: string
      - in: query
        name: includes
        description: '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"'
        schema:
          type: string
      - in: header
        name: Authorization
        description: OAuth Bearer Token. Please see<a href= "https://developer.digikey.com/documentation/oauth" target= "_blank" > OAuth 2.0 Documentation </a > page for more info.
        required: true
        schema:
          type: string
      - in: header
        name: X-DIGIKEY-Client-Id
        description: The Client Id for your App.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackListBarcodeResponse'
        '400':
          description: Bad Request - The input model is invalid or malformed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '401':
          description: Unauthorized - Token is expired or Client Id or subscription are invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '429':
          description: Too Many Requests - Your rate limit has been exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '503':
          description: Service Unavailable - The service is temporarily unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
    servers:
    - url: https://api.digikey.com/Barcoding/v3
components:
  schemas:
    Product2DBarcodeResponse:
      description: Data retrieved from a 2D barcode on a product.
      type: object
      properties:
        DigiKeyPartNumber:
          description: The Digi-Key part number.
          type: string
          example: P189-ND
        ManufacturerPartNumber:
          description: The manufacturer part number.
          type: string
          example: CR2032
        ManufacturerName:
          description: Manufacturer of the product.
          type: string
          example: Panasonic - BSG
        ProductDescription:
          description: Catalog description of the product.
          type: string
          example: BATTERY LITHIUM 3V COIN 20MM
        Quantity:
          format: int32
          description: Quantity of the product.
          type: integer
          example: 5
        SalesorderId:
          format: int32
          description: The Id for the Salesorder. Note that if the barcode was from a "Prepack" label, this will not be populated.
          type: integer
          example: 12345
        InvoiceId:
          format: int32
          description: The Id for the invoice. Note that if the barcode was from a "Prepack" label, this will not be populated.
          type: integer
          example: 12345
        PurchaseOrder:
          description: Customer PurchaseOrder (custom notes or identifier) on the order. Note that if the barcode was from a "Prepack" label, this will not be populated.
          type: string
          example: April batch 1
        CountryOfOrigin:
          description: The country that the product orginates from.
          type: string
          example: China
        LotCode:
          description: The Lot Code
          type: string
        DateCode:
          description: The date code
          type: string
    PackListBarcodeResponse:
      description: Data retrieved from a Packlist.
      type: object
      properties:
        SalesorderId:
          format: int32
          description: The Id for the Salesorder.
          type: integer
          example: 12345
        InvoiceId:
          format: int32
          description: The Id for the invoice.
          type: integer
          example: 12345
        PackListNumber:
          format: int32
          description: PackList number.
          type: integer
          example: 1
        PackListDetails:
          description: List of PackList Details.
          type: array
          items:
            $ref: '#/components/schemas/PackListDetail'
    ApiErrorResponse:
      type: object
      properties:
        ErrorResponseVersion:
          type: string
          readOnly: true
        StatusCode:
          format: int32
          type: integer
        ErrorMessage:
          type: string
        ErrorDetails:
          type: string
        RequestId:
          type: string
        ValidationErrors:
          type: array
          items:
            $ref: '#/components/schemas/ApiValidationError'
    ProductBarcodeResponse:
      description: Barcode Response model containing a basic product information and the quantity.
      type: object
      properties:
        DigiKeyPartNumber:
          description: The Digi-Key part number.
          type: string
          example: P189-ND
        ManufacturerPartNumber:
          description: The manufacturer part number.
          type: string
          example: CR2032
        ManufacturerName:
          description: Manufacturer of the product.
          type: string
          example: Panasonic - BSG
        ProductDescription:
          description: Catalog description of the product.
          type: string
          example: BATTERY LITHIUM 3V COIN 20MM
        Quantity:
          format: int32
          description: Quantity of the product.
          type: integer
          example: 5
    PackListDetail:
      description: A detail from a Packlist containing the DigiKeyPartNumber and Quantity.
      type: object
      properties:
        DigiKeyPartNumber:
          description: The Digi-Key part number.
          type: string
          example: P189-ND
        Quantity:
          format: int32
          description: Quantity of the product.
          type: integer
          example: 5
    ApiValidationError:
      type: object
      properties:
        Field:
          type: string
        Message:
          type: string
  securitySchemes:
    apiKeySecurity:
      type: apiKey
      name: X-DIGIKEY-Client-Id
      in: header
    oauth2AccessCodeSecurity:
      type: oauth2
      flows:
        authorizationCode:
          scopes: {}
          authorizationUrl: https://api.digikey.com/v1/oauth2/authorize
          tokenUrl: https://api.digikey.com/v1/oauth2/token
x-refined-from:
- digi-key-barcoding-barcoding-v3.json
- digi-key-barcoding-barcoding-v3-openapi.yml
x-host-sandbox: sandbox-api.digikey.com
x-host-production: api.digikey.com
x-source-pages:
- https://developer.digikey.com/products/ordering/ordermanagement/salesorderbyid
- https://developer.digikey.com/products/ordering/ordermanagement/salesordersbyponumber
- https://developer.digikey.com/products/ordering/ordermanagement/changeeligibility
- https://developer.digikey.com/products/ordering/ordermanagement/nextavailabledeliverydate
- https://developer.digikey.com/products/ordering/ordermanagement/salesorderdetails
- https://developer.digikey.com/products/ordering/ordermanagement/salesorderdetailbyid
- https://developer.digikey.com/products/ordering/ordermanagement/salesorderschedules
- https://developer.digikey.com/products/ordering/ordermanagement/replaceschedule
- https://developer.digikey.com/products/ordering/ordermanagement/salesorderschedulebyid
- https://developer.digikey.com/products/ordering/ordermanagement/partialscheduleupdate

Digi-Key Barcoding API

Operations 4

Documentation

Specifications

Schemas & Data

Other Resources