Quickstart

This guide will get you all set up and ready to use the eWarehousing API. We’ll cover how to get started an API client and how to make your first API request.

Before you start

Before you can make requests to the eWarehousing API, you will need to get your API credentials from your account manager. Learn more about how authenticating works.

API environments

Use the correct base URL for your environment:

Examples in this guide may use eu-dev. Switch the base URL to Production when going live. See /authentication for credentials.

Customers in the API

  • A "customer" is your WMS customer/account that owns stock and orders.
  • It is not the shipping recipient or addressee; the recipient lives in order.shipping_address.
  • Send the X-Customer-Code header on every request.
  • If you work with multiple customers, use separate clients/connectors or switch the header value per request.

Learn more: Customers and Authentication.

Choose your client

Before making your first API request, you need to pick which API client you will use. We offer a variety of official SDKs which can be used to communicate with the API. You can also write your own SDK in your language of choice.

# cURL is most likely already installed on your machine
curl --version
Check out our list of first-party SDKs

Making your first API request

After picking your preferred client, you are ready to make your first call to the eWarehousing API. Below, you can see how to send a GET request to the Orders resource to get a list of all your orders.

GET
/wms/orders/
curl https://eu-dev.middleware.ewarehousing-solutions.com/wms/orders \
-H "Authorization: Bearer {token}"
-H "X-Wms-Code: {wms_code}"
-H "X-Customer-Code: {customer_code}"
Read the docs for the Orders endpoint

What's next?

Great, you're now set up with an API client and have made your first request to the API. Here are a few links that might be handy as you venture further into the eWarehousing API: