Authentication

In order to connect to the Order Desk API, go to your Store Settings and click on the API tab to create an API Key. You'll be presented with an API Key and Store ID. You'll need to add both of these details as headers to each request that you make to the API, along with the correct content type.

Required Headers

Name	Value
ORDERDESK-STORE-ID	Your store ID
ORDERDESK-API-KEY	Your API key

Include Content-Type: application/json on requests that send a JSON body.

Testing Your Connection

Query the testing endpoint to confirm that your credentials are working.

GET /https://app.orderdesk.me/api/v2/test

curl "https://app.orderdesk.me/api/v2/test" \
  -H "ORDERDESK-STORE-ID: your-store-id" \
  -H "ORDERDESK-API-KEY: your-api-key"

A working connection returns 200 with a status of success:

{
  "status": "success",
  "message": "Connection Successful",
  "current_date_time": "2015-04-14 22:00:10",
  "execution_time": "0.0121 seconds"
}

Please note that sending an invalid Store ID will block your store from the API rather than simply returning an error. Confirm that your Store ID is correct before running a script that retries. See Errors for details.

Keeping Your API Key Secure

An API key grants full read and write access to the store, including customer addresses and order history. It should be kept on your server and should not be included in browser JavaScript, mobile application binaries, or public repositories.

If a key is exposed, generate a new one from the same API tab. The previous key stops working immediately.