Product Information v4

Active 2-legged

Search 16M+ components by keyword, part number, or parametric filters. Retrieve product details, pricing tiers, media, and related items.

https://api.digikey.com/products/v4 OpenAPI spec →

Endpoints

Method	Path	Description
POST	`/search/keyword`	Search products by keyword or part number with optional filters
GET	`/search/{productNumber}/productdetails`	Full product detail for a specific DigiKey part number
GET	`/search/{productNumber}/pricing`	Pricing and quantity breaks
GET	`/search/{productNumber}/pricingbyquantity/{requestedQuantity}`	Price and packaging options at a specific quantity
GET	`/search/packagetypebyquantity/{productNumber}`	Available package types for a given quantity (`requestedQuantity` query param required)
GET	`/search/manufacturers`	List all manufacturers
GET	`/search/{productNumber}/media`	Product images and datasheet URLs
GET	`/search/categories`	Full category tree
GET	`/search/categories/{categoryId}`	Single category detail
GET	`/search/{productNumber}/alternatepackaging`	Alternate packaging options
GET	`/search/{productNumber}/digireelpricing`	DigiReel pricing
GET	`/search/{productNumber}/recommendedproducts`	Similar or complementary products
GET	`/search/{productNumber}/substitutions`	Recommended substitutes
GET	`/search/{productNumber}/associations`	Products often purchased together

POST /search/keyword

Search products using free-text keywords, part numbers, and optional filter objects.

Minimal request

{
  "Keywords": "STM32F103C8T6",
  "Limit": 10
}

Full request (all filter fields)

{
  "Keywords": "resistor",
  "Limit": 50,
  "Offset": 0,
  "FilterOptionsRequest": {
    "ManufacturerFilter": [{ "Id": "13" }],
    "CategoryFilter": [{ "Id": "52" }],
    "StatusFilter": [{ "Id": "0" }],
    "PackagingFilter": [{ "Id": "2" }],
    "MarketPlaceFilter": "ExcludeMarketPlace",
    "TariffFilter": "ExcludeTariff",
    "SeriesFilter": [{ "Id": "81248" }],
    "MinimumQuantityAvailable": 1000,
    "SearchOptions": ["InStock", "RohsCompliant"],
    "ParameterFilterRequest": {
      "CategoryFilter": { "Id": "52" },
      "ParameterFilters": [
        {
          "ParameterId": 2085,
          "FilterValues": [{ "Id": "10 kOhms" }]
        }
      ]
    }
  }
}

Filter field reference

Field	Type	Description
`ManufacturerFilter`	array of `{Id}`	Restrict to specific manufacturers
`CategoryFilter`	array of `{Id}`	Restrict to specific categories
`StatusFilter`	array of `{Id}`	Lifecycle status (0 = Active)
`PackagingFilter`	array of `{Id}`	Packaging type (1 = TR, 2 = CT, 6 = DigiReel)
`MarketPlaceFilter`	string enum	`NoFilter`, `ExcludeMarketPlace`, `MarketPlaceOnly`
`TariffFilter`	string enum	`None`, `ExcludeTariff`, `TariffOnly`
`SeriesFilter`	array of `{Id}`	Restrict to specific product series
`MinimumQuantityAvailable`	integer	Exclude parts with fewer units in stock
`SearchOptions`	array of string	Boolean filter flags (see below)
`ParameterFilterRequest`	object	Parametric (spec-based) filters

SearchOptions values

ChipOutpost, Has3DModel, HasCadModel, HasDatasheet, HasProductPhoto, InStock, NewProduct, NonRohsCompliant, NormallyStocking, RohsCompliant

Response (truncated)

From a live captured response for a 10k resistor search:

{
  "ProductsCount": 433,
  "Products": [
    {
      "DigiKeyPartNumber": "311-10.0KHRCT-ND",
      "ManufacturerProductNumber": "RC0603FR-0710KL",
      "Manufacturer": { "Id": 13, "Name": "YAGEO" },
      "Description": {
        "ProductDescription": "RES 10K OHM 1% 1/10W 0603",
        "DetailedDescription": "10 kOhms ±1% 0.1W, 1/10W Chip Resistor 0603"
      },
      "UnitPrice": 0.1,
      "QuantityAvailable": 7557063,
      "ProductUrl": "https://www.digikey.com/en/products/detail/yageo/RC0603FR-0710KL/726880",
      "ProductStatus": { "Id": 0, "Status": "Active" }
    }
  ]
}

ID discovery workflow

Filter IDs are catalog-driven. The recommended approach:

Call keyword search with only Keywords.
Read FilterOptions in the response (Manufacturers, TopCategories, ParametricFilters).
Build FilterOptionsRequest using the returned IDs.
Re-run with filters applied.

Do not hardcode manufacturer or category IDs. They can change when the catalog is updated.

GET /search/{productNumber}/productdetails

Returns the full data record for a single DigiKey part number.

Path parameter: productNumber — the DigiKey part number (e.g. 497-6063-ND)

Response (truncated)

{
  "Product": {
    "DigiKeyPartNumber": "497-6063-ND",
    "ManufacturerProductNumber": "STM32F103C8T6",
    "Manufacturer": { "Id": 497, "Name": "STMicroelectronics" },
    "Description": {
      "ProductDescription": "IC MCU 32BIT 64KB FLASH 48LQFP",
      "DetailedDescription": "ARM Cortex-M3 STM32F1 Microcontroller IC 32-Bit 72MHz 64KB FLASH"
    },
    "UnitPrice": 5.91,
    "ProductUrl": "https://www.digikey.com/en/products/detail/stmicroelectronics/STM32F103C8T6/1646338",
    "DatasheetUrl": "https://www.st.com/resource/en/datasheet/stm32f103cb.pdf",
    "PhotoUrl": "https://mm.digikey.com/Volume0/opasdata/d220001/medias/images/389/48-LQFP.jpg",
    "ProductVariations": [
      {
        "DigiKeyProductNumber": "497-6063-ND",
        "PackageType": { "Id": 17, "Name": "Tray" },
        "StandardPricing": [
          { "BreakQuantity": 1,   "UnitPrice": 5.91,    "TotalPrice": 5.91 },
          { "BreakQuantity": 10,  "UnitPrice": 4.532,   "TotalPrice": 45.32 },
          { "BreakQuantity": 25,  "UnitPrice": 4.186,   "TotalPrice": 104.65 },
          { "BreakQuantity": 100, "UnitPrice": 3.8065,  "TotalPrice": 380.65 },
          { "BreakQuantity": 250, "UnitPrice": 3.62548, "TotalPrice": 906.37 }
        ],
        "QuantityAvailableforPackageType": 4215,
        "MinimumOrderQuantity": 1
      }
    ]
  }
}

GET /search/{productNumber}/pricing

Returns all pricing tiers and availability information for every packaging variant of a given DigiKey part number.

Path parameter: productNumber — DigiKey part number (e.g. 497-6063-ND)

Response (captured — `497-6063-ND`, STM32F103C8T6)

{
  "ProductPricings": [
    {
      "ManufacturerProductNumber": "STM32F103C8T6",
      "Manufacturer": { "Id": 497, "Name": "STMicroelectronics" },
      "Description": {
        "ProductDescription": "IC MCU 32BIT 64KB FLASH 48LQFP"
      },
      "QuantityAvailable": 1542,
      "IsDiscontinued": false,
      "NormallyStocking": true,
      "ProductVariations": [
        {
          "DigiKeyProductNumber": "497-6063-ND",
          "PackageType": { "Id": 17, "Name": "Tray" },
          "QuantityAvailableforPackageType": 1542,
          "MinimumOrderQuantity": 1,
          "StandardPricing": [
            { "BreakQuantity": 1,    "UnitPrice": 5.91,    "TotalPrice": 5.91 },
            { "BreakQuantity": 10,   "UnitPrice": 4.532,   "TotalPrice": 45.32 },
            { "BreakQuantity": 25,   "UnitPrice": 4.186,   "TotalPrice": 104.65 },
            { "BreakQuantity": 100,  "UnitPrice": 3.8065,  "TotalPrice": 380.65 },
            { "BreakQuantity": 250,  "UnitPrice": 3.62548, "TotalPrice": 906.37 },
            { "BreakQuantity": 500,  "UnitPrice": 3.51634, "TotalPrice": 1758.17 },
            { "BreakQuantity": 1000, "UnitPrice": 3.42657, "TotalPrice": 3426.57 }
          ]
        }
      ]
    }
  ],
  "ProductsCount": 1,
  "SettingsUsed": {
    "SearchLocaleUsed": { "Site": "US", "Language": "en", "Currency": "USD" }
  }
}

GET /search/{productNumber}/pricingbyquantity/{requestedQuantity}

Returns the best price and packaging breakdown when you intend to buy a specific quantity. The API selects the optimal combination of available package types to fulfill the request at the lowest total cost.

Path parameters:
- productNumber — DigiKey part number (e.g. 497-6063-ND)
- requestedQuantity — the integer quantity you intend to order (e.g. 100)

Response (captured — `497-6063-ND`, qty 100)

{
  "RequestedProduct": "497-6063-ND",
  "RequestedQuantity": 100,
  "ProductUrl": "https://www.digikey.com/en/products/detail/stmicroelectronics/STM32F103C8T6/1646338",
  "ManufacturerPartNumber": "STM32F103C8T6",
  "Manufacturer": { "Id": 497, "Name": "STMicroelectronics" },
  "Description": {
    "ProductDescription": "IC MCU 32BIT 64KB FLASH 48LQFP"
  },
  "SettingsUsed": {
    "SearchLocaleUsed": { "Site": "US", "Language": "en", "Currency": "USD" }
  },
  "StandardPricingOptions": [
    {
      "PricingOption": "Exact",
      "TotalQuantityPriced": 100,
      "TotalPrice": 380.65,
      "QuantityAvailable": 1542,
      "Products": [
        {
          "DigiKeyProductNumber": "497-6063-ND",
          "QuantityPriced": 100,
          "MinimumOrderQuantity": 1,
          "ExtendedPrice": 380.65,
          "UnitPrice": 3.8065,
          "PackageType": { "Id": 17, "Name": "Tray" },
          "TariffInformation": { "TariffActive": false }
        }
      ]
    }
  ],
  "MyPricingOptions": []
}

GET /search/packagetypebyquantity/{productNumber}

Given a product and desired quantity, returns which package variants (cut tape, reel, DigiReel, tray) can fulfill the order and at what unit price.

Path parameter: productNumber — DigiKey part number (e.g. 311-10.0KHRCT-ND)

Required query parameter: requestedQuantity — integer quantity

Request example

GET /products/v4/search/packagetypebyquantity/311-10.0KHRCT-ND?requestedQuantity=100

Response (captured — `311-10.0KHRCT-ND`, qty 100)

{
  "Products": [
    {
      "DigiKeyProductNumber": "311-10.0KHRCT-ND",
      "ManufacturerProductNumber": "RC0603FR-0710KL",
      "ManufacturerName": "YAGEO",
      "ProductDescription": "RES 10K OHM 1% 1/10W 0603",
      "RecommendedQuantity": 100,
      "QuantityAvailable": 7419257,
      "MinimumOrderQuantity": 1,
      "ProductStatus": "Active",
      "RohsStatus": "ROHS3 Compliant",
      "ManufacturerLeadWeeks": "18",
      "Category": {
        "CategoryId": 2,
        "Name": "Resistors",
        "ParentId": 0
      }
    }
  ]
}

GET /search/{productNumber}/media

Returns all media items linked to a product — datasheets, product photos, training modules, and 3D models.

Path parameter: productNumber — DigiKey part number (e.g. 497-6063-ND)

Response (captured — `497-6063-ND`, STM32F103C8T6)

