To submit your order, make a POST request to the Order Submit API with the following requirements:
POST https://api.farnell.com/order/order_submit
Request Headers
| Name | Description |
|
api_key required * |
your_generated_api_key To generate your API key, follow the instructions on the Order API Registration page. |
|
authorization required * |
your_jwt_token To get your JWT token for authorization, use the Generate JWT Authentication Token API. |
|
version Optional |
Version specifies the information returned on Order Submission. Version 1 provides Order Confirmation Number Version 2 provides Order Details such as Cart Contents and other specification. Full list available at Response Attributes Valid Values “1” and “2” Default Value is “1” |
Request Attributes
| Name | Description |
|
poNumberId optional |
String Represents customer internal Purchase Order Number. |
|
poReleaseNumberId optional |
String Represents release number of customer internalpurchase order when split into multiple orders. |
|
taxExempt optional |
String Represents whether order is Tax Exempt. |
Sample Payload
{
"paymentVatNumberId": "<For Mexico store>",
"primaryReason": "<For Mexico store>",
"poNumberId": "PO 65345",
"poReleaseNumberId": "<For US store>",
"taxExempt": "<For US store>",
"fiscal_vatRegNum": "<For Italy store>",
"pecEmail": "<For Italy store>",
"codiceCode": "<For Italy store>"
}
Italy only - Request Attributes
| Name | Description |
|
fiscal_vatRegNum required* |
String Represents Fiscal Code or Vat registration number |
|
pecEmail required* |
String Represents PEC Email - *only required if 11 digit vatRegNum is in request and codiceCode not present |
|
codiceCode required* |
String Represents Codice Fiscale identification code - * only required if 11 digit vatRegNum in request and pecEmail not present |
Mexico only - Request Attributes
| Name | Description |
|
paymentVatNumberId required* |
String Represent the VAT Registration Number |
|
primaryReason required* |
String Represents reason for order, key must be presented |
PrimaryReason – key must be presented
| Name | Description |
|
G01 |
Acquisition of goods |
|
G03 |
General expenses |
|
I01 |
Buildings |
|
I02 |
Furniture and office equipment for investment |
|
I04 |
Computer equipment and accessories |
|
I05 |
Dyes, molds and tooling |
|
I06 |
Telephone communication |
|
I07 |
Satellite communication |
|
I08 |
Other machinery and equipment |
|
P01 |
undefined |
Response
Version 1
| Name | Description |
| orderReference |
Order Reference Number A unique identifier that is issued when an Order is successfully placed through the API. |
Example
Code 200
{ "orderReference": "<Order Confirmation Number>"}
Version 2
| Name | Description |
| orderReference |
Order Reference Number A unique identifier that is issued when an Order is successfully placed through the API. |
| tradeAccount |
Represents the Trade Account number used for the API Order. |
| rereelingCharge |
Total Order Re-Reeling Charge. |
| orderId |
A unique identifier associated with the current Basket and returned in the response when items are added to Basket. It does not indicate that an order has been submitted. |
| grandTotal |
Grand Total for Order. |
| productsTotal |
Total Value of Products. |
| deliveryCharge |
Order Delivery Charge. |
| directShipCharge |
Order Direct Ship Charge. |
|
invoiceAddress |
Order Invoice Address. |
|
{ "invoiceAddress": { "country": "<Country of the Invoice Address>", "organizationName": "<Name of the Organization>", "city": "<City of the Invoice Address>", "postalCode": "<Postal Code of the Invoice Address>", "addressLine1": "<Invoice Address Line 1>", "addressLine2": "<Invoice Address Line 2>", "region": "<State/Province/Region of the Invoice Address>", "addressId": "<Identifier for the Invoice Address>" } } |
| tax |
Total Tax applied to the Order. |
| poNumberId |
Represents customer internal Purchase Order Number. |
|
shippingAddress
|
Address ID chosen from the retrieved shipping address API. { "shippingAddress": { "country": "<Country of the Shipping Address>", "city": "<City of the Shipping Address>", "nickName": "<Nickname of the Shipping Address>", "postalCode": "<Postal Code of the Shipping Address>", "addressLine1": "<Shipping Address Line 1>", "addressLine2": "<Shipping Address Line 2>", "region": "<State/Province/Region of the Shipping Address>", "addressId": "<Identifier for the Shipping Address>" } } |
| currencyCode |
Currency of Transaction |
|
shippingModeDetails
|
Shipping method ID chosen from the retrieve shippingAPI methods API, including shipping method description. { "shippingModeDetails": { |
