{"id":8755600,"date":"2024-01-18T00:20:34","date_gmt":"2024-01-18T00:20:34","guid":{"rendered":"https:\/\/woo-docs-multi-com.go-vip.net\/docs\/getting-started-with-the-woocommerce-rest-api\/"},"modified":"2024-08-21T15:57:53","modified_gmt":"2024-08-21T15:57:53","slug":"getting-started-with-the-woocommerce-rest-api","status":"publish","type":"post","link":"https:\/\/developer.woocommerce.com\/docs\/getting-started-with-the-woocommerce-rest-api\/","title":{"rendered":"Getting started with the WooCommerce REST API"},"content":{"rendered":"\n

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.<\/p>\n\n\n

Requirements<\/h2>\n\n\n

In order to access the REST API using the standard endpoint URI structure (e.g. wc\/v3\/products<\/code>), you must have your WordPress permalinks configured to something other than “Plain”. Go to Settings > Permalinks<\/strong> and choose an option.<\/p>\n\n\n

\"Permalinks<\/p>\n\n\n

API reference<\/h2>\n\n\n

WooCommerce REST API Docs<\/a> provides technical details and code samples for each API endpoint.<\/p>\n\n\n

Authentication<\/h2>\n\n\n

Authentication 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 authenticate.<\/p>\n\n\n

We’ll use both Postman<\/a> and Insomnia<\/a> clients in these examples. Both are free and will help you visualise what the API offers.<\/p>\n\n\n

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

Generate Keys<\/h2>\n\n\n

To start using REST API, you first need to generate API keys.<\/p>\n\n\n

    \n\n
  1. Go to WooCommerce > Settings > Advanced<\/em>\n<\/li>\n\n\n\n
  2. Go to the REST API<\/em> tab and click Add key<\/em>.<\/li>\n\n\n\n
  3. Give the key a description for your own reference, choose a user with access to orders etc, and give the key read\/write<\/em> permissions.<\/li>\n\n\n\n
  4. Click Generate api key<\/em>.<\/li>\n\n\n\n
  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.<\/li>\n\n\n<\/ol>\n\n\n

    \"Generated<\/p>\n\n\n

    Make a basic request<\/h2>\n\n\n

    The request URL we’ll test is wp-json\/wc\/v3\/orders<\/code>. On localhost the full URL may look something like this: https:\/\/localhost:8888\/wp-json\/wc\/v3\/orders<\/code>. Modify this to use your own site URL.<\/p>\n\n\n

    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<\/em> and enter your consumer key<\/em> and consumer secret<\/em> keys from WooCommerce into the username and password fields<\/p>\n\n\n

    Once done, hit send and you’ll see the JSON response from the API if all worked well. You should see something like this:<\/p>\n\n\n

    \"Generated<\/p>\n\n\n

    Insomnia is almost identical to Postman; fill in the same fields and again use basic auth.<\/p>\n\n\n

    \"Insomnia\"<\/p>\n\n\n

    That’s it! The API is working.<\/p>\n\n\n

    If you have problems connecting, you may need to disable SSL verification – see the connection issues section below.<\/p>\n\n\n

    Common connection issues<\/h2>\n\n\n

    Connection issues with localhost and self-signed SSL certificates<\/h3>\n\n\n

    If you’re having problems connecting to the REST API on your localhost and seeing errors like this:<\/p>\n\n\n

    \"SSL<\/p>\n\n\n

    You need to disable SSL verification. In Postman you can find this in the settings:<\/p>\n\n\n

    \"Postman<\/p>\n\n\n

    Insomnia also has this setting the preferences area:<\/p>\n\n\n

    \"Insomnia<\/p>\n\n\n

    401 Unauthorized<\/h3>\n\n\n

    Your API keys or signature is wrong. Ensure that:<\/p>\n\n\n