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は、1つのAPI「ご注文の詳細」に統合されました。
- すべてのAPIの名前や説明を統一するために、協調した取り組みが行われました。
- HTTPコードがクリーンアップされ、API全体で統合されました。
- APIの説明が大幅に追加、更新、または再作成されました。
- authorizationHeader（承認ヘッダー）には、「Bearer」というラベルとベアラー/アクセストークンのテキストが必要になりました。
-
C＃の例：
authenticationHeaderValue = new AuthenticationHeaderValue("Bearer", <ベアラー/アクセストークン>);
HttpClient.DefaultRequestHeaders.Authorization = authenticationHeaderValue;
-
- 短縮されていた要素（例： 「Addrline_1」）がフルネームに展開されました（つまり 「AddressLineOne」）。
- 「発注履歴」に関する複数の操作が1つに統合されました。 会社からの発注追加は、ルートIDではなくフラグ「IncludeCompanyOrders」を使用するように変更されました。
- ルートIDに関するプログラミング表現が、会社を指すように変更されました。
- 入力日と出力日の形式が、以前とは異なるISO 8601形式に変更されました。
- RESTful API標準との整合性を高めるために、ほとんどのパラメータがクエリパラメータに変更されました。
- 多くのパラメータには任意の値を指定できますが、指定しなかった場合でも適切な値になります。 たとえば、日付を指定しなかった場合でも、注文履歴は1か月分が表示されます。
- 「CarrierId」が「Carrier」に変更されました。 キャリアの内部コードはキャリア名に置き換えられました。
- ShipmentTypeが「Standard」から「Immediate」に変更されました。
- 「Backorder」の名前は、「QuantityShipped」に合わせるために「QuantityBackorder」に変更されました。
- 「Description」の名前は、Partsearch V3 APIに一致するように「ProductDescription」に変更されました。
- 「PartNumber」の名前は、部品タイプを明確にするために「DigiKeyPartNumber」に変更されました。 APIはメーカー品番を返しません。
- 「ShippingURL」の名前は「TrackingUrl」に変更されました。
- 「StateCode」の名前は、他のAPIと一致するように「Province」（県）に変更されました。 米国の場合、引き続き州が出力されます。
- 「ZipCode」の名前は、他のAPIと一致するように「PostalCode」に変更されました。
- 「CustomerNumber」の名前は、他のAPIと一致するように「CustomerId」に変更されました。
- 「AccountNumber」の名前は、わかりやすくするために「BillingAccount」に変更されました。
- 「EmailAddress」の名前は、他のAPIと一致するように「Email」に変更されました。
- 「OrderDetails」の名前は、わかりやすくするために「LineItems」に変更されました。
削除/終了
- XMLのサポートは終了しました。 今後はJSONのみがサポートされます。
- 「X-IBM-Client-Id」が削除されました。
- 「発注状況確認」では「CustomerId」は不要になりました。 「発注状況確認」では、お客様の発注が、ご使用アカウントに登録されているすべてのCustomerIdと自動的に照合されます。
修正済み
- タイプミスを修正しました。
- その他のバグ修正と最適化を行いました。
[補足]
[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-06-20
追加
- 新しいAPIヘッダー「X-DIGIKEY-Client-Id」
- 「X-IBM-Client-Id」が上記のヘッダーへと変更されます。
- エラーメッセージ構造を新しくすることにより、 APIへの適合性を持たせ、一貫性のあるエラー形式を返します。
- オプションのクエリパラメータ「Includes」を使用して、返すフィールドの指定が可能になりました。 これにより、APIのレスポンスをカスタマイズできます。
- レスポンスに「QuantityOnOrder」を追加しました。
- レスポンスに「DateLastBuyChance」を追加しました。
変更
- すべてのAPIの名前や説明を統一するために、協調した取り組みが行われました。
- APIの説明が大幅に追加、更新、または再作成されました。
- authorizationHeader（承認ヘッダー）には、「Bearer」というラベルとベアラー/アクセストークンのテキストが必要になりました。
-
C＃の例：
authenticationHeaderValue = new AuthenticationHeaderValue("Bearer", <ベアラー/アクセストークン>);
HttpClient.DefaultRequestHeaders.Authorization = authenticationHeaderValue;
-
- 短縮された要素（つまり、「pid」、「vid」、または「dk」）が、フルネーム（つまり、「parameterId」、「valueId」、DigiKey）に展開されました。
- 若干のモデル名の変更が行われました。
- 手動テストを支援するため、レスポンスにおける要素間の順序が並べ替えられました。
- 「Part」の名前は、すべてのAPIで「Product」に変更されました。 これは、Digi-Keyの増大するカタログと本APIとの整合性を高めるためです。
- HTTPコードがクリーンアップされ、API全体で統一されました。 これにより、いくつかのレスポンスが変更されました。
- （例：部品が見つからない場合は、404が返されるようになりました。）
- この一環として、無効な入力に対し、レスポンス「Bad Request」が返されるようになりました。
- 短縮形の「PkgTypeByQty」は、わかりやすくするために「PackageTypeByQuantity」と展開されました。
- 操作名「Search」は、操作内容がわかりやすくなるように「PackageTypeByQuantity」に変更されました。
- 「PackageTypeByQuantity」（以前の「Search」）操作がHTTP GET操作に変更されました。 URLに受け渡しされるパラメータのURLエンコードが必要になります。
- RESTful標準への準拠を強化するため、「PackageTypeByQuantity」ルートが「services/packagetypebyquantity/v2/search」から「PackageTypeByQuantity/v3/Products/\{DigiKeyPartNumber}」に変更されました。
- 名前が変更された入力パラメーターは、「DigiKeyPartNumber」、「PackagingPreference」、「RequestedQuantity」です。
- 入力パラメータ「Includes」が追加されました。
- リクエスト内の「PartNumber」の名前は、メーカー品番と区別するために「DigiKeyPartNumber」に変更されました。
- リクエスト内の「PartPreference」の名前は、部品でなくパッケージタイプの設定が指定されていることを明確にするために「PackagingPreference」に変更されました。
- リクエスト内の「Quantity」の名前は、製品の数と返された結果の数を区別するために「RequestedQuantity」に変更されました。
- レスポンス内の「Parts」の名前は、Digi-Keyの増大するカタログと本APIとの整合性を高めるために「Products」に変更されました。
- 「PackageTypeByQuantityPart」のモデル名は、Digi-Keyの増大するカタログと本APIとの整合性を高めるために「PackageTypeByQuantityProduct」に変更されました。
- 「PackageTypeByQuantityPart」モデルは、当社のPartSearch APIの「ProductDetails」モデルと一致させるために「RecommendedQuantity」フィールドが追加されました。
- レスポンス内の「Quantity」の名前は、リストされた他の数量と区別するために「RecommendedQuantity」に変更されました。
- レスポンス内の「QuantityOnHand」の名前は、より標準的な用語として「QuantityAvailable」に変更されました。
- レスポンス内の「ManufacturerName」の名前は、「Manufacturer」に変更され、他のモデルと一致するようにparameterIdとvalueIdが追加されました。
- レスポンス内の「ManufacturerPageUrl」の名前は、ホストに追加すべきパスを返さなくなり、完全なURLを返すようになりました。
- レスポンス内の「ManfacturerPublicQuantity」の名前は、スペルミスを修正するために「ManufacturerPublicQuantity」に変更されました。
- レスポンス内の「BuyUrl」の名前は、より一貫性のある用語として「ProductUrl」に変更されました。
- レスポンス内の「PartStatus」の名前は、Digi-Keyの増大するカタログと本APIとの整合性を高めるために「ProductStatus」に変更されました。
- レスポンス内の「RohsInfo」の名前は、より一貫性のある用語として「RoHSStatus」に変更されました。
- レスポンス内の「AvailableOnOrder」の名前は、状況でなく数量であることを明確にするために「QuantityOnOrder」に変更されました。
- 「AlternatePackaging」は、AssociatedProductではなくBasicProductになりました。
- 「SearchLocale」モデルは、ISO規格に従うため、「IsoSearchLocale」に変更されました。
- レスポンス内の「SearchLocale」の名前は、このロケール情報がリクエスト内で使用されたことを明確にするために「SearchLocaleUsed」に変更されました。
- 「LimitedTaxonomy」モデルでは、Digi-Keyの増大するカタログと本APIとの整合性を高めるために「PartCount」が「ProductCount」になり、「NewPartCount」が「NewProductCount」に変更されました。
- 「KitPart」モデルでは、「Quantity」が、リストされた他の数量と区別するために「KitPartQuantity」に変更されました。
削除/終了
- XMLのサポートは終了しました。 今後はJSONのみがサポートされます。
– 入力「IncludeAllAssociatedProducts」と「IncludeAllForUseWithProducts」が削除されました。 このため、すべての関連製品と併用品がデフォルトで返されます。 これらの文字列の長さを制限するには、これらの入力の代わりに、次の例のように新しいオプションの「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」を使用してください。
- 「RohsSubstitutions」がKeywordSearchから削除されました。
- 「SuggestedSubs」がKeywordSearchから削除されました。
修正済み
- 多くのタイプミスを修正しました。
- その他のバグ修正と最適化を行いました。
[補足]
[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」が返されるようになりました。
- authorizationHeader（承認ヘッダー）には、「Bearer」というラベルとベアラー/アクセストークンのテキストが必要になりました。
-
C＃の例：
authenticationHeaderValue = new AuthenticationHeaderValue("Bearer", <ベアラー/アクセストークン>);
HttpClient.DefaultRequestHeaders.Authorization = authenticationHeaderValue;
-
- APIの説明が大幅に追加、更新、または再作成されました。
- パラメータの大きなリストがない場合の操作は、HTTP GET操作に変更されます。 URLに受け渡しされるパラメータのURLエンコードが必要になります。
- 手動テストを支援するため、レスポンスにおける要素間の順序が並べ替えられました。
- 「Part」の名前は、すべてのAPIで「Product」に変更されました。 これは、Digi-Keyの増大するカタログと本APIとの整合性を高めるためです。
- 操作名「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」が削除されました。
- 「RohsSubstitutions」がKeywordSearchから削除されました。
- 「SuggestedSubs」がKeywordSearchから削除されました。
- 「PartID」が削除されました。
- 「X-IBM-Client-Id」が削除されました。
- 入力「IncludeAllAssociatedProducts」と「IncludeAllForUseWithProducts」が削除されました。 このため、すべての関連製品と併用品がデフォルトで返されます。 これらの文字列の長さを制限するには、これらの入力の代わりに、次の例のように新しいオプションの「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-06-20
追加
- 新しいAPIヘッダー「X-DIGIKEY-Client-Id」
- 「X-IBM-Client-Id」が上記のヘッダーへと変更されます。
- エラーメッセージ構造を新しくすることにより、 APIへの適合性を持たせ、一貫性のあるエラー形式を返します。
- オプションのクエリパラメータ「Includes」を使用して、返すフィールドの指定が可能になりました。 これにより、APIのレスポンスをカスタマイズできます。
変更
- ルートが、RESTfulのベストプラクティスに準拠するように変更されました。
- すべてのAPIの名前や説明を統一するために、協調した取り組みが行われました。
- HTTPコードがクリーンアップされ、API全体で統一されました。 これにより、いくつかのレスポンスが変更されました。
- （例：部品が見つからない場合は、ChangeNotificationsに404が返されるようになりました。）
- authorizationHeader（承認ヘッダー）には、「Bearer」というラベルとベアラー/アクセストークンのテキストが必要になりました。
-
C＃の例：
authenticationHeaderValue = new AuthenticationHeaderValue("Bearer", <ベアラー/アクセストークン>);
HttpClient.DefaultRequestHeaders.Authorization = authenticationHeaderValue;
-
- APIの説明が大幅に追加、更新、または再作成されました。
- 「Part」の名前は、すべてのAPIで「Product」に変更されました。 これは、Digi-Keyの増大するカタログと本APIとの整合性を高めるためです。
削除/終了
- XMLのサポートを終了しました。 今後はJSONのみがサポートされます。
- 「X-IBM-Client-Id」が削除されました。
- ロケールヘッダーが削除されました。
修正済み
- その他のバグ修正と最適化を行いました。
[補足]
[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-06-20
追加
- 新しいAPIヘッダー「X-DIGIKEY-Client-Id」
- 「X-IBM-Client-Id」が上記のヘッダーへと変更されます。
- エラーメッセージ構造を新しくすることにより、 APIへの適合性を持たせ、一貫性のあるエラー形式を返します。
- オプションのクエリパラメータ「Includes」を使用して、返すフィールドの指定が可能になりました。 これにより、APIのレスポンスをカスタマイズできます。
- 「X-DIGIKEY-Locale-ShipToCountry」ヘッダーを追加しました。
- レスポンスに「SearchLocaleUsed」を追加しました。
変更
- すべてのAPIの名前や説明を統一するために、協調した取り組みが行われました。
- APIの説明が大幅に追加、更新、または再作成されました。
- authorizationHeader（承認ヘッダー）には、「Bearer」というラベルとベアラー/アクセストークンのテキストが必要になりました。
-
C＃の例：
authenticationHeaderValue = new AuthenticationHeaderValue("Bearer", <ベアラー/アクセストークン>);
HttpClient.DefaultRequestHeaders.Authorization = authenticationHeaderValue;
-
- 短縮された要素（つまり、「pid」、「vid」、または「dk」）が、フルネーム（つまり、「parameterId」、「valueId」、DigiKey）に展開されました。
- いくつかのモデルの名前変更が行われました。
- 手動テストを支援するため、レスポンスにおける要素間の順序が並べ替えられました。
- 「Part」の名前は、すべてのAPIで「Product」に変更されました。 これは、Digi-Keyの増大するカタログと本APIとの整合性を高めるためです。
- この名前変更対象には「RecommendedParts」を使用するモデル名とフィールド名も含まれるため、それらでは代わりに「RecommendedProducts」が使用されるようになりました。
- HTTPコードがクリーンアップされ、API全体で統一されました。 これにより、いくつかのレスポンスが変更されました。
- （例：製品が見つからない場合は、404が返されるようになりました。）
- この一環として、無効な入力に対し、レスポンス「Bad Request」が返されるようになりました。
- 操作名「Recommended」は、操作の内容がわかりやすくなるように「RecommendedProducts」に変更されました。
- 「RecommendedProducts」（以前の「Recommended」）操作がHTTP GET操作に変更されました。 URLに受け渡しされるパラメータのURLエンコードが必要になります。
- RESTful標準への準拠を強化するために、「RecommendedProducts」ルートは「recommendedparts/v2/recommended」から「/Recommendations/v3/Products/{DigiKeyPartNumber}」に変更されました。
- 入力パラメータ「PartNumber」は、メーカー品番と区別するために「DigiKeyPartNumber」に変更されました。
- レスポンス内の「ImageUrl」は、他APIと一貫性のある用語を使用するために「PrimaryPhoto」に変更されました。
- レスポンス内の「CatalogDescription」は、他APIと一貫性のある用語を使用するために「ProductDescription」に変更されました。
- レスポンス内の「DetailPageUrl」は、他APIと一貫性のある用語を使用するために「ProductUrl」に変更されました。
削除/終了
- XMLのサポートは終了しました。 今後はJSONのみがサポートされます。
- 「X-IBM-Client-Id」が削除されました。 この代わりとして、新しいAPIヘッダー「X-DIGIKEY-Client-Id」を使用してください。
修正済み
- 多くのタイプミスを修正しました。
- その他のバグ修正と最適化を行いました。