DK API Changelogs

ProductSearch Changelog

All notable change to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[4.0.3] - 2024-08-12

Note: While the MyPricing field is included in the KeywordSearch response, it will not be populated. Only StandardPricing will be included. Please use the ProductDetails or ProductPricing endpoints to receive MyPricing

[4.0.2] - 2024-05-29 

• We added a new operation called ProductPricing within this API that will be the primary search for many use cases.
• ProductPricing allows you to enter a part number and receive multiple responses that match that part number.
• Each response will contain both standard pricing and MyPricing (if applicable) and will contain many part information attributes but not the parametric data available in ProductDetails.

[4.0.1] - 2023-06-05 

Changed 

• MinimumOrderQuantity is no longer in Product - it is now in ProductVariations
• QuantityAvailable in ProductVariations is now called QuantityAvailableforPackageType
• DigiReelFee is now in ProductVariations
• MaxQuantityForDistribution is no longer in product - it is still in ProductVariations

Removed 

• Supplier URL - supplier object in ProductVariations no longer has URL property
• StandardPackage is no longer in Product

[4.0.0] - 2023-03-10 

Added 

• Product Roll up: Results are grouped by manufacturer part number which will reduce the number of results returned when compared to previous versions. In previous versions, each package type was it's own result.
• Environmental and Export Classifications have been added to the Product model.
• There are now individual endpoints for Associations, Media and Substitutions each with their own response model.

Changed 

• The Product and ProductDetails models have been combined into a single Product model. This is used by both the Keyword and ProductDetails endpoints.
• The ProductDetails model still exists but now contains a list of Product models.
• PrimaryVideo has been renamed to PrimaryVideoUrl.
• IsNcnr has been renamed to Ncnr.
• PrimaryDatasheet has been renamed to DatasheetUrl.
• DetailedDescription is now within the Description model.
• Packaging, Manufacturer and Series were both a combination of a parameter Id and Value Id. They were used for filtering search results. They have been replaced by FilterOptionsRequest which contains all filtering options
• AlternatePackaging which was a list of the BasicProduct model has been replaced by ProductVariations which is a list of the the new ProductVariation model
• My Pricing and Package Type are now in the ProductVariation model
• IsNcnr is now in the Product model and renamed to Ncnr
• ManufacturerPartNumber is now in the Product model and renamed to ManufacturerProductNumber
• ManufacturerPublicQuantity is now in the Product model.
• ProductDescription is now within the Description model.
• SupplierId is now withing the Supplier model.
• UnitPrice is now in the Product model.
• Associations, Media and Substitutions are no longer returned as part of the ProductDetails endpoint. They each have their own endpoint. Kits, MatingProducts, AssociatedProducts and ForUseWithProducts are part of the ProductAssociations model and available from the new Associations endpoint.
• ApiErrorResponse and ApiValidationError have been replaced by DKProblemDetails
• MoistureSensitivityLevel, ExportControlClassNumber and HTSUSCode are now in the Classifications object

Removed 

• Fields that were in the old Product or ProductDetails but no longer in Product model:
  • DKPlusRestriction
  • LeadStatus
  • NonStock
• Fields that were in AlternatePackaging/BasicProduct but are no longer in the ProductVariation model:
  • DKPlusRestriction
  • SupplierDirectShip
  • NonStock
  • PimProductName
  • QuantityOnOrder
  • SupplierDirectShip

[Supplements] 

[\[3.0.0\]: https://github.com/Digi-Key/ApiClient.V3-Java]

[\[3.0.0\]: https://github.com/Digi-Key/ApiClient.V3]

OrderStatus Changelog

2024-02-28

The new OrderStatus API is replacing the current OrderDetails. OrderDetails will continue to be supported into 2025.

Added: 

• The new OrderSearch endpoint returns all orders placed within the specified timeframe and includes the details for each order. Currently you need to call two endpoints to get that same information.
• Both new endpoints include the SalesOrderStatus/EntireOrderStatus and the description for that status. It will now match what you see on DigiKey.com’s myDigiKey
• The ability to page through orders, like on Digikey.com, has been added

Changed: 

• History route has been changed from “/History” to “/orders”
• Sales order route has been changed from “/Status/{salesOrderId}” to “/salesorder/{salesOrderId}”
• “includeCompanyOrders” has been renamed to “shared”
• SalesOrderId endpoint now returns a single sales order

Removed: 

• “openOnly” parameter has been removed
• “includes” parameter has been removed