WooCommerce is an open-source e-commerce platform plugin. It helps online merchants to sell and service products online.
WooCommerce documentation: API guide, Authentication
Additional reference: Supported WooCommerce APIs
- A. Set up a WooCommerce connection
- B. Provide required WooCommerce application details
- C. Edit advanced WooCommerce settings
- D. Test the connection
A. Set up a WooCommerce connection
Start establishing a connection to WooCommerce in either of the following ways:
- From the Resources menu, select Connections. Then, click + Create connection at the top right.
– or –
- While working in a new or existing integration, you can add an application to a flow simply by clicking Add source or Add destination/lookup.
In the resulting Application list, select WooCommerce.
The Create connection panel opens with the required and advanced settings.
B. Provide required WooCommerce application details
At this point, you’re presented with options for providing WooCommerce authentication.
Name (required): >Provide a clear and distinguishable name. Throughout integrator.io imports and exports, you will have the option to choose this new connection, and a unique identifier will prove helpful later when selecting among a list of connections that you’ve created.
Application (required, non-editable): A reminder of the app you’re editing.
Base URI (required): Enter the WooCommerce base URI. For example, if your account is located at
https://shopName.com/wp-json/wc/v1/orders, then enter
Consumer key (required): Enter the consumer key.
Consumer secret (required): Enter the consumer secret. Multiple layers of protection, including AES 256 encryption, are in place to keep your secret safe. When editing this connection, you must re-enter this value each time; it is stored only when the connection is saved and never displayed as text.
- Sign in to your WooCommerce account.
- Navigate to WooCommerce > Settings > API > Keys/Apps
- Click Add key.
- Add a description and select the WordPress user for which you want to generate the key. Use of the REST API with the generated keys will conform to that user's WordPress roles and capabilities.
- Choose the level of access for this REST API key. Access levels include Read access, Write access, or Read/Write access.
- Click Generate API key and WooCommerce will generate REST API keys for the selected user.
- Now that keys have been generated, you should see two new keys, a QRCode, and a Revoke API key button. These two keys are your Consumer Key and Consumer Secret.
- If the WordPress user associated with an API key is deleted, the API key will cease to function. API keys are not transferred to other users.
C. Edit advanced WooCommerce settings
Before continuing, you have the opportunity to provide additional configuration information, if needed, for the WooCommerce connection.
D. Test the connection
Once you have configured the WooCommerce connection, you have a few options for continuing:
- Save – click this button to test the connection, commit the new connection so that it will be available to all integrations for your account
- Save & close – click to test and save the connection and exit the Create connection panel
- Close – click to exit without saving any new changes
- Test connection – click this button to verify that your new connection is free of errors
When you test or save the connection, it is verified before continuing.
The new connection is now successfully added to your account. It will be applied to the current source or destination app if you created it within a flow. Otherwise, you may proceed to register the connection with an integration.
Please sign in to leave a comment.