Get Started with the Sales Order API

The following information, with links to more detailed pages, will get you started developing your own sales order apps using the Sales Order API.

The Sales Order API is available to Gold and Platinum tier partners. To upgrade your tier, visit the Intuit Developer Portal. If you don’t have access, open a support ticket.

Develop with GraphQL

For detailed information on how to develop using the GraphQL query language, including endpoints, authentication, required headers, and testing, see Learn about GraphQL. For information on how to develop QuickBooks Online apps using GraphQL, including best practices and an FAQ, see Develop with GraphQL.

How to get access

To get access:

  1. Go to your app’s Permissions page in the Intuit Developer Portal. Enable the sales.sales-order.read and sales.sales-order.write scopes under Restricted scopes.
  2. Add the enabled scope to your OAuth authorization requests. If you’re already on a paid tier and still don’t have access, open a support ticket.
  3. Enable the Sales Orders feature in the QuickBooks company (Settings > Account and Settings > Sales, or the applicable feature toggle for Sales Orders).
Authorize your app

Authorize your app as described here.

Scopes

Scopes limit what data your app can read and update. Instead of getting broad permissions for everything, set granular permissions so your app only focuses on what’s necessary.

Here are the scopes for the QuickBooks Online Sales Order API:

Sales Order endpoints

To develop your app using Sales Order you will use both the Sales Order API, which is based on GraphQL and uses a single endpoint, and also the QuickBooks Online REST API where applicable (e.g., for linked transactions such as invoices or purchase orders).

Required headers