Please note that all documentation has been created using WordPress version 6.6.1 and WooCommerce version 9.2.3.
1. Provide API access
Access the admin panel of your WordPress website (typically through www.{website-url}/wp-admin/) and proceed with the steps below to activate the WooCommerce API.
a) On the left-hand side panel of the admin dashboard, navigate to 'Plugins' and click 'Installed Plugins' from the dropdown menu.
b) Click on the "Settings" link located under the WooCommerce plugin.
c) Next, you'll need to generate a REST API key. To do this, navigate to the 'Advanced' tab and click on the 'REST API' link.
d) Enter the REST API details, provide a user-friendly description, select a user, set Permissions to Read/Write, and then click the "Generate API key" button.
e) Copy both the Consumer Key and Consumer Secret Key by clicking the copy buttons, and then provide them to Programa.
2. Identifying brands
Products need a meta field/attribute called “brand” that contains the name of the brand.
3. Limit the products to a category
If you do not want your entire range of products available in Programa, you will need to set up a product ‘category’ that contains the selection of products you do wish to feed into Programa.
The ID of this category will need to be sent to the onboarding team. Alternatively the same can be done via a tag - and supplying the tag ID.
To restrict the products based on tag ID, please follow these instructions:
a) On the left-hand side panel of the admin dashboard, navigate to 'Products' and click 'Tags' from the dropdown menu.
b) Enter the ‘Name’ of your tag and click the button ‘Add new tag’. You will see that tag is available on the right.
c) Next, click on the tag name on the right-hand side and you will notice the tag_ID in the URL. You will need to copy this and provide this ID to Programa.
d) On the left-hand side panel of the admin dashboard, navigate to 'Products' and click the name of the product to which you wish to add a tag.
e) On the right-hand side panel of the product data entry page, there will be a section called ‘Product tags’. Type in the name of the product tag, select the correct option, and then click Add.
f) After you have clicked ‘Add’ you will see the tag displayed. Make sure you click update on the product to save this change.
4. Supplying Colour, Material and Finish attributes
Colour: either `colour` or `color`
Material: `material`
Finish: `finish`
If you need further assistance or guidance on this process, please contact brands@programa.com.au