1. OrderDetails Changelog
  2. PackageTypeByQuantity Changelog
  3. PartSearch Changelog
  4. ProductChangeNotifications Changelog
  5. RecommendedParts Changelog

OrderDetails Changelog

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

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

[3.0.0] - 2019-10-01

Added

  • New API header ‘X-DIGIKEY-Client-Id’.
    • This replaces ‘X-IBM-Client-Id’.
  • New error message structure. This brings conformity to our APIs and consistent error formats to our customers.
  • Optional ‘Includes’ query parameter to specify which fields to return. This allows customization of the API response.
  • Order status now returns the currency that was used in the order.
  • Order Status now returns the shipper account number in addition to the account number of backorders.

Changed

  • Order Status and Order History APIs have been combined into one Order Details API.
  • A concerted effort was made to unify naming/descriptions across all APIs.
  • HTTP codes have been cleaned up and unified across our APIs.
  • Many descriptions across the API have been added, updated, or redone.
  • The Authorization Header now needs the label "Bearer" and the text of the bearer/access token in the header

    • C# example:
      authenticationHeaderValue = new AuthenticationHeaderValue("Bearer", your bearer/access token);
      HttpClient.DefaultRequestHeaders.Authorization = authenticationHeaderValue;

  • Shortened elements (i.e. ‘Addrline_1’) have been expanded to their full name (i.e. ‘AddressLineOne’).
  • Order History operations have been combined into one. Including company orders is now via a flag ‘IncludeCompanyOrders’ rather than a Root Id
  • Language around Root Ids has changed to refer to Company.
  • Dates in both input and output have been changed to ISO 8601 format where they weren’t already.
  • Most parameters have changed to query parameters to better align with RESTful API standards.
  • Many parameters have been made optional and will default to reasonable values. For example, if no dates are provided, one month of order history is returned.
  • ‘CarrierId’ changed to ‘Carrier’. Internal codes for Carriers have been replaced with the carrier name.
  • ShipmentType of “Standard” replaced with “Immediate”.
  • ‘Backorder’ renamed to ‘QuantityBackorder’ for clarity and to align with ‘QuantityShipped’
  • ‘Description’ renamed to ‘ProductDescription’ to match Partsearch V3 API.
  • ‘PartNumber’ renamed to ‘DigiKeyPartNumber’ to clarify which type it is. The API will not return Manufacturer Part Numbers.
  • ‘ShippingURL’ renamed to ‘TrackingUrl’ for clarity.
  • ‘StateCode’ renamed to ‘Province’ to match other APIs. If in the US this will still return the state.
  • ‘ZipCode’ renamed to ‘PostalCode’ to match other APIs.
  • ‘CustomerNumber’ renamed to ‘CustomerId’ to match other APIs.
  • ‘AccountNumber’ renamed to ‘BillingAccount’ for clarity.
  • ‘EmailAddress’ renamed to ‘Email’ to match other APIs.
  • ‘OrderDetails’ renamed to ‘LineItems’ for clarity.

Removed

  • XML support. Only JSON will be supported moving forward.
  • ‘X-IBM-Client-Id’ was removed.
  • ‘CustomerId’ is no longer required for Order Status. It will check the order against all Customer Ids on your account automatically.

Fixed

  • Fixed typos.
  • Miscellaneous bug fixes and optimizations.

[Supplements]

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

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

 

 

PackageTypeByQuantity Changelog

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

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

[3.0.0] - 2019-06-20

Added

  • New API header ‘X-DIGIKEY-Client-Id’.
    • This replaces ‘X-IBM-Client-Id’.
  • New error message structure. This brings conformity to our APIs and consistent error formats to our customers.
  • Optional ‘Includes’ query parameter to specify which fields to return. This allows customization of the API response.
  • Added ‘QuantityOnOrder’ to the response.
  • Added ‘DateLastBuyChance’ to the response.

Changed

  • A concerted effort was made to unify naming/descriptions across all APIs.
  • Many descriptions across the API have been added, updated, or redone.
  • The Authorization Header now needs the label "Bearer" and the text of the bearer/access token in the header

    • C# example:
      authenticationHeaderValue = new AuthenticationHeaderValue("Bearer", your bearer/access token);
      HttpClient.DefaultRequestHeaders.Authorization = authenticationHeaderValue;

  • Shortened elements (i.e. ‘pid’, ‘vid’, or ‘dk’) have been expanded to their full name (i.e. ‘parameterId’, ‘valueId’, DigiKey).
  • Some slight model renaming has taken place.
  • Order of elements in the responses have been reordered to aid manual testing.
  • ‘Part’ has been renamed to ‘Product’ across all APIs. This is to better align our APIs with Digi-Key’s growing catalog.
  • HTTP codes have been cleaned up and unified across our APIs. This has led to some changed responses.
    • (i.e. 404 is now returned if a part cannot be found.)
    • As part of this, ‘Bad Request’ responses will now better explain invalid input.
  • The abbreviated ‘PkgTypeByQty’ has been expanded to ‘PackageTypeByQuantity’ for increased clarity.
  • The ‘Search’ operation was renamed to ‘PackageTypeByQuantity’ to better convey what the operation does.
  • The ‘PackageTypeByQuantity’ (formerly ‘Search’) operation has been changed to an HTTP GET operation. URL encoding will be needed for parameters moved to the URL.
  • The ‘PackageTypeByQuantity’ route changed from “services/packagetypebyquantity/v2/search” to “PackageTypeByQuantity/v3/Products/{DigiKeyPartNumber}” to better conform to RESTful standards.
    • Renamed input parameters are ‘DigiKeyPartNumber’, ‘PackagingPreference’, ‘RequestedQuantity’.
    • Added ‘Includes’ input parameter.
  • ‘PartNumber’ in the request has been renamed to ‘DigiKeyPartNumber’ to differentiate it from the manufacturer part number.
  • ‘PartPreference’ in the request has been renamed to ‘PackagingPreference’ to clarify that it specifies a package type preference, not a part.
  • ‘Quantity’ in the request renamed to ‘RequestedQuantity’ to differentiate between the count of the product and the number of results returned.
  • ‘Parts’ in the response has been renamed to ‘Products’ to better align our APIs with Digi-Key’s growing catalog.
  • The ‘PackageTypeByQuantityPart’ model has been renamed to ‘PackageTypeByQuantityProduct’ to better align our APIs with Digi-Key’s growing catalog.
    • The ‘PackageTypeByQuantityPart’ model matches the ‘ProductDetails’ model in our PartSearch API, and includes an additional ‘RecommendedQuantity’ field.
  • ‘Quantity’ in the response has been renamed to ‘RecommendedQuantity’ to differentiate it from other listed quantities.
  • ‘QuantityOnHand’ in the response has been renamed to ‘QuantityAvailable’ to use more standard terminology.
  • ‘ManufacturerName’ in the response has been renamed to ‘Manufacturer’ and now includes a parameterId and valueId to match other models.
  • ‘ManufacturerPageUrl’ in the response now returns a full URL; it no longer returns a path to be appended to the host.
  • ‘ManfacturerPublicQuantity’ in the response has been renamed to ‘ManufacturerPublicQuantity’ to fix the spelling error.
  • ‘BuyUrl’ in the response has been renamed to ‘ProductUrl’ to use more consistent terminology.
  • ‘PartStatus’ in the response has been renamed to ‘ProductStatus’ to better align our APIs with Digi-Key’s growing catalog.
  • ‘RohsInfo’ in the response has been renamed to ‘RoHSStatus’ to use more consistent terminology.
  • ‘AvailableOnOrder’ in the response renamed to ‘QuantityOnOrder’ to clarify that it is a quantity and not a status.
  • ‘AlternatePackaging’ is now a BasicProduct instead of an AssociatedProduct.
  • The ‘SearchLocale’ model has been replaced with ‘IsoSearchLocale’ to follow ISO standards.
  • ‘SearchLocale’ in the response has been renamed to ‘SearchLocaleUsed’ to make it clear that this locale information was used in the request.
  • In the ‘LimitedTaxonomy’ model, ‘PartCount’ is now ‘ProductCount’ and ‘NewPartCount’ is now ‘NewProductCount’ to better align our APIs with Digi-Key’s growing catalog.
  • In the ‘KitPart’ model, ‘Quantity’ is now ‘KitPartQuantity’ to differentiate it from other listed quantities.

Removed

  • XML support. Only JSON will be supported moving forward.
    – ‘IncludeAllAssociatedProducts’ and ‘IncludeAllForUseWithProducts’ inputs removed. All Associations and ForUseWith will return by default. Use the new optional ‘Includes’ header instead to limit their length like this example: “DigiKeyPartNumber,QuantityAvailable,AssociatedProducts[2]”.
  • ‘X-IBM-Client-Id’ was removed. Use new API header ‘X-DIGIKEY-Client-Id’ instead.
  • ‘X-DIGIKEY-Partner-Id’ header was removed.
  • ‘PartID’ was removed.
  • ‘PackageType’ was removed. ‘Packaging’ should be used instead.
  • ‘FactoryStock’ was removed. ‘ManufacturerPublicQuantity’ should be used instead.
  • ‘ResultCode’ was removed.
  • ‘Category’ and ‘Family’ were removed. ‘Taxonomy’ should be used instead.
  • ‘ChipOutpostPart’ was removed.
  • ‘PartUrl’ was removed. ‘ProductUrl’ should be used instead.
  • ‘RohsSubstitutions’ was removed from KeywordSearch.
  • ‘SuggestedSubs’ was removed from KeywordSearch.

Fixed

  • Fixed many typos.
  • Miscellaneous bug fixes and optimizations.

[Supplements]

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

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

 

 

PartSearch Changelog

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

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

[3.0.0] - 2019-10-01

Added

  • New API header ‘X-DIGIKEY-Client-Id’.
    • This replaces ‘X-IBM-Client-Id’.
  • New error message structure. This brings conformity to our APIs and consistent error formats to our customers.
  • Optional ‘Includes’ query parameter to specify which fields to return. This allows customization of the API response.
  • Added a filter for Taxonomies in KeywordSearch.

Changed

  • A concerted effort was made to unify naming/descriptions across all APIs.
  • HTTP codes have been cleaned up and unified across our APIs. This has led to some changed responses.
    • (i.e. 404 is now returned in PartDetails if a part cannot be found.)
    • As part of this, ‘Bad Request’ responses will now better explain invalid input.
  • The Authorization Header now needs the label "Bearer" and the text of the bearer/access token in the header

    • C# example:
      authenticationHeaderValue = new AuthenticationHeaderValue("Bearer", your bearer/access token);
      HttpClient.DefaultRequestHeaders.Authorization = authenticationHeaderValue;

  • Many descriptions across the API have been added, updated, or redone.
  • Operations without a large list of parameters have been changed to HTTP GET operations. URL encoding will be needed for parameters moved to the URL.
  • Order of elements in the responses have been reordered to aid manual testing.
  • ‘Part’ has been renamed to ‘Product’ across all APIs. This is to better align our APIs with DigiKey’s growing catalog.
  • The ‘PartDetails’ operation has been renamed to ‘ProductDetails’ to align with other renaming efforts.
  • ‘Vendor’ has been replaced with ‘Manufacturer’.
  • ‘LimitedFilterValues’ has been renamed to ‘FilterOptions’.
  • ‘RohsInfo’ has been renamed to ‘RohsStatus’.
  • ‘ExactMatches’ in the KeywordSearchResponse has been renamed to ‘ExactManufacturerResults’.
  • ‘ExactParts’ in the KeywordSearchResponse has been renamed to ‘ExactManufacturerProducts’.
  • ‘PartNumber’ in the DigiReelPricing input model has been renamed to ‘DigiKeyPartNumber’.
  • ‘Part’ in the PartDetails input model has been renamed to ‘DigiKeyPartNumber’.
  • ‘Quantity’ renamed to ‘RequestedQuantity’ to differentiate the count of the product vs the number of results returned.
  • ‘AvailableOnOrder’ renamed to ‘QuantityOnOrder’ to clarify that it is a quantity and not a status.
  • ‘SearchLocale’ has been renamed to ‘SearchLocaleUsed’ to make it clear what locale information was used in the request.
  • Shortened elements (i.e. ‘pid’, ‘vid’, or ‘dk’) have been expanded to their full name (i.e. ‘parameterId’, ‘valueId’, DigiKey).
  • Some additional model renaming has taken place.

Removed

  • XML support. Only JSON will be supported moving forward.
  • ‘Category’ and ‘Family’ were removed. ‘Taxonomy’ should be used instead.
  • Duplicate SearchOption ‘PbFreeOnly’ was removed. ‘LeadFree’ should be used instead.
  • ‘ChipOutpostPart’ was removed.
  • ‘BuyUrl’ was removed. ‘PartUrl’ should be used instead.
  • Duplicate field ‘Description’ in AssociatedProduct was removed. ‘ProductDescription’ should be used instead.
  • Unused response field ‘FilterValues’ was removed.
  • ‘RohsSubstitutions’ was removed from KeywordSearch.
  • ‘SuggestedSubs’ was removed from KeywordSearch.
  • ‘PartID’ was removed.
  • ‘X-IBM-Client-Id’ was removed.
  • ‘IncludeAllAssociatedProducts’ and ‘IncludeAllForUseWithProducts’ inputs removed. All Associations and ForUseWith will return by default. Instead use the new optional ‘includes’ header to limit their length like this example: “DigiKeyPartNumber,QuantityAvailable,AssociatedProducts[2]”

Fixed

  • Fixed many typos.
  • Miscellaneous bug fixes and optimizations.

[Supplements]

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

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

 

 

ProductChangeNotifications Changelog

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

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

[3.0.0] - 2019-06-20

Added

  • New API header ‘X-DIGIKEY-Client-Id’.
    • This replaces ‘X-IBM-Client-Id’.
  • New error message structure. This brings conformity to our APIs and consistent error formats to our customers.
  • Optional ‘Includes’ query parameter to specify which fields to return. This allows customization of the API response.

Changed

  • Routes have been changed to conform to RESTful best practices.
  • A concerted effort was made to unify naming/descriptions across all APIs.
  • HTTP codes have been cleaned up and unified across our APIs. This has led to some changed responses.
    • (i.e. 404 is now returned in ChangeNotifications if the part cannot be found.)
  • The Authorization Header now needs the label "Bearer" and the text of the bearer/access token in the header

    • C# example:
      authenticationHeaderValue = new AuthenticationHeaderValue("Bearer", your bearer/access token);
      HttpClient.DefaultRequestHeaders.Authorization = authenticationHeaderValue;

  • Many descriptions across the API have been added, updated, or redone.
  • ‘Part’ has been renamed to ‘Product’ across all APIs. This is to better align our APIs with DigiKey’s growing catalog.

Removed

  • XML support. Only JSON will be supported moving forward.
  • ‘X-IBM-Client-Id’ was removed.
  • Locale headers removed.

Fixed

  • Miscellaneous bug fixes and optimizations.

[Supplements]

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

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

 

 

RecommendedParts Changelog

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

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

[3.0.0] - 2019-06-20

Added

  • New API header ‘X-DIGIKEY-Client-Id’.
    • This replaces ‘X-IBM-Client-Id’.
  • New error message structure. This brings conformity to our APIs and consistent error formats to our customers.
  • Optional ‘Includes’ query parameter to specify which fields to return. This allows customization of the API response.
  • Added ‘X-DIGIKEY-Locale-ShipToCountry’ header.
  • Added ‘SearchLocaleUsed’ to the response.

Changed

  • A concerted effort was made to unify naming/descriptions across all APIs.
  • Many descriptions across the API have been added, updated, or redone.
  • The Authorization Header now needs the label "Bearer" and the text of the bearer/access token in the header

    • C# example:
      authenticationHeaderValue = new AuthenticationHeaderValue("Bearer", your bearer/access token);
      HttpClient.DefaultRequestHeaders.Authorization = authenticationHeaderValue;

  • Shortened elements (i.e. ‘pid’, ‘vid’, or ‘dk’) have been expanded to their full name (i.e. ‘parameterId’, ‘valueId’, DigiKey).
  • Some model renaming has taken place.
  • Order of elements in the responses have been reordered to aid manual testing.
  • ‘Part’ has been renamed to ‘Product’ across all APIs. This is to better align our APIs with Digi-Key’s growing catalog.
    • This includes model and field names containing ‘RecommendedParts’, which now contain ‘RecommendedProducts’ instead.
  • HTTP codes have been cleaned up and unified across our APIs. This has led to some changed responses.
    • (i.e. 404 is now returned if a product cannot be found.)
    • As part of this, ‘Bad Request’ responses will now better explain invalid input.
  • The ‘Recommended’ operation was renamed to ‘RecommendedProducts’ to better convey what the operation does.
  • The ‘RecommendedProducts’ (formerly ‘Recommended’) operation has been changed to an HTTP GET operation. URL encoding will be needed for parameters moved to the URL.
  • The ‘RecommendedProducts’ route changed from ‘recommendedparts/v2/recommended’ to ‘/Recommendations/v3/Products/{DigiKeyPartNumber}’ to better conform to RESTful standards.
    • Input parameter ‘PartNumber’ is now ‘DigiKeyPartNumber’ to differentiate it from the manufacturer part number.
  • ‘ImageUrl’ is now ‘PrimaryPhoto’ in the response to use more consistent terminology with our other APIs.
  • ‘CatalogDescription’ is now ‘ProductDescription’ in the response to use more consistent terminology with our other APIs.
  • ‘DetailPageUrl’ is now ‘ProductUrl’ in the response to use more consistent terminology with our other APIs.

Removed

  • XML support. Only JSON will be supported moving forward.
  • ‘X-IBM-Client-Id’ was removed. Use new API header ‘X-DIGIKEY-Client-Id’ instead.

Fixed

  • Fixed many typos.
  • Miscellaneous bug fixes and optimizations.

[Supplements]

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

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

  1. OrderDetails Changelog
  2. PackageTypeByQuantity Changelog
  3. PartSearch Changelog
  4. ProductChangeNotifications Changelog
  5. RecommendedParts Changelog