Barcode
Barcoding
ProductTracing
PackingList
GetPackingList
GetPackingListBySalesOrderId
GetPackingListByPoNumber
Switch to Sandbox Mode
Production Mode
Download Swagger File

/ PackList


API Summary:

Send an Invoice Number or Sales Order Number and retrieve information included on the packing list supplied in the shipment’s package. You can also request that we return a pdf version of the packing list that was included in the package. Every order placed with DigiKey is linked to a single Sales Order Number. If the order results in multiple shipments, each shipment will have one Order Number. We generate one packing list for each Invoice Number. Note: A packing list is also known as a pack list, packing slip, or manifest.

Resource URL: api.digikey.com/packinglist/v1/invoice/{invoiceId}

GET
api.digikey.com/packinglist/ PackList/GetPackingList
Enter an Invoice Number and receive a single packing list.

Parameters

NameDescription
invoiceId *
integer($int32)
(path)
Enter the Invoice ID that is to be returned.
includePdf
boolean
(query)

If you would like to have a pdf for this packing list returned, set the value to “True”.

X-DIGIKEY-Client-Id *
string
(header)
The Client Id for your app.

Responses

CodeDescription
200
Success
{
  "PackingListItem": [
    {
      "InvoiceId": 0,
      "SalesOrderId": 0,
      "PurchaseOrderNumber": "string",
      "OrderedQuantity": 0,
      "QuantityShipped": 0,
      "QuantityBackOrder": 0,
      "CustomerLineItemId": "string",
      "LineItem": "string",
      "ProductNumber": "string",
      "Description": "string",
      "ECCN": "string",
      "CustomerPartNumber": "string",
      "HTSUS": "string",
      "ManufacturerProductNumber": "string",
      "Manufacturer": "string",
      "CountryOfOrigin": "string",
      "LotQuantity": 0,
      "DateCode": "string",
      "LotCode": "string"
    }
  ],
  "InvoiceIdEntered": 0,
  "IncludePdfEntered": true,
  "PdfFound": true,
  "EncodedString": "string"
}
400

Bad Request - The input model is invalid or malformed.

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "correlationId": "string",
  "errors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}
401

Unauthorized - Token is expired or Client Id or subscription are invalid.

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "correlationId": "string",
  "errors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}
403
The target resource is forbidden.
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "correlationId": "string",
  "errors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}
404

Not Found - The requested resource could not be found

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "correlationId": "string",
  "errors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}
429

Too Many Requests - Your rate limit has been exceeded

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "correlationId": "string",
  "errors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}
500
An unhandled error occurred.
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "correlationId": "string",
  "errors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}
503

Service Unavailable - The service is temporarily unavailable

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "correlationId": "string",
  "errors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}

Models

DKProblemDetails
InvoicePackingList
PackingListItem
PoNumberPackList
SalesOrderPackList