はじめに
Welcome to the Online Components API Suite! Follow these steps to get started:
認証
To access the Online Components APIs, you'll need an API key. You can obtain both production and sandbox API keys from the same location:
- 顧客プロフィールに移動します
- API アクセスとサービスに移動
- APIキーをリクエスト
Log in to your Online Components account and go to your customer profile
Under the customer profile, locate the section labeled "API Access and Services." You can also directly click here to access the API Access and Services page
新しい支店を追加
サンドボックス環境
本番稼働前のテストの重要性を理解しています。そのため、本番データに影響を与えることなくすべての API を試せる、完全に機能する sandbox 環境を提供しています。
Sandbox へのアクセス
- Sandbox API キーのリクエスト
- 別のベース URL
- https://api.onlinecomponents.com
- https://sandbox.onlinecomponents.com
- サンドボックス開発者ポータル
Request your Sandbox API Key from the API Access and Services page. This key is distinct from your production key and is used exclusively for sandbox testing.
API エンドポイントは同じままですが、サンドボックス環境では別のベース URL が使用されます。
Access the sandbox environment through the Sandbox Developer Portal. Here, you'll find all the necessary documentation, tools, and support to help you effectively test your integration
Search API
The Onlinecomponents.com Search API is a powerful, yet easy, way to gain access to and utilise Onlinecomponents.com product data, availability and pricing in your own applications
説明
The Search API service allows customers to utilise Onlinecomponents.com product data, availability, and pricing in their own applications. Search over 8 million products and detailed product information with ease. JSON Data Format is now available for Onlinecomponents.com Search API
-
We have a new version of Search API that is faster and more flexible:
- JSON はよりクリーンな応答データでより高速な処理を提供します
- データ形式はより整理され、最新のブラウザーで表示しやすくなります
- API バージョン管理: リクエストとレスポンスは JSON または XML で利用できます
特徴
- タグライン
- キーワードによる検索方法
- Part Number による検索方法
- 1 回の呼び出しで最大 50 件の結果が返されます
- 1 分あたり最大 100 回の呼び出し
- 顧客電話番号#
データあり
- Product Id
- Part Number
- Manufacturer Name
- Description
- Datasheet Url
- Product Url
- Part Image
- Quantity Available
- On Order Quantity
- Factory Stock Quantity
- Factory Lead Time
- Availability
- Package Quantity
- Package Cross Quantity
- Product Sub Category
- Product Status
- RoHS
- Min Order Quantity
- Package Type
- Package Cross
- Multiple
- Unit Of Measure
- COO
- ECCN
- PRC
- HTS
- Main Category
- Sub Category
- Taxonomy
- Product Life Cycle
- Available less than min
- Alternative Parts
- Prices
エンドポイント
注文 API
Onlinecomponents.com のチェックアウトプロセスにアクセスし、ご自身のアプリケーション内で部品を注文できます。
説明
Order API は、Onlinecomponents.com で注文を行い確認するために使用できます。Pricing and Availability API と併用することを想定しています。より高速で柔軟な新バージョンの Order API があります:
- JSON はよりクリーンな応答データでより高速な処理を提供します
- データ形式はより整理され、最新のブラウザーで表示しやすくなります
- API バージョン管理: リクエストとレスポンスは JSON または XML で利用できます
エンドポイント
Order API は、Onlinecomponents.com で注文を行い確認するために使用できます。Pricing and Availability API と組み合わせて使用することを意図しています。
リクエストパラメーター
| パラメーター | 説明 | 必須 |
|---|---|---|
| メール | はい | |
| firstName | 名 | はい |
| lastName | 姓 | はい |
| phoneNumber | 電話番号 | はい |
| shippingMethod | はい | |
| accountNo | 配送アカウント番号 | はい |
| carrier | いいえ | |
| shippingInsurance | はい | |
| taxable | はい | |
| resaleNumber | いいえ | |
| shippingAddress | 配送先住所 | はい |
| shippingAddress.firstName | 名 | はい |
| shippingAddress.lastName | 姓 | はい |
| shippingAddress.company | 会社 | はい |
| shippingAddress.countryTwoletterISOCode | 国 | はい |
| shippingAddress.stateProvinceAbbreviation | 州 | はい |
| shippingAddress.city | 市 | はい |
| shippingAddress.address1 | 住所 1 | はい |
| shippingAddress.address2 | 住所 2 | はい |
| shippingAddress.zipPostalCode | Zip / 郵便番号 | はい |
| shippingAddress.phoneNumber | 電話番号 | はい |
| billingAddress | 4. アプリの名前を入力してクリックします | はい |
| billingAddress.firstName | 名 | はい |
| billingAddress.lastName | 姓 | はい |
| billingAddress.company | 会社 | はい |
| billingAddress.countryTwoletterISOCode | 国 | はい |
| billingAddress.stateProvinceAbbreviation | 州 | はい |
| billingAddress.city | 市 | はい |
| billingAddress.address1 | 住所 1 | はい |
| billingAddress.address2 | 住所 2 | はい |
| billingAddress.zipPostalCode | Zip / 郵便番号 | はい |
| billingAddress.phoneNumber | 電話番号 | はい |
| paymentMethod | 支払い方法 | はい |
|
CustomerPoNumber
|
no | |
| orderComment | 注文コメント | いいえ |
| orderItem | はい | |
| orderItem.productId | 注文明細識別子 | はい |
| orderItem.partNumber | いいえ | |
| orderItem.manufacturerName | いいえ | |
| orderItem.quantity | 数量 | はい |
| orderItem.price | 価格 | いいえ |
| orderItem.customerpartnumber | 顧客部品番号 | いいえ |
| currencycode | 通貨コード | いいえ |
リクエスト例
{
"email": "string",
"firstName": "string",
"lastName": "string",
"phoneNumber": "string",
"shippingMethod": "string",
"accountNo": "string",
"carrier": "string",
"shippingInsurance": true,
"taxable": true,
"resaleNumber": false,
"shippingAddress": {
"firstName": "string",
"lastName": "string",
"company": "string",
"countryTwoletterISOCode": "string",
"stateProvinceAbbreviation": "string",
"city": "string",
"address1": "string",
"address2": "string",
"zipPostalCode": "string",
"phoneNumber": "string"
},
"billingAddress": {
"firstName": "string",
"lastName": "string",
"company": "string",
"countryTwoletterISOCode": "string",
"stateProvinceAbbreviation": "string",
"city": "string",
"address1": "string",
"address2": "string",
"zipPostalCode": "string",
"phoneNumber": "string"
},
"paymentMethod": "string",
"customerponumber": "string",
"orderComment": "string",
"orderItem": [{
"productId": 0,
"partNumber": "string",
"manufacturerName": "string",
"quantity": 0,
"price": 0,
"customerpartnumber": "string"
}],
"currencycode": "string",
}
レスポンス例
{
"orderId": "string",
"errors": [
"string"
],
"success": true
}
利用可能な配送方法
国内配送オプション
| 配送業者コード | サービスコード |
|---|---|
| UPS | UPS Ground |
| UPS | UPS 3rd Day |
| UPS | UPS 2nd Day |
| UPS | UPS Next Day Saver |
| UPS | UPS Next Day |
| UPS | UPS Next Day Early |
| FEDEX | FedEx Ground |
| FEDEX | FedEx 3rd Day |
| FEDEX | FedEx 2nd Day |
| FEDEX | FedEx Priority Overnight |
| FEDEX | FedEx Std Overnight |
国際配送オプション
| 配送業者コード | サービスコード |
|---|---|
| UPS | UPS World Wide Express |
| UPS | UPS World Wide Saver |
| UPS | UPS World Wide Expedited |
| FEDEX | FedEx International Priority |
| FEDEX | FedEx International Economy |
利用可能な支払い方法
| 支払い方法名 |
|---|
| Net30 |
| Net45 |
| Net60 |
| PrePayment |
| Net15 |
| Net75 |
| Net90 |
利用可能な通貨
| 通貨 | 通貨コード |
|---|---|
| USD | usd |
| EUR | eur |
想定されるエラーメッセージ
API リクエストのエラーまたは内部の前提条件が満たされていない場合に返される可能性があるエラーメッセージの一覧です。
| 説明 |
|---|
| The minimum quantity allowed for purchase is |
| The maximum quantity allowed for purchase is |
| Allowed quantities for this product: |
| You may purchase all in-stock quantity of {0} or our minimum order quantity of {1} . Please adjust your quantity and add to cart to continue. |
| Quantity should be increments of |
| Minimum order quantity is |
| Please insert valid quantity |
| MOQ for out of Stock Qty is |
| Sorry, Item has no price, please contact us or submit price request |
| Sorry, Can not change quantity for this item |
| Sorry, we have limited Availability, please contact us or submit price request |
| Email is required |
| First Name is required |
| Last Name is required |
| Phone Number is required |
| Country Two letter ISO Code is required |
| Company is required |
| Address1 is required |
| City is required |
| Zip Postal Code is required |
| Please add valid data for item |
| Order Item is required |
| ShippingMethod is required |
| AccountNo is required |
| ship account should be 6 characters |
| ship account should be 9 characters |
| No Customer Found |
| no shipping address found |
| Shipping Address Error |
| Shipping Method Error |
| Error on Process Order |
| Payment Error |
| This product is no longer available, please modify your shopping cart |
注文履歴 API
Onlinecomponents.com のチェックアウトプロセスにアクセスし、ご自身のアプリケーション内で部品を注文できます。
説明
Order API は、Onlinecomponents.com で注文を行い確認するために使用できます。Pricing and Availability API と併用することを想定しています。より高速で柔軟な新バージョンの Order API があります:
- JSON はよりクリーンな応答データでより高速な処理を提供します
- データ形式はより整理され、最新のブラウザーで表示しやすくなります
- API バージョン管理: リクエストとレスポンスは JSON または XML で利用できます
エンドポイント
Order API は、Onlinecomponents.com で注文を行い確認するために使用できます。Pricing and Availability API と組み合わせて使用することを意図しています。