Gain access to the Onlinecomponents.com checkout process and order parts inside your own applications.
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:
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.
Request Parameters
| Parameter |
Description |
Required |
| email |
The email address of the customer to be associated to the sales order |
yes |
| firstName |
The first name of the customer |
yes |
| lastName |
The last name of the customer |
yes |
| phoneNumber |
The phone number for the order |
yes |
| shippingMethod |
|
yes |
| accountNo |
Shipping account no. |
yes |
| carrier |
|
No |
| shippingInsurance |
|
yes |
| taxable |
|
yes |
| resaleNumber |
|
No |
| shippingAddress |
The shipping address for the order |
yes |
| shippingAddress.firstName |
The first name to be used for the ship-to address |
yes |
| shippingAddress.lastName |
The last name to be used for the ship-to address |
yes |
| shippingAddress.company |
The company name to be used for the ship-to address |
yes |
| shippingAddress.countryTwoletterISOCode |
The two character country code to be used for the ship-to address (e.g. US) |
yes |
| shippingAddress.stateProvinceAbbreviation |
The state or province to be used for the ultimate destination address |
yes |
| shippingAddress.city |
The city to be used for the ship-to address |
yes |
| shippingAddress.address1 |
The first address to be used for the ship-to address |
yes |
| shippingAddress.address2 |
The second address to be used for the ship-to address |
yes |
| shippingAddress.zipPostalCode |
The postal code to be used for the ship-to address |
yes |
| shippingAddress.phoneNumber |
The phone number to be used for the ship-to address |
yes |
| billingAddress |
The billing address for the order |
yes |
| billingAddress.firstName |
The first name to be used for the bill-to address |
yes |
| billingAddress.lastName |
The last name to be used for the bill-to address |
yes |
| billingAddress.company |
The company name to be used for the bill-to address |
yes |
| billingAddress.countryTwoletterISOCode |
The two character country code to be used for the bill-to address (e.g. US) |
yes |
| billingAddress.stateProvinceAbbreviation |
The state or province to be used for the ultimate destination address |
yes |
| billingAddress.city |
The city to be used for the bill-to address |
yes |
| billingAddress.address1 |
The first address to be used for the bill-to address |
yes |
| billingAddress.address2 |
The second address to be used for the bill-to address |
yes |
| billingAddress.zipPostalCode |
The postal code to be used for the bill-to address |
yes |
| billingAddress.phoneNumber |
The phone number to be used for the bill-to address |
yes |
| paymentMethod |
The payment method to pay for the order |
yes |
|
|
|
no |
| orderComment |
Comment of the currently selected order |
No |
| orderItem |
|
yes |
| orderItem.productId |
The unique identifier for the order line item |
yes |
| orderItem.partNumber |
|
No |
| orderItem.manufacturerName |
|
No |
| orderItem.quantity |
The number of items purchased |
yes |
| orderItem.price |
Item unit price |
No |
| orderItem.customerpartnumber |
Customer Part Number |
No |
Example Request onlinecomponents.com
{
"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"
}]
}
Example Response onlinecomponents.com
{
"orderId": "string",
"errors": [
"string"
],
"success": true
}
Available Shipping Methods
Domestic Options
| Agent Code |
Service Code |
| 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 |
International Options
| Agent Code |
Service Code |
| UPS |
UPS World Wide Express |
| UPS |
UPS World Wide Saver |
| UPS |
UPS World Wide Expedited |
| FEDEX |
FedEx International Priority |
| FEDEX |
FedEx International Economy |
Available Payment Methods
| Payment Method Name |
| Net30 |
| Net45 |
| Net60 |
| PrePayment |
| Net15 |
| Net75 |
| Net90 |
Potential Error Messages
The following is a list of error messages that could be received as a result of an error in the API request or one of the onlinecomponents.com internal prerequisites not being completed.
| Description |
| 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
|
contacter:
FR
English
Chinese
Italiano
Portuguese
Deutschland
French
Russian
Japanese
Turkish
Korean
Spanish
mon compte et mes commandes
Débloquez des économies exclusives ! Connectez-vous ou inscrivez-vous maintenant pour accéder à de meilleurs prix.
