Supply Chain v1
View bonded inventory quantities across warehouse locations for your account. Requires a bonded inventory agreement with DigiKey.
https://api.digikey.com/SupplyChain/v1
OpenAPI spec →
What is bonded inventory?
DigiKey's bonded inventory service allows customers to hold reserved stock at DigiKey warehouses. This API provides visibility into that reserved stock by location and by part number. It does not reflect general DigiKey catalog inventory.
Endpoints
| Method | Path | Description |
|---|---|---|
| GET | /BondedQuantity/Locations |
List all bonded inventory locations |
| GET | /BondedQuantity/Locations/{accountId} |
Bonded inventory for a specific account |
| GET | /BondedQuantity/Locations/{accountId}/Products |
All products in bonded inventory for an account |
| GET | /BondedQuantity/Locations/{accountId}/Products/{partNumber} |
Bonded inventory for a specific part |
| GET | /BondedQuantity/Products |
Summary of all bonded products across all locations |
GET /BondedQuantity/Locations
Returns all warehouse locations that hold bonded inventory for the authenticated account.
GET /BondedQuantity/Locations/{accountId}
Returns bonded inventory totals grouped by location for the specified account.
Path parameter: accountId — DigiKey account ID.
GET /BondedQuantity/Locations/{accountId}/Products
Returns the full list of parts in bonded inventory for an account, with quantity per location.
GET /BondedQuantity/Locations/{accountId}/Products/{partNumber}
Returns bonded inventory details for a specific part number within an account.
Path parameters:
accountId— DigiKey account IDpartNumber— DigiKey part number
GET /BondedQuantity/Products
Returns a summary of all bonded products across all locations.
Notes
This API requires a bonded inventory agreement with DigiKey. If your account does not have a bonded inventory arrangement, these endpoints will return empty results or 403.
3-legged authentication is required.
Models
Request and response object schemas for this API. Error models (ApiErrorResponse, DKProblemDetails) are documented on the Authentication & Concepts page.
BondedInventoryProductResponse
Bonded Inventory response model
| Field | Type | Required | Description |
|---|---|---|---|
DigiKeyPartNumber | string | The Digi-Key part number. | |
ManufacturerPartNumber | string | The Manufacturer Part Number. | |
CustomerPartNumber | string | The Customer Part Number. | |
ProductDescription | string | Catalog description of the product. | |
Manufacturer | string | The Manufacturer of the product. | |
UnitPrice | number (double) | The price for a single unit of this product. | |
PackType | string | The Package Type of the product | |
CountryOfOrigin | string | The Country Of Origin of the product | |
ReserveQuantity | integer (int32) | The quantity reserved on backorder on the master/program. | |
BackOrderReserveQuantity | integer (int32) | The Reserve Quantity on backorder | |
VendorLeadWeeks | string | The number of weeks lead time | |
CustomerId | integer (int32) | The unique Id assigned to your Account’s location. This CustomerID is not the same value as the user’s individual CustomerID. | |
NcnrQuantity | integer (int32) | Date NCNR was signed. Note: If there is no NCNR applicable, the date will default to 1858-11-17. | |
NcnrDateSigned | string (date-time) | NCNR Date Signed | |
MinimumReleaseQuantityOverride | boolean | Override for MFG Sales Pack. If value is TRUE, MOQ = 1 pc unless there is a quantity greater than “0” in the Minimum Quantity Threshold field. If value is FALSE, MOQ = MFG Sales Pack. | |
MinimumQuantityThreshold | integer (int32) | *Only applicable if previous field “MinimumReleaseQuantityOverride” value = TRUE*. The adjusted minimum order quantity. If the value = “0” (the default) then the MOQ = 1 pc. If the value is greater than “0”, that is the new MOQ. | |
NonCancelable | boolean | Supply Chain Non-Cancelable, Non-Returnable Agreement. If value is TRUE, part is considered NCNR. | |
StandardPackage | integer (int32) | The number of products in the manufacturer's standard package. |
CustomerLocationResponse
| Field | Type | Required | Description |
|---|---|---|---|
CustomerId | integer (int32) | The unique Id assigned to your Account’s location. This CustomerID is not the same value as the user’s individual CustomerID. | |
BondedInventory | boolean | Does the location have bonded Inventory | |
Currency | string | ISO code for currency used in the order. | |
ShippingAddress | Address |