Packing List v1

Endpoints

GET /v1/salesorderid/{salesOrderId}

Returns all packing lists created for a sales order.

Path parameter: salesOrderId — DigiKey sales order ID (e.g. 88152456).

Query parameter: includePdf (boolean, optional) — when true, a PDF version of the packing list is included in the response.

Response

{
  "PackingListInvoice": [
    {
      "InvoiceId": 106467538,
      "SalesOrderId": 88152456,
      "PackingListItem": [
        {
          "SalesOrderId": 88152456,
          "DigiKeyProductNumber": "F5146-ND",
          "ManufacturerProductNumber": "157.5701.6421",
          "Description": "FUSE STRIP 425A 48VDC BOLT MOUNT",
          "QuantityShipped": 1,
          "UnitPrice": 6.92
        }
      ]
    }
  ]
}

GET /v1/purchaseordernumber/{purchaseOrderNumber}

Returns packing lists associated with your purchase order number. Useful when you track orders by your own PO reference.

Path parameter: purchaseOrderNumber — your PO number as submitted on the original order.

GET /v1/invoice/{invoiceId}

Returns a single packing list for a specific invoice.

Path parameter: invoiceId — DigiKey invoice ID (e.g. 106467538). The invoiceId is available in responses from Order Status v4.

Receiving workflow

1. Retrieve the packing list from GET /v1/salesorderid/{salesOrderId} when an order arrives.
2. Match each DigiKeyProductNumber against your expected BOM line items.
3. Verify QuantityShipped against your order quantities.
4. For physical scan-based receiving, use Barcode v3 to look up items as you scan them.

Notes

Requires 3-legged authentication.