Digi-Key

Digi-Key Pack List API

The PackList API from Digi-Key — 3 operation(s) for packlist.

GitHub OpenAPI

Operations 3

GET /v1/invoice/{invoiceId} Enter an Invoice Number and receive a single packing list #
GET /v1/salesorderid/{salesOrderId} Enter a Sales Order Number and receive all packing lists created for that order #
GET /v1/purchaseordernumber/{purchaseOrderNumber} Enter a valid Purchase Order Number and receive assciated packing lists created… #

Documentation

📖
Documentation
https://developer.digikey.com/products/ordering/ordermanagement
📖
Documentation
https://developer.digikey.com/products/barcode/barcoding
📖
Documentation
https://developer.digikey.com/products/reference-apis/customerresource
📖
Documentation
https://developer.digikey.com/products/mylists/mylists
📖
Documentation
https://developer.digikey.com/products/ordering/ordering
📖
Documentation
https://developer.digikey.com/products/order-status/orderstatus
📖
Documentation
https://developer.digikey.com/products/barcode/packinglist
📖
Documentation
https://developer.digikey.com/products/product-information-v4/productchangenotifications
📖
Documentation
https://developer.digikey.com/products/product-information-v4/productsearch
📖
Documentation
https://developer.digikey.com/products/quote/quote-v4
📖
Documentation
https://developer.digikey.com/products/supplychain/supplychain

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/digi-key/refs/heads/main/openapi/digi-key-packlist-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/digi-key/refs/heads/main/json-schema/digi-key-invoice-packing-list-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/digi-key/refs/heads/main/json-schema/digi-key-sales-order-pack-list-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/digi-key/refs/heads/main/json-schema/digi-key-po-number-pack-list-schema.json

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-packlist-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

digi-key-packlist-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Digi Key Pack List API
  version: v1
  contact:
    name: B2BApi Team
    url: https://developer.digikey.com/support
    email: dl_Agile_Team_B2B_API@digikey.com
  termsOfService: https://www.digikey.com/en/terms-and-conditions
  x-technical-domain: Sales
  description: 'Operations tagged PackList across 2 of this provider''s published API definitions: digi-key-packinglist-api-packinglist.json, digi-key-packinglist-api-packinglist-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.digikey.com/packinglist
security:
- apiKeySecurity: []
  oauth2AccessCodeSecurity: []
tags:
- name: PackList
paths:
  /v1/invoice/{invoiceId}:
    get:
      tags:
      - PackList
      summary: Enter an Invoice Number and receive a single packing list
      operationId: GetPackingList
      parameters:
      - in: path
        name: invoiceId
        description: Enter the Invoice ID that is to be returned.
        required: true
        schema:
          type: integer
          format: int32
      - in: query
        name: includePdf
        description: If you would like to have a pdf for this packing list returned, set the value to “True”.
        schema:
          type: boolean
      - in: header
        name: X-DIGIKEY-Client-Id
        description: The Client Id for your app.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/InvoicePackingList'
            application/json:
              schema:
                $ref: '#/components/schemas/InvoicePackingList'
            text/json:
              schema:
                $ref: '#/components/schemas/InvoicePackingList'
        '400':
          description: Bad Request - The input model is invalid or malformed.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
        '401':
          description: Unauthorized - Token is expired or Client Id or subscription are invalid.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
        '403':
          description: The target resource is forbidden.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
        '404':
          description: Not Found - The requested resource could not be found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
        '429':
          description: Too Many Requests - Your rate limit has been exceeded
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
        '500':
          description: An unhandled error occurred.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
        '503':
          description: Service Unavailable - The service is temporarily unavailable
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
    servers:
    - url: https://api.digikey.com/packinglist
  /v1/salesorderid/{salesOrderId}:
    get:
      tags:
      - PackList
      summary: Enter a Sales Order Number and receive all packing lists created for that order
      operationId: GetPackingListBySalesOrderId
      parameters:
      - in: path
        name: salesOrderId
        description: Enter the Sales Order Number ID that you want packing lists returned.
        required: true
        schema:
          type: integer
          format: int32
      - in: query
        name: includePdf
        description: If you would like to have a pdf of each packing list returned, set the value to “True”
        schema:
          type: boolean
      - in: header
        name: X-DIGIKEY-Client-Id
        description: The Client Id for your app.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SalesOrderPackList'
            application/json:
              schema:
                $ref: '#/components/schemas/SalesOrderPackList'
            text/json:
              schema:
                $ref: '#/components/schemas/SalesOrderPackList'
        '400':
          description: Bad Request - The input model is invalid or malformed.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
        '401':
          description: Unauthorized - Token is expired or Client Id or subscription are invalid.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
        '403':
          description: The target resource is forbidden.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
        '404':
          description: Not Found - The requested resource could not be found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
        '429':
          description: Too Many Requests - Your rate limit has been exceeded
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
        '500':
          description: An unhandled error occurred.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
        '503':
          description: Service Unavailable - The service is temporarily unavailable
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
    servers:
    - url: https://api.digikey.com/packinglist
  /v1/purchaseordernumber/{purchaseOrderNumber}:
    get:
      tags:
      - PackList
      summary: Enter a valid Purchase Order Number and receive assciated packing lists created…
      operationId: GetPackingListByPoNumber
      parameters:
      - in: path
        name: purchaseOrderNumber
        description: Enter your purchase order number and the corresponding SalesOrderId will be found
        required: true
        schema:
          type: string
      - in: query
        name: includePdf
        description: If you would like to have a pdf of each packing list returned, set the value to “True
        schema:
          type: boolean
      - in: header
        name: X-DIGIKEY-Client-Id
        description: The Client Id for your app.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/PoNumberPackList'
            application/json:
              schema:
                $ref: '#/components/schemas/PoNumberPackList'
            text/json:
              schema:
                $ref: '#/components/schemas/PoNumberPackList'
        '400':
          description: Bad Request - The input model is invalid or malformed.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
        '401':
          description: Unauthorized - Token is expired or Client Id or subscription are invalid.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
        '403':
          description: The target resource is forbidden.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
        '404':
          description: Not Found - The requested resource could not be found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
        '429':
          description: Too Many Requests - Your rate limit has been exceeded
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
        '500':
          description: An unhandled error occurred.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
        '503':
          description: Service Unavailable - The service is temporarily unavailable
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
    servers:
    - url: https://api.digikey.com/packinglist
components:
  schemas:
    SalesOrderPackList:
      description: PackList from provided Sales Order Id
      type: object
      properties:
        PackingListInvoice:
          description: Invoices from the sales order id provided
          type: array
          items:
            $ref: '#/components/schemas/InvoicePackingList'
        SalesOrderIdEntered:
          format: int32
          description: The SalesOrderID that you entered in the reques
          type: integer
      additionalProperties: false
    PoNumberPackList:
      type: object
      properties:
        SalesOrderPackLists:
          description: List of sales orders associated with given Purchase Order Number.
          type: array
          items:
            $ref: '#/components/schemas/SalesOrderPackList'
        PoNumber:
          description: Customers provided Purchase Order Number.
          type: string
      additionalProperties: false
    DKProblemDetails:
      type: object
      properties:
        type:
          type: string
        title:
          type: string
        status:
          format: int32
          type: integer
        detail:
          type: string
        instance:
          type: string
        correlationId:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          readOnly: true
      additionalProperties: false
    PackingListItem:
      type: object
      properties:
        InvoiceId:
          format: int32
          description: Invoice ID of order. There is one per shipment.
          type: integer
        SalesOrderId:
          format: int32
          description: Sales order ID. There is one per order.
          type: integer
        PurchaseOrderNumber:
          description: Purchase Order Number supplied by the customer when the order was placed.
          type: string
        OrderedQuantity:
          format: int32
          description: Number of items ordered of products included in the packing list for given line item
          type: integer
        QuantityShipped:
          format: int32
          description: The quantity of items in the shipment
          type: integer
        QuantityBackOrder:
          format: int32
          description: The quantity of items on backorder
          type: integer
        CustomerLineItemId:
          description: Customer Line item id
          type: string
        LineItem:
          description: DigiKey’s Line Item number for that Sales Order
          type: string
        ProductNumber:
          description: DigiKey product number for given line item
          type: string
        Description:
          description: Product Description for given line item
          type: string
        ECCN:
          description: Export control class number for given line item. See documentation from the U.S. Department of Commerce.
          type: string
        CustomerPartNumber:
          description: Customer Part Number for given line item
          type: string
        HTSUS:
          description: Harmonized Tariff Schedule of the United States for given line item. See documentation from the U.S. International Trade Commission.
          type: string
        ManufacturerProductNumber:
          description: Manufacturer part number for given line item
          type: string
        Manufacturer:
          description: Manufacturer Name for given line item
          type: string
        CountryOfOrigin:
          description: Country of origin for given line item
          type: string
        LotQuantity:
          format: int32
          description: Quantity of products in the lot for given line item
          type: integer
        DateCode:
          description: Date Code for given line item. Format is MMM-YYYY
          type: string
        LotCode:
          description: Lot Code for given line item
          type: string
      additionalProperties: false
    InvoicePackingList:
      description: ''
      type: object
      properties:
        PackingListItem:
          description: Item found from Invoice
          type: array
          items:
            $ref: '#/components/schemas/PackingListItem'
        InvoiceIdEntered:
          format: int32
          description: The InvoiceID that you entered in the request
          type: integer
        IncludePdfEntered:
          description: The value that you entered in the request. "True" is to return the encoded pdf string. "False" is to not.
          type: boolean
        PdfFound:
          description: Pdf for this invoice has been found
          type: boolean
        EncodedString:
          description: Enter this string in a string decoder to generate a pdf.
          type: string
      additionalProperties: false
  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-packinglist-api-packinglist.json
- digi-key-packinglist-api-packinglist-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