{
  "MediaLinks": [
    {
      "MediaType": "Datasheets",
      "Title": "STM32F103x(8,B) Datasheet",
      "SmallPhoto": null,
      "Thumbnail": null,
      "Url": "https://www.st.com/resource/en/datasheet/stm32f103cb.pdf"
    },
    {
      "MediaType": "Product Photos",
      "Title": "48-LQFP",
      "SmallPhoto": "https://mm.digikey.com/Volume0/opasdata/d220001/derivates/1/010/133/948/48-LQFP_sml.jpg",
      "Thumbnail": "https://mm.digikey.com/Volume0/opasdata/d220001/derivates/3/010/133/948/48-LQFP_tmb.jpg",
      "Url": "https://mm.digikey.com/Volume0/opasdata/d220001/medias/images/389/48-LQFP.jpg"
    },
    {
      "MediaType": "Product Training Modules",
      "Title": "STM32Cube",
      "SmallPhoto": null,
      "Thumbnail": null,
      "Url": "https://www.digikey.com/ptm/s/stmicroelectronics/stm32cube"
    }
  ]
}

MediaType values seen in practice: Datasheets, Product Photos, Product Training Modules, 3D Models, EDA / CAD Models

GET /search/manufacturers

Returns the complete list of manufacturers whose products are carried by DigiKey. Use the returned Id values in ManufacturerFilter when calling POST /search/keyword.

Note: This endpoint returns 3,700+ manufacturers. Cache the result — the catalog changes infrequently.

Response (truncated — 3,701 manufacturers returned)

{
  "Manufacturers": [
    { "Id": 19,  "Name": "3M" },
    { "Id": 13,  "Name": "YAGEO" },
    { "Id": 497, "Name": "STMicroelectronics" }
  ]
}

GET /search/categories

Returns the full product category tree (50 top-level categories, each with Children subcategories). Use the CategoryId values in CategoryFilter.

Response (truncated — 50 top-level categories)

{
  "ProductCount": 50,
  "Categories": [
    {
      "CategoryId": 28,
      "ParentId": 0,
      "Name": "Anti-Static, ESD, Clean Room Products",
      "ProductCount": 9133,
      "Children": [
        { "CategoryId": 605, "ParentId": 28, "Name": "Anti-Static, ESD Bags, Materials",             "ProductCount": 1294, "Children": [] },
        { "CategoryId": 610, "ParentId": 28, "Name": "Anti-Static, ESD Clothing",                  "ProductCount": 1258, "Children": [] },
        { "CategoryId": 606, "ParentId": 28, "Name": "Anti-Static, ESD Grounding Mats",            "ProductCount": 1411, "Children": [] },
        { "CategoryId": 604, "ParentId": 28, "Name": "Anti-Static, ESD Straps, Grounding Cords",   "ProductCount": 829,  "Children": [] }
      ]
    },
    {
      "CategoryId": 2,
      "ParentId": 0,
      "Name": "Resistors",
      "ProductCount": 423819,
      "Children": [
        { "CategoryId": 52, "ParentId": 2, "Name": "Chip Resistor - Surface Mount", "ProductCount": 231804, "Children": [] }
      ]
    }
  ],
  "SearchLocaleUsed": { "Site": "US", "Language": "en", "Currency": "USD" }
}

GET /search/categories/{categoryId}

Returns a single category and its immediate children.

Path parameter: categoryId — numeric category ID (e.g. 605)

Response (captured — categoryId `605`)

{
  "Category": {
    "CategoryId": 28,
    "ParentId": 0,
    "Name": "Anti-Static, ESD, Clean Room Products",
    "ProductCount": 1294,
    "Children": [
      {
        "CategoryId": 605,
        "ParentId": 28,
        "Name": "Anti-Static, ESD Bags, Materials",
        "ProductCount": 1294,
        "Children": []
      }
    ]
  },
  "SearchLocaleUsed": { "Site": "US", "Language": "en", "Currency": "USD" }
}

GET /search/{productNumber}/alternatepackaging

Returns all other DigiKey SKUs that represent the same underlying component in a different packaging format (cut tape, reel, tray, DigiReel).

Path parameter: productNumber — DigiKey part number (e.g. 311-10.0KHRCT-ND)

Response (captured — `311-10.0KHRCT-ND`, YAGEO RC0603FR-0710KL)

{
  "AlternatePackagings": {
    "AlternatePackaging": [
      {
        "DigiKeyProductNumber": "13-RC0603FR-1010KLTR-ND",
        "ManufacturerProductNumber": "RC0603FR-1010KL",
        "Manufacturer": { "Id": 13, "Name": "YAGEO" },
        "Description": "RES 10K OHM 1% 1/10W 0603",
        "UnitPrice": "0.1",
        "QuantityAvailable": 346023,
        "ProductUrl": "https://www.digikey.com/en/products/detail/yageo/RC0603FR-1010KL/12756395"
      },
      {
        "DigiKeyProductNumber": "13-RC0603FR-1310KLTR-ND",
        "ManufacturerProductNumber": "RC0603FR-1310KL",
        "Manufacturer": { "Id": 13, "Name": "YAGEO" },
        "Description": "RES 10K OHM 1% 1/10W 0603",
        "UnitPrice": "0.1",
        "QuantityAvailable": 182105,
        "ProductUrl": "https://www.digikey.com/en/products/detail/yageo/RC0603FR-1310KL/12756399"
      }
    ]
  },
  "SearchLocaleUsed": { "Site": "US", "Language": "en", "Currency": "USD" }
}

GET /search/{productNumber}/substitutions

Returns DigiKey-suggested drop-in substitute parts. Useful when a preferred component is out of stock or end-of-life. Results are typed by SubstituteType: Direct (same specs) or Upgrade (improved specs).

Path parameter: productNumber — DigiKey part number

Response (captured — `1276-3096-1-ND`, Samsung CL31B105KAHNNNE — 51 substitutes)

{
  "ProductSubstitutesCount": 51,
  "ProductSubstitutes": [
    {
      "SubstituteType": "Upgrade",
      "DigiKeyProductNumber": "399-C1206C105K5RACTUTR-ND",
      "ManufacturerProductNumber": "C1206C105K5RACTU",
      "Manufacturer": { "Id": 399, "Name": "KEMET" },
      "Description": "CAP CER 1UF 50V X7R 1206",
      "UnitPrice": "0.29",
      "QuantityAvailable": 219000,
      "ProductUrl": "https://www.digikey.com/en/products/detail/kemet/C1206C105K5RACTU/2215096"
    },
    {
      "SubstituteType": "Direct",
      "DigiKeyProductNumber": "311-1181-2-ND",
      "ManufacturerProductNumber": "CC1206KKX7R7BB105",
      "Manufacturer": { "Id": 13, "Name": "YAGEO" },
      "Description": "CAP CER 1UF 16V X7R 1206",
      "UnitPrice": "0.22",
      "QuantityAvailable": 134870,
      "ProductUrl": "https://www.digikey.com/en/products/detail/yageo/CC1206KKX7R7BB105/302915"
    }
  ],
  "SearchLocaleUsed": { "Site": "US", "Language": "en", "Currency": "USD" }
}

Not all parts have substitutes. A response with ProductSubstitutesCount: 0 and an empty array is valid.

GET /search/{productNumber}/recommendedproducts

Returns complementary or commonly paired products suggested by DigiKey. Useful for surfacing accessories or companion components.

Path parameter: productNumber — DigiKey part number

Response (captured — `497-6063-ND`, STM32F103C8T6)

{
  "Recommendations": [
    {
      "ProductNumber": "497-6063-ND",
      "RecommendedProducts": [
        {
          "DigiKeyProductNumber": "160-1427-2-ND",
          "ManufacturerProductNumber": "LTST-C171KRKT",
          "ManufacturerName": "Lite-On Inc.",
          "ProductDescription": "LED RED CLEAR SMD",
          "QuantityAvailable": 538935,
          "UnitPrice": 0.0,
          "ProductUrl": "https://www.digikey.com/en/products/detail/liteon/LTST-C171KRKT/386801"
        },
        {
          "DigiKeyProductNumber": "SW1020TR-ND",
          "ManufacturerProductNumber": "B3U-1000P",
          "ManufacturerName": "Omron Electronics Inc-EMC Div",
          "ProductDescription": "SWITCH TACTILE SPST-NO 0.05A 12V",
          "QuantityAvailable": 94050,
          "UnitPrice": 0.0,
          "ProductUrl": "https://www.digikey.com/en/products/detail/omron-electronics/B3U-1000P/5820379"
        }
      ]
    }
  ]
}

GET /search/{productNumber}/associations

Returns products frequently purchased alongside this one, organized into Kits, MatingProducts, and AssociatedProducts.

Path parameter: productNumber — DigiKey part number

Response (captured — `497-6063-ND`, STM32F103C8T6)

{
  "ProductAssociations": {
    "Kits": [],
    "MatingProducts": [],
    "AssociatedProducts": [
      {
        "DigiKeyProductNumber": "497-17159-1-ND",
        "ManufacturerProductNumber": "ESDA7P120-1U1M",
        "Manufacturer": { "Id": 497, "Name": "STMicroelectronics" },
        "Description": "TVS DIODE 5.5VWM 11.5VC 1610",
        "UnitPrice": "0.34",
        "QuantityAvailable": 49934,
        "ProductUrl": "https://www.digikey.com/en/products/detail/stmicroelectronics/ESDA7P120-1U1M/6709858"
      },
      {
        "DigiKeyProductNumber": "497-2930-1-ND",
        "ManufacturerProductNumber": "ESDA6V1L",
        "Manufacturer": { "Id": 497, "Name": "STMicroelectronics" },
        "Description": "TVS DIODE 5.25VWM SOT23-3",
        "UnitPrice": "0.25",
        "QuantityAvailable": 53122,
        "ProductUrl": "https://www.digikey.com/en/products/detail/stmicroelectronics/ESDA6V1L/634694"
      }
    ]
  },
  "SearchLocaleUsed": { "Site": "US", "Language": "en", "Currency": "USD" }
}

GET /search/{productNumber}/digireelpricing

Returns the per-unit price and reel fee for a custom DigiReel order. DigiReel cuts from a full reel to your exact quantity.

Path parameter: productNumber — DigiKey part number (cut-tape variants only)

Required query parameter: requestedQuantity — the quantity you intend to order

Request example

GET /products/v4/search/311-10.0KHRCT-ND/digireelpricing?requestedQuantity=100

Response (captured — `311-10.0KHRCT-ND`, qty 100)

{
  "ReelingFee": 7.0,
  "UnitPrice": 0.0756,
  "ExtendedPrice": 7.56,
  "RequestedQuantity": 100,
  "SearchLocaleUsed": { "Site": "US", "Language": "en", "Currency": "USD" }
}

ExtendedPrice = (UnitPrice × RequestedQuantity) + ReelingFee. The reel fee is a flat charge regardless of quantity.

Authentication

Requires a valid Authorization: Bearer <token> header. Use the 2-legged (Client Credentials) flow — no user login required.

curl "https://api.digikey.com/products/v4/search/keyword" \
  -X POST \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "X-DIGIKEY-Client-Id: YOUR_CLIENT_ID" \
  -H "Content-Type: application/json" \
  -d '{"Keywords": "capacitor 100uf", "Limit": 10}'

Models

Request and response object schemas for this API. Error models (ApiErrorResponse, DKProblemDetails) are documented on the Authentication & Concepts page.

`AlternatePackagingResponse`

Response model for AlternatePackaging

Field	Type	Required	Description
`AlternatePackagings`	AlternatePackaging
`SearchLocaleUsed`	IsoSearchLocale

`CategoriesResponse`

Response model for Categories call.

Field	Type	Description
`ProductCount`	integer (int32)	Count of Products
`Categories`	array of Category	List of Categories
`SearchLocaleUsed`	IsoSearchLocale

`CategoryResponse`

Response model for a single Category call.

Field	Type	Required	Description
`Category`	Category
`SearchLocaleUsed`	IsoSearchLocale

`DigiReelPricing`

Response for Digi-Reel Pricing Request

Field	Type	Description
`ReelingFee`	number (double)	Fee per reel ordered.
`UnitPrice`	number (double)	Price of a single unit of the product.
`ExtendedPrice`	number (double)	The total price of the requested reels and the reeling fee.
`RequestedQuantity`	integer (int32)	The passed in quantity of the product you are looking to create a Digi-Reel with.
`SearchLocaleUsed`	IsoSearchLocale
`AccountIdUsed`	integer (int32)	The AccountID we used for the transaction. It may have been entered in the X-DIGIKEY-Account-ID field or determined from the API user’s authentication request.
`CustomerIdUsed`	integer (int32)	The CustomerID we used for the transaction.

`KeywordRequest`

Criteria for Keyword Requests

Field	Type	Description
`Keywords`	string	A String of Keywords, up to 250 characters
`Limit`	integer (int32)	Number of products to return between 1 and 50.
`Offset`	integer (int32)	The starting index of the records returned. This is used to paginate beyond RecordCount number of results.
`FilterOptionsRequest`	FilterOptionsRequest
`SortOptions`	SortOptions

`KeywordResponse`

Field	Type	Description
`Products`	array of Product
`ProductsCount`	integer (int32)	Total number of matching products found.
`ExactMatches`	array of Product
`FilterOptions`	FilterOptions
`SearchLocaleUsed`	IsoSearchLocale
`AppliedParametricFiltersDto`	array of Parameter

`ManufacturersResponse`

List of Manufacturers and information about each manufacturer

Field	Type	Required	Description
`Manufacturers`	array of ManufacturerInfo		List of Manufacturer Information

`MediaResponse`

Response model for Media

Field	Type	Required	Description
`MediaLinks`	array of MediaLinks		List of Media Links

`PackageTypeByQuantityResponse`

Response from a PackageTypeByQuantity Search Service request

Field	Type	Description
`Products`	array of PackageTypeByQuantityProduct	List of products that matched the PackageTypeByQuantitySearchService request.
`AccountIdUsed`	integer (int32)	The AccountID we used for the transaction. It may have been entered in the X-DIGIKEY-Account-ID field or determined from the API user’s authentication request.
`CustomerIdUsed`	integer (int32)	The CustomerID we used for the transaction.

`PricingOptionsForQuantityResponse`

Pricing options for quantity response

Field	Type	Description
`RequestedProduct`	string	The requested product used for the API call.
`RequestedQuantity`	integer (int32)	The RequestedQuantity we used for the API call. Note we may have lowered or increased your requested amount if it is outside allowed quantities or to provide you a better deal.
`ProductUrl`	string	Full URL of the DigiKey page to purchase the product. This is based on your provided Locale values.
`ManufacturerPartNumber`	string	The manufacturer part number. Note that some manufacturer part numbers may be used by multiple manufacturers for different parts.
`Manufacturer`	Manufacturer
`Description`	Description
`SettingsUsed`	PriceSettingsUsed
`MyPricingOptions`	array of PricingOptionsForQuantity	MyPricingOptions
`StandardPricingOptions`	array of PricingOptionsForQuantity	StandardPricingOptions
`AccountIdUsed`	integer (int32)	The AccountID we used for the transaction. It may have been entered in the X-DIGIKEY-Account-ID field or determined from the API user’s authentication request.
`CustomerIdUsed`	integer (int32)	The CustomerID we used for the transaction.

`ProductAssociationsResponse`

Response model for ProductAssociations

Field	Type	Required	Description
`ProductAssociations`	ProductAssociations
`SearchLocaleUsed`	IsoSearchLocale

`ProductDetails`

Product Details Data Transfer Object

Field	Type	Description
`SearchLocaleUsed`	IsoSearchLocale
`Product`	Product
`AccountIdUsed`	integer (int32)	The AccountID we used for the transaction. It may have been entered in the X-DIGIKEY-Account-ID field or determined from the API user’s authentication request.
`CustomerIdUsed`	integer (int32)	The CustomerID we used for the transaction.

`ProductPricingResponse`

A sub set of the product infromation

Field	Type	Description
`ProductPricings`	array of ProductPricing	List of Products
`ProductsCount`	integer (int32)	Total number of matching products found.
`SettingsUsed`	SettingsUsed
`AccountIdUsed`	integer (int32)	The AccountID we used for the transaction. It may have been entered in the X-DIGIKEY-Account-ID field or determined from the API user’s authentication request.
`CustomerIdUsed`	integer (int32)	The CustomerID we used for the transaction.

`ProductSubstitutesResponse`

Response model for ProductSubstitutes

Field	Type	Description
`ProductSubstitutesCount`	integer (int32)	Count of ProductSubstitutes
`ProductSubstitutes`	array of ProductSubstitute	List of ProductSubstitutes
`SearchLocaleUsed`	IsoSearchLocale

`RecommendedProductsResponse`

The recommended products returned grouped in collections.

Field	Type	Required	Description
`Recommendations`	array of Recommendation		The list of RecommendedProductsCollections - each containing a Product and its recommendations.

Product Information v4

Endpoints

POST /search/keyword

Minimal request

Full request (all filter fields)

Response (truncated)

ID discovery workflow

GET /search/{productNumber}/productdetails

Response (truncated)

GET /search/{productNumber}/pricing

Response (captured — 497-6063-ND, STM32F103C8T6)

GET /search/{productNumber}/pricingbyquantity/{requestedQuantity}

Response (captured — 497-6063-ND, qty 100)

GET /search/packagetypebyquantity/{productNumber}

Request example

Response (captured — 311-10.0KHRCT-ND, qty 100)

GET /search/{productNumber}/media

Response (captured — 497-6063-ND, STM32F103C8T6)

GET /search/manufacturers

Response (truncated — 3,701 manufacturers returned)

GET /search/categories

Response (truncated — 50 top-level categories)

GET /search/categories/{categoryId}

Response (captured — categoryId 605)

GET /search/{productNumber}/alternatepackaging

Response (captured — 311-10.0KHRCT-ND, YAGEO RC0603FR-0710KL)

GET /search/{productNumber}/substitutions

Response (captured — 1276-3096-1-ND, Samsung CL31B105KAHNNNE — 51 substitutes)

GET /search/{productNumber}/recommendedproducts

Response (captured — 497-6063-ND, STM32F103C8T6)

GET /search/{productNumber}/associations

Response (captured — 497-6063-ND, STM32F103C8T6)

GET /search/{productNumber}/digireelpricing

Request example

Response (captured — 311-10.0KHRCT-ND, qty 100)

Authentication

Models

AlternatePackagingResponse

CategoriesResponse

CategoryResponse

DigiReelPricing

KeywordRequest

KeywordResponse

ManufacturersResponse

MediaResponse

PackageTypeByQuantityResponse

PricingOptionsForQuantityResponse

ProductAssociationsResponse

ProductDetails

ProductPricingResponse

ProductSubstitutesResponse

RecommendedProductsResponse

Response (captured — `497-6063-ND`, STM32F103C8T6)

Response (captured — `497-6063-ND`, qty 100)

Response (captured — `311-10.0KHRCT-ND`, qty 100)

Response (captured — `497-6063-ND`, STM32F103C8T6)

Response (captured — categoryId `605`)

Response (captured — `311-10.0KHRCT-ND`, YAGEO RC0603FR-0710KL)

Response (captured — `1276-3096-1-ND`, Samsung CL31B105KAHNNNE — 51 substitutes)

Response (captured — `497-6063-ND`, STM32F103C8T6)

Response (captured — `497-6063-ND`, STM32F103C8T6)

Response (captured — `311-10.0KHRCT-ND`, qty 100)

`AlternatePackagingResponse`

`CategoriesResponse`

`CategoryResponse`

`DigiReelPricing`

`KeywordRequest`

`KeywordResponse`

`ManufacturersResponse`

`MediaResponse`

`PackageTypeByQuantityResponse`

`PricingOptionsForQuantityResponse`

`ProductAssociationsResponse`

`ProductDetails`

`ProductPricingResponse`

`ProductSubstitutesResponse`

`RecommendedProductsResponse`