DigiKey API Portal

Supply Chain v1

Active 3-legged

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 ID
  • partNumber — 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

FieldTypeRequiredDescription
DigiKeyPartNumberstringThe Digi-Key part number.
ManufacturerPartNumberstringThe Manufacturer Part Number.
CustomerPartNumberstringThe Customer Part Number.
ProductDescriptionstringCatalog description of the product.
ManufacturerstringThe Manufacturer of the product.
UnitPricenumber (double)The price for a single unit of this product.
PackTypestringThe Package Type of the product
CountryOfOriginstringThe Country Of Origin of the product
ReserveQuantityinteger (int32)The quantity reserved on backorder on the master/program.
BackOrderReserveQuantityinteger (int32)The Reserve Quantity on backorder
VendorLeadWeeksstringThe number of weeks lead time
CustomerIdinteger (int32)The unique Id assigned to your Account’s location. This CustomerID is not the same value as the user’s individual CustomerID.
NcnrQuantityinteger (int32)Date NCNR was signed. Note: If there is no NCNR applicable, the date will default to 1858-11-17.
NcnrDateSignedstring (date-time)NCNR Date Signed
MinimumReleaseQuantityOverridebooleanOverride 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.
MinimumQuantityThresholdinteger (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.
NonCancelablebooleanSupply Chain Non-Cancelable, Non-Returnable Agreement. If value is TRUE, part is considered NCNR.
StandardPackageinteger (int32)The number of products in the manufacturer's standard package.

CustomerLocationResponse

FieldTypeRequiredDescription
CustomerIdinteger (int32)The unique Id assigned to your Account’s location. This CustomerID is not the same value as the user’s individual CustomerID.
BondedInventorybooleanDoes the location have bonded Inventory
CurrencystringISO code for currency used in the order.
ShippingAddressAddress