Getting Started

Welcome to the Online Components API Suite! Follow these steps to get started:

Authentication

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:

1. Navigate to your customer profile

Log in to your Online Components account and go to your customer profile

2. Go to API Access and Services

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

3. Request Your API Key

Request an API key from this section, choosing between a production or a sandbox API key. You'll receive your key instantly. If you suspect any security issues, you can retrigger and regenerate your key at any time

Sandbox Environment

We understand the importance of testing before going live. That's why we provide a fully functional sandbox environment where you can experiment with all of our APIs without affecting your production data.

Accessing the Sandbox

1. Requesting a Sandbox API Key

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.

2. Different Base URL

While the API endpoints remain the same, the sandbox environment uses a different base URL.

1. Production Base URL: https://api.onlinecomponents.com
2. Sandbox Base URL: https://sandbox.onlinecomponents.com
3. Sandbox Developer Portal

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

Description

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 offers faster processing with cleaner response data
• Data formatting is cleaner and easier to display in modern browsers
• API version control: Requests and responses are available in either JSON or XML

Features

Data Available

Endpoints

Order API

Gain access to the Onlinecomponents.com checkout process and order parts inside your own applications.

Description

The Order API can be used to place and check orders from Onlinecomponents.com It is intended to be used in conjunction with the Pricing and Availability API. We have a new version of Order API that is faster and more flexible:

• JSON offers faster processing with cleaner response data
• Data formatting is cleaner and easier to display in modern browsers
• API version control: Requests and responses are available in either JSON or XML

Endpoints

The Order API can be used to place and check orders from Onlinecomponents.com It is intended to be used in conjunction with the Pricing and Availability API.

{
    "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"
    }]
} 

{
    "orderId": "string",
    "errors": [
        "string"
    ],
    "success": true
}

Order History API

Gain access to the Onlinecomponents.com checkout process and order parts inside your own applications.

Description

The Order API can be used to place and check orders from Onlinecomponents.com It is intended to be used in conjunction with the Pricing and Availability API. We have a new version of Order API that is faster and more flexible:

• JSON offers faster processing with cleaner response data
• Data formatting is cleaner and easier to display in modern browsers
• API version control: Requests and responses are available in either JSON or XML

Endpoints

The Order API can be used to place and check orders from Onlinecomponents.com It is intended to be used in conjunction with the Pricing and Availability API.