Getting started with the REST API

Peter Fabian edited this page Jul 19, 2018 · 9 revisions

Table of Contents

The REST API is a powerful part of WooCommerce which lets you read and write various parts of WooCommerce data such as orders, products, coupons, customers, and shipping zones.

Authorization is usually the part most developers get stuck on so this guide will cover a quick way to test that your API is working on your server and you can auth. If this works but your code to use the API does not, please bare in mind it will be a problem with your code. Please do not open issues asking for support about this on Github - use the support forums.

We'll use both Postman and Insomnia clients in these examples. Both are free and will help you visualise what the API offers.

Before proceeding, please read the REST API docs on authentication which covers the important parts concerning API Keys and Auth. We're only covering connecting over HTTPS here since it's the simplest and most secure method. You should avoid HTTP if possible.

Generate Keys

To start using REST API, you first need to generate API keys.

  1. Go to WooCommerce > Settings > Advanced
  2. Go to the REST API tab and click Add key.
  3. Give the key a description for your own reference, choose a user with access to orders etc, and give the key read/write permissions.
  4. Click Generate api key.
  5. Your keys will be shown - do not close this tab yet, the secret will be hidden if you try to view the key again.

Generated API Keys

Making a basic request

The request URL we'll test is wp-json/wc/v2/orders. On localhost the full URL may look something like this: https://local.wordpress.dev/wp-json/wc/v2/orders. Modify this to use your own site URL.

In Postman, you need to set the fields for request type, request URL, and the settings on the authorization tab. For Authorization, choose basic auth and enter your consumer key and consumer secret keys from WooCommerce into the username and password fields

Once done, hit send and you'll see the JSON response from the API if all worked well. You should see something like this:

Generated API Keys

Insomnia is almost identical to Postman; fill in the same fields and again use basic auth.

Insomnia

Thats it! The API is working.

If you have problems connnecting, you may need to disable SSL verification - see the connection issues section below.

Common connection issues

Connection issues with localhost and self signed SSL certificates

If you're having problems connecting to the REST API on your localhost and seeing errors like this:

SSL Error

You need to disable SSL verification. In Postman you can find this in the settings:

Postman settings

Insomnia also has this setting the preferences area:

Insomnia settings

401 Unauthorized

Your API keys or signature is wrong. Ensure that:

  • The user you generated API keys for actually has access to those resources.
  • The username when authenticating is your consumer key.
  • The password when authenticating is your consumer secret.
  • Make a new set of keys to be sure.

Consumer key is missing

Occasionally servers may not parse the Authorization header correctly (if you see a “Consumer key is missing” error when authenticating over SSL, you have a server issue).

In this case, you may provide the consumer key/secret as query string parameters instead. Example:

https://local.wordpress.dev/wp-json/wc/v2/orders?consumer_key=XXXX&consumer_secret=XXXX

Server does not support POST/DELETE/PUT

Ideally, your server should be configured to accept these types of API request, but if not you can use the _method property.

See https://developer.wordpress.org/rest-api/using-the-rest-api/global-parameters/#_method-or-x-http-method-override-header

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.