OrderDetails 变更日志

有关此项目的所有明显变更都会记录在此文件中。

格式基于保留变更日志 (Keep a Changelog),并且此项目遵循语义化版本控制 (Semantic Versioning)

[3.0.0] - 2019-10-01

新增

  • 新的 API 报头 'X-DIGIKEY-Client-Id'。
    • 这会替换 'X-IBM-Client-Id'。
  • 新的错误消息结构。 这使得我们的 API 能保持一致性,并为客户提供一致的错误格式。
  • 可选的 'Includes' 查询参数,用于指定要返回的字段。 这允许定制 API 响应。
  • 现在,订单状态返回订单中使用的货币。
  • 现在,除了缺货订单帐号,订单状态还返回托运人帐号。

变更

  • 订单状态和订单历史记录 API 已合并为一个订单明细 API。
  • 经过协调努力,统一了所有 API 中的命名/描述。
  • HTTP 代码已在我们的 API 中进行了清理和统一。
  • 添加、更新或重写了 API 的许多描述。
  • 现在,授权报头需要标签 "Bearer" 和报头中承载/访问令牌的文本。
    • C# 示例:
      authenticationHeaderValue = new AuthenticationHeaderValue("Bearer", your bearer/access token);
      HttpClient.DefaultRequestHeaders.Authorization = authenticationHeaderValue;

  • 简写元素(例如 'Addrline_1')已扩展为全名(例如 'AddressLineOne')。
  • 订单历史记录操作已合并为一个。 现在,包含公司订单是通过标志 'IncludeCompanyOrders',而非根 Id。
  • 关于根 Id 的语言已变更为指代公司。
  • 输入和输出中的日期不是 ISO 8601 格式的,已变更为该格式。
  • 大多数参数已变更为查询参数,以更好地与 RESTful API 标准保持一致。
  • 许多参数已变成可选参数,并将默认值设为合理的值。 例如,若未提供日期,则返回一个月的订单历史记录。
  • 'CarrierId’ 已变更为 'Carrier'。 承运人的内部代码已替换为承运人名称。
  • ShipmentType 的“标准”类型已替换为“立即”。
  • 为清楚起见并与 'QuantityShipped' 保持一致,'Backorder’ 已重命名为 'QuantityBackorder'。
  • 'Description’ 已重命名为 'ProductDescription' 以与 Partsearch V3 API 保持一致。
  • 'PartNumber’ 已重命名为 'DigiKeyPartNumber' 以说明其类型。 API 不会返回制造商零件编号。
  • 为清楚起见,'ShippingURL’ 已重命名为 'TrackingUrl'。
  • 'StateCode’ 已重命名为 ‘Province' 以与其它 API 保持一致。 如果在美国,仍会返回该州。
  • 'ZipCode’ 已重命名为 'PostalCode' 以与其它 API 保持一致。
  • 'CustomerNumber' 已重命名为 'CustomerId' 以与其它 API 保持一致。
  • 为清楚起见,'AccountNumber' 已重命名为 'BillingAccount'。
  • 'EmailAddress' 已重命名为 'Email' 以与其它 API 保持一致。
  • 为清楚起见,'OrderDetails' 已重命名为 'LineItems'。

移除

  • XML 支持。 今后将仅支持 JSON。
  • 已移除 'X-IBM-Client-Id'。
  • 订单状态不再需要 'CustomerId'。 它将根据您帐户上的所有客户 ID 自动检查订单。

修复

  • 更正错别字。
  • 其它错误修复和优化。

[补充]

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

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

 

 

PackageTypeByQuantity 变更日志

有关此项目的所有明显变更都会记录在此文件中。

格式基于保留变更日志 (Keep a Changelog),并且此项目遵循语义化版本控制 (Semantic Versioning)

[3.0.0] - 2019/6/20

新增

  • 新的 API 报头 'X-DIGIKEY-Client-Id'。
    • 这会替换 'X-IBM-Client-Id'。
  • 新的错误消息结构。 这为我们的 API 带来一致性,并为客户提供一致的错误格式。
  • 可选的 'Includes' 查询参数,用于指定要返回的字段。 这允许定制 API 响应。
  • 在响应中已添加 'QuantityOnOrder'。
  • 在响应中已添加 'DateLastBuyChance'。

变更

  • 经过协调努力,统一了所有 API 中的命名/描述。
  • 添加、更新或重写了 API 的许多描述。
  • 现在,授权报头需要标签 "Bearer" 和报头中承载/访问令牌的文本。
    • C# 示例:
      authenticationHeaderValue = new AuthenticationHeaderValue("Bearer", your bearer/access token);
      HttpClient.DefaultRequestHeaders.Authorization = authenticationHeaderValue;

  • 简写元素(例如 'pid'、'vid' 或 'dk')已扩展为其全名(例如 'parameterId'、'valueId'、'DigiKey')。
  • 一些模型命名发生了细微变化。
  • 响应中元素的顺序已重新排序以帮助进行手动测试。
  • 所有 API 中的 'Part' 皆重命名为 'Product'。 这是为了让我们的 API 与 Digi-Key 不断增长的产品目录更好地保持一致。
  • HTTP 代码已在我们的 API 中进行了清理和统一。 这导致一些响应发生改变。
    • (例如,现在若找不到零件,则返回 404。)
    • 其结果是,'Bad Request' 响应现在能够更好地解释无效输入。
  • 缩写 'PkgTypeByQty’ 已扩展为 'PackageTypeByQuantity' 以提高清晰性。
  • 'Search' 操作已重命名为 'PackageTypeByQuantity' 以更好地表达该操作的作用。
  • 'PackageTypeByQuantity'(以前称为 'Search')操作已变更为 HTTP GET 操作。 参数移动到 URL 时需要 URL 编码。
  • 'PackageTypeByQuantity' 路由从 "services/packagetypebyquantity/v2/search" 变为 "PackageTypeByQuantity/v3/Products/{DigiKeyPartNumber}",以更好地与 RESTful 标准保持一致。
    • 重命名的输入参数包括 'DigiKeyPartNumber'、'PackagingPreference'、'RequestedQuantity'。
    • 已添加 'Includes' 输入参数。
  • 请求中的 'PartNumber’ 已重命名为 'DigiKeyPartNumber' 以区别于制造商零件编号。
  • 请求中的 'PartPreference’ 已重命名为 'PackagingPreference',以表明其指定的是封装类型偏好,而非零件。
  • 请求中的 'Quantity’ 已重命名为 'RequestedQuantity',以区分产品数量和返回的结果数量。
  • 响应中的 'Parts’ 已重命名为 'Products',以使我们的 API 与 Digi-Key 不断增长的产品目录更好地保持一致。
  • 'PackageTypeByQuantityPart' 模型已重命名为 'PackageTypeByQuantityProduct',以使我们的 API 与 Digi-Key 不断增长的产品目录更好地保持一致。
    • 'PackageTypeByQuantityPart' 模型与我们 PartSearch API 中的 'ProductDetails' 模型匹配,并且包含一个额外的 'RecommendedQuantity' 字段。
  • 响应中的 'Quantity’ 已重命名为 'RecommendedQuantity',以区别于其它列出的数量。
  • 响应中的 'QuantityOnHand’ 已重命名为 'QuantityAvailable' 以使用更标准的术语。
  • 响应中的 'ManufacturerName’ 已重命名为 'Manufacturer',现在包括 parameterId 和 valueId 以与其它模型保持一致。
  • 现在,响应中的 'ManufacturerPageUrl' 返回完整 URL,不再返回待附加到主机的路径。
  • 响应中的 'ManfacturerPublicQuantity’ 已重命名为 'ManufacturerPublicQuantity' 以更正拼写错误。
  • 响应中的 'BuyUrl’ 已重命名为 'ProductUrl' 以使用更一致的术语。
  • 响应中的 'PartStatus’ 已重命名为 'ProductStatus',以使我们的 API 与 Digi-Key 不断增长的产品目录更好地保持一致。
  • 响应中的 'RohsInfo’ 已重命名为 'RoHSStatus' 以使用更一致的术语。
  • 响应中的 'AvailableOnOrder’ 已重命名为 'QuantityOnOrder',以表明其为数量而非状态。
  • 现在,'AlternatePackaging' 是 BasicProduct,而非 AssociatedProduct。
  • 'SearchLocale' 模型已替换为 'IsoSearchLocale' 以遵循 ISO 标准。
  • 响应中的 'SearchLocale’ 已重命名为 'SearchLocaleUsed',以明确请求中使用的是此区域设置信息。
  • 在 'LimitedTaxonomy' 模型中,'PartCount' 现在是 'ProductCount','NewPartCount' 现在是 'NewProductCount',以使我们的 API 与 Digi-Key 不断增长的产品目录更好地保持一致。
  • 在 'KitPart' 模型中,'Quantity' 现在是 'KitPartQuantity',以区别于其它列出的数量。

移除

  • XML 支持。 今后将仅支持 JSON。
    – 已移除 'IncludeAllAssociatedProducts' 和 'IncludeAllForUseWithProducts' 输入。 默认会返回所有 Associations 和 ForUseWith。 改用新的可选 'Includes' 报头来限制其长度,示例如下:"DigiKeyPartNumber,QuantityAvailable,AssociatedProducts[2]"。
  • 已移除 'X-IBM-Client-Id'。 改用新的 API 报头 'X-DIGIKEY-Client-Id'。
  • 已移除 'X-DIGIKEY-Partner-Id' 报头。
  • 已移除 'PartID'。
  • 已移除 'PackageType'。 应改用 'Packaging'。
  • 已移除 'FactoryStock'。 应改用 'ManufacturerPublicQuantity'。
  • 已移除 'ResultCode'。
  • 已移除 'Category' 和 'Family'。 应改用 'Taxonomy'。
  • 已移除 'ChipOutpostPart'。
  • 已移除 'PartUrl'。 应改用 'ProductUrl'。
  • 已从 KeywordSearch 中移除 'RohsSubstitutions'。
  • 已从 KeywordSearch 中移除 'SuggestedSubs'。

修复

  • 更正许多错别字。
  • 其它错误修复和优化。

[补充]

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

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

 

 

PartSearch 变更日志

有关此项目的所有明显变更都会记录在此文件中。

格式基于保留变更日志 (Keep a Changelog),并且此项目遵循语义化版本控制 (Semantic Versioning)

[3.0.0] - 2019-10-01

新增

  • 新的 API 报头 'X-DIGIKEY-Client-Id'。
    • 这会替换 'X-IBM-Client-Id'。
  • 新的错误消息结构。 这为我们的 API 带来一致性,并为客户提供一致的错误格式。
  • 可选的 'Includes' 查询参数,用于指定要返回的字段。 这允许定制 API 响应。
  • 在 KeywordSearch 中已添加 Taxonomies 筛选器。

变更

  • 经过协调努力,统一了所有 API 中的命名/描述。
  • HTTP 代码已在我们的 API 中进行了清理和统一。 这导致一些响应发生改变。
    • (例如,现在若找不到零件,则在 PartDetails 中返回 404。)
    • 其结果是,'Bad Request' 响应现在能够更好地解释无效输入。
  • 现在,授权报头需要标签 "Bearer" 和报头中承载/访问令牌的文本。
    • C# 示例:
      authenticationHeaderValue = new AuthenticationHeaderValue("Bearer", your bearer/access token);
      HttpClient.DefaultRequestHeaders.Authorization = authenticationHeaderValue;

  • 添加、更新或重写了 API 的许多描述。
  • 不涉及大量参数的操作已变更为 HTTP GET 操作。 参数移动到 URL 时需要 URL 编码。
  • 响应中元素的顺序已重新排序以帮助进行手动测试。
  • 所有 API 中的 'Part' 皆重命名为 'Product'。 这是为了让我们的 API 与 DigiKey 不断增长的产品目录更好地保持一致。
  • 'PartDetails' 操作已重命名为 'ProductDetails',以与其它重命名工作保持一致。
  • 'Vendor' 已替换为 'Manufacturer'。
  • 'LimitedFilterValues’ 已重命名为 'FilterOptions'。
  • 'RohsInfo’ 已重命名为 'RohsStatus'。
  • KeywordSearchResponse 中的 'ExactMatches’ 已重命名为 'ExactManufacturerResults'。
  • KeywordSearchResponse 中的 'ExactParts’ 已重命名为 'ExactManufacturerProducts'。
  • DigiReelPricing 输入模型中的 'PartNumber’ 已重命名为 'DigiKeyPartNumber'。
  • PartDetails 输入模型中的 'Part’ 已重命名为 'DigiKeyPartNumber'。
  • 'Quantity’ 已重命名为 'RequestedQuantity',以区分产品数量和返回的结果数量。
  • 'AvailableOnOrder’ 已重命名为 'QuantityOnOrder',以表明其为数量而非状态。
  • 'SearchLocale’ 已重命名为 'SearchLocaleUsed',以明确请求中使用的是此区域设置信息。
  • 简写元素(例如 'pid'、'vid' 或 'dk')已扩展为其全名(例如 'parameterId'、'valueId'、'DigiKey')。
  • 还对其它一些模型进行了重命名。

移除

  • XML 支持。 今后将仅支持 JSON。
  • 已移除 'Category' 和 'Family'。 应改用 'Taxonomy'。
  • 已移除重复的 SearchOption 'PbFreeOnly'。 应改用 'LeadFree'。
  • 已移除 'ChipOutpostPart'。
  • 已移除 'BuyUrl'。 应改用 'PartUrl'。
  • 已移除 AssociatedProduct 中的重复字段 'Description'。 应改用 'ProductDescription'。
  • 已移除未使用的响应字段 'FilterValues'。
  • 已从 KeywordSearch 中移除 'RohsSubstitutions'。
  • 已从 KeywordSearch 中移除 'SuggestedSubs'。
  • 已移除 'PartID'。
  • 已移除 'X-IBM-Client-Id'。
  • 已移除 'IncludeAllAssociatedProducts' 和 'IncludeAllForUseWithProducts' 输入。 默认会返回所有 Associations 和 ForUseWith。 改用新的可选 'includes' 报头来限制其长度,示例如下:"DigiKeyPartNumber,QuantityAvailable,AssociatedProducts[2]"

修复

  • 更正许多错别字。
  • 其它错误修复和优化。

[补充]

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

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

 

 

ProductChangeNotifications 变更日志

有关此项目的所有明显变更都会记录在此文件中。

格式基于保留变更日志 (Keep a Changelog),并且此项目遵循语义化版本控制 (Semantic Versioning)

[3.0.0] - 2019/6/20

新增

  • 新的 API 报头 'X-DIGIKEY-Client-Id'。
    • 这会替换 'X-IBM-Client-Id'。
  • 新的错误消息结构。 这为我们的 API 带来一致性,并为客户提供一致的错误格式。
  • 可选的 'Includes' 查询参数,用于指定要返回的字段。 这允许定制 API 响应。

变更

  • 路由已更改,以符合 RESTful 最佳实践。
  • 经过协调努力,统一了所有 API 中的命名/描述。
  • HTTP 代码已在我们的 API 中进行了清理和统一。 这导致一些响应发生改变。
    • (例如,现在若找不到零件,则在 ChangeNotifications 中返回 404。)
  • 现在,授权报头需要标签 "Bearer" 和报头中承载/访问令牌的文本。
    • C# 示例:
      authenticationHeaderValue = new AuthenticationHeaderValue("Bearer", your bearer/access token);
      HttpClient.DefaultRequestHeaders.Authorization = authenticationHeaderValue;

  • 添加、更新或重写了 API 的许多描述。
  • 所有 API 中的 'Part' 皆重命名为 'Product'。 这是为了让我们的 API 与 DigiKey 不断增长的产品目录更好地保持一致。

移除

  • XML 支持。 今后将仅支持 JSON。
  • 已移除 'X-IBM-Client-Id'。
  • 已移除 Locale 报头。

修复

  • 其它错误修复和优化。

[补充]

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

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

 

 

RecommendedParts 变更日志

有关此项目的所有明显变更都会记录在此文件中。

格式基于保留变更日志 (Keep a Changelog),并且此项目遵循语义化版本控制 (Semantic Versioning)

[3.0.0] - 2019/6/20

新增

  • 新的 API 报头 'X-DIGIKEY-Client-Id'。
    • 这会替换 'X-IBM-Client-Id'。
  • 新的错误消息结构。 这为我们的 API 带来一致性,并为客户提供一致的错误格式。
  • 可选的 'Includes' 查询参数,用于指定要返回的字段。 这允许定制 API 响应。
  • 已添加 'X-DIGIKEY-Locale-ShipToCountry' 报头。
  • 在响应中已添加 'SearchLocaleUsed'。

变更

  • 经过协调努力,统一了所有 API 中的命名/描述。
  • 添加、更新或重写了 API 的许多描述。
  • 现在,授权报头需要标签 "Bearer" 和报头中承载/访问令牌的文本。
    • C# 示例:
      authenticationHeaderValue = new AuthenticationHeaderValue("Bearer", your bearer/access token);
      HttpClient.DefaultRequestHeaders.Authorization = authenticationHeaderValue;

  • 简写元素(例如 'pid'、'vid' 或 'dk')已扩展为其全名(例如 'parameterId'、'valueId'、'DigiKey')。
  • 对一些模型进行了重命名。
  • 响应中元素的顺序已重新排序以帮助进行手动测试。
  • 所有 API 中的 'Part' 皆重命名为 'Product'。 这是为了让我们的 API 与 Digi-Key 不断增长的产品目录更好地保持一致。
    • 这包括含有 'RecommendedParts' 的模型和字段名称,现在改为含有 'RecommendedProducts'。
  • HTTP 代码已在我们的 API 中进行了清理和统一。 这导致一些响应发生改变。
    • (例如,现在若找不到产品,则返回 404。)
    • 其结果是,'Bad Request' 响应现在能够更好地解释无效输入。
  • 'Recommended' 操作已重命名为 'RecommendedProducts' 以更好地表达该操作的作用。
  • 'RecommendedProducts'(以前称为 'Recommended')操作已变更为 HTTP GET 操作。 参数移动到 URL 时需要 URL 编码。
  • 'RecommendedProducts' 路由已从 'recommendedparts/v2/recommended' 变为 '/Recommendations/v3/Products/{DigiKeyPartNumber}',以更好地与 RESTful 标准保持一致。
    • 现在,输入参数 'PartNumber' 变为 'DigiKeyPartNumber',以区别于制造商零件编号。
  • 现在,响应中的 'ImageUrl' 变为 'PrimaryPhoto',以使用与我们的其它 API 更一致的术语。
  • 现在,响应中的 'CatalogDescription' 变为 'ProductDescription',以使用与我们的其它 API 更一致的术语。
  • 现在,响应中的 'DetailPageUrl' 变为 'ProductUrl',以使用与我们的其它 API 更一致的术语。

移除

  • XML 支持。 今后将仅支持 JSON。
  • 已移除 'X-IBM-Client-Id'。 改用新的 API 报头 'X-DIGIKEY-Client-Id'。

修复

  • 更正许多错别字。
  • 其它错误修复和优化。

[补充]

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

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