The Ordoro API can be used to access data or integrate to add functionality to Ordoro. The Ordoro API uses the application/json Content-Type. The Ordoro API documentation is in beta. See our forum for questions or comments to help us improve the docs or request features.

Note: Any routes with a /v3 designation will not allow for trailing slashes while all other routes and endpoints will require a trailing slash.

The Ordoro API uses Basic HTTP Authentication. Please create API keys via Settings->Account Settings->API Keys in app and use those for basic auth in your API requests.

For a look at some code examples on how to use the API check out our github repo https://github.com/ordoro/api-examples.

Most of our endpoints return either a list of objects or a single object instance. They share similar response shapes.

List endpoints respond with the following parameters:

Here is an example response for the /v3/order list endpoint.

{
    "count": 2,
    "limit": 10,
    "offset" 0,
    "order": [
        {
            // an order object
        },
        {
            // another order object
        }
    ]
}

Instance endpoints return a single instance of a serialized model. /v3/order/{order_number} is an example of an instance endpoint.

Error responses contain the following parameters:

API requests will be limited to 500 requests per minute. Any requests over this threshold will respond with a 429 status code.

Address objects are used and referenced in Orders shipping and billing addresses, Warehouses, and Suppliers.

Current routes for /cart/ are sometimes interchangeably referenced as sales_channel

Goods Receipts are used for receiving items on a Purchase Order. You may have multiple Goods Receipts per Purchase Order and can have multiple lines and quantities of products related to the Purchase Order.