Order API

Automate your orders with Mouser

Overview

Need Help?

Can’t find what you need? Contact us now and we will help you with your request.

Contact Mouser Now

Description

The Order API allows you to place orders with Mouser while remaining within your application. As we require you to use Mouser part numbers, we suggest building your order list with the Mouser Search API. Below you will find explanations and documentation regarding the Order API.

Generate an API Key

Inside your My Mouser account there is a new section called APIs where you will be able to sign up for and view your API key.

Generate Key

Using Order API

The Order API gives you the ability to view order details for an order, get a list of supported countries, states, currencies and, most importantly, to submit an order.

Like the Cart API, pricing and order rules are determined based on the billing address associated to your account and the default shipping address or the shipping address sent with the API request.

Below are the suggested steps to take when using one of Mouser's APIs:

  1. Create a My Mouser account if you do not already have one.

  2. Generate an API key if you do not have one. You can do this by visiting the API management page in your My Mouser account.

  3. Learn the ins and outs of using Mouser's APIs and get sample code by visiting our step-by-step API guide.

    Read Guide

  4. Visit the API Explorer page which lists all available APIs, each API's endpoints, and provides you with an easy-to-use test area to make API requests.

    Visit API Explorer

  5. Create a request

  6. Submit an order

Endpoints

The Order API provides the endpoints listed below.

The /options/query endpoint returns your billing and shipping address, currency code, a list of shipping methods plus any rates, payment methods, any freight accounts, any tax certificates, any VAT accounts, and any saved credit cards for your account.

A billing and shipping address is required to use the options/query endpoint.

Credit cards are only supported through the Order API if you have a saved credit card on your account. To manage saved cards, go here.

Returns all available currencies based on your billing/shipping address. A billing and shipping address is required to use the /currencies endpoint.

A shipping country code can be passed in to override the default shipping address on your account

To submit an order, you will need to send a currency code for the order. As seen in the image below, if I want to choose the currency US dollars for my order, I would send the 3-digit ISO code value of USD.

Returns all available countries plus any states/provinces the country has. Allows the user to filter countries by country code. Values returned from this endpoint can be used when you submit an order and you want to override the default shipping address on your account.

For example, if I wanted to ship to Arizona, I would send “AZ” as the state ISO code and “US” as the country ISO code to submit an order.

Use this endpoint to submit a new order. As mentioned earlier, any orders created here will be placed against your account and a basket will need to be created before submitting an order.

If any errors exist in the billing address/shipping address/shipment method/payment/country or currency/scheduled releases, you will not be able to submit an order. If you are not sure if you have an error, see the section on Fault Tolerance.

If any basket items are errored, you will need to either correct the error or remove the basket item before submitting an order.

An order number will be returned if a successful order is placed.

Submits a new order from an old order if the "SubmitOrder" property is set to true. If the "SubmitOrder" property is set to false, then an order summary will be returned.

Use this endpoint to view the details for an order you created. To use the query you must provide the order number, which is returned in the response body for the endpoint used to create an order, /api/v{version}/order.