Introduction

Order Desk provides an API for programmatic access to your store's data. The Order Desk API is a RESTful API that accepts and returns JSON. You can use the API to pull order status, add orders, add shipments, and retrieve inventory items.

Base URL

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

All paths in this reference are relative to this URL.

API Usage and Availability

While we endeavor to ensure that the API has 100% uptime, API access should not be assumed. It's best to connect to the Order Desk API in a background process on your end and not through a customer-facing interface.

Don't import orders into Order Desk and then wait for a response as part of your shopping cart's order flow. A better method would be to import these orders into your own order system and then set up a cron job on your end to submit them to the Order Desk API in an asynchronous process. Submissions that fail can then be retried later.

Best Practices

If you are building an integration to our API, see our list of best practices.

PHP Client

If you are developing in PHP, we have a helper client available. The PHP examples throughout this reference use it.

We'd love to hear about what you are building, so please reach out to [e-mail].