WooCommerce REST - Gather API Credentials

To connect to the WooCommerce REST API, the following information is required:

  • Store URL
  • Consumer Key
  • Consumer Secret

Follow these steps to gather required information, and to configure the WooCommerce REST API.

Gather Store URL

The Store URL is the root domain of your WooCommerce store, such as https://www.example.com. Make note of this exact web address.

Configure Permalinks

In WordPress admin, go to Settings > Permalinks. Make sure these are set to anything other than "Plain," such as Day and name.

Generate API Keys

  1. Go to WooCommerce > Settings > Advanced > REST API, and click Add Key.
  2. For Description, enter PackageBee.
  3. For User, choose the user account whose access level will be used for API transactions. This user should have the Administrator or Shop Manager role, or at minimum these role permissions:
  • General - Read
  • Posts - Read
  • Pages - Read
  • Products
    • edit_products
    • edit_others_products
    • read_private_products
    • publish_products
    • read_private_products
    • edit_private_products
    • edit_published_products
  • Orders
    • edit_shop_orders
    • edit_others_shop_orders
    • publish_shop_orders
    • read_private_shop_orders
    • edit_private_shop_orders
    • edit_published_shop_orders
  • Coupons - read_private_shop_coupons
  1. For Permissions, choose Read/Write.
  2. Click Generate API Key.
  3. Copy the Consumer Key and Consumer Secret.

Next: Enable API Access

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request



Please sign in to leave a comment.