WooCommerce

Planufac and WooCommerce REST API Integration

Planufac platform seamlessly integrates with the WooCommerce REST API, enabling connectivity between your WooCommerce store and planufac.

For Non-Developers

Unless you're a developer, the integration process is straightforward and typically involves only two steps:

1. Generate API Keys
   • Log into your WooCommerce store and generate API keys.
2. Enter API Keys in planufac
   • Access planufac and enter the API keys from your WooCommerce store.

Requirements

For planufac integration to work with your WooCommerce store, you must set your WordPress permalinks to a readable format.

Go to Settings > Permalinks in your WordPress admin area. The "Day and name" option is recommended, but any option except "Plain" will work.

Having readable permalinks is essential for planufac to properly integrate with your WooCommerce store.

The WooCommerce REST API utilizes a key-based authentication system to control access. Each set of API keys is associated with a specific WordPress user account on your website. By generating and providing these API keys, you grant planufac the necessary permissions to interact with your WooCommerce store on behalf of that user.

Generate API Keys

The WooCommerce REST API uses a key system to control access, linked to WordPress users on your site.

To generate API keys:

1. Log in to your WordPress admin area
2. Go to WooCommerce > Settings > Advanced > REST API
3. Click "Add Key"
4. Select the required permissions (read, write, etc.)
5. Copy the Consumer Key and Consumer Secret

You'll need to enter these API keys in the planufac system for the integration to work with your WooCommerce store.

Creating and Managing API Keys for a Specific WordPress User

Navigation:

Go to: WooCommerce > Settings > Advanced > REST API.

Note: Before WooCommerce version 3.4, this option was located under WooCommerce > Settings > API > Key/Apps.

Add a New API Key:

Click on 'Add Key'. This action will direct you to the 'Key Details' screen.

Key Configuration:

Enter a description for the key in the 'Description' field.

Select the user for whom you want to generate the key from the dropdown menu.

Access Level:

Choose the level of access for this API key:

• Read access
• Write access
• Read/Write access (Recommended)

Generation:

Click 'Generate API Key'. WooCommerce will then create the API keys for the selected user.

Post-Creation:

Upon successful generation, you will see the Consumer Key and Consumer Secret keys displayed along with a QRCode and a "Revoke Key" button.

Application Integration:

The Consumer Key and Consumer Secret can be entered into the application you intend to connect with using the WooCommerce REST API. Ensure the application also requests your URL for complete setup.

Integrating your WooCommerce store with planufac.com

1. Navigate to planufac.com and log in to your account.
2. Go to the Integrations section from the main menu.
3. Select WooCommerce from the list of available integrations.
4. In this section, you'll need to input your Consumer Key and Consumer Secret.

API Credentials and Endpoints

1. API Endpoint: Enter the URL where Planufac can access the WooCommerce API. This is typically your store's base URL followed by /wp-json/wc/v3/ .
2. API Key & API Secret: These are provided by your WooCommerce store under WooCommerce > Settings > Advanced > REST API. Generate these keys to establish a secure connection.

Order States and Synchronisation Settings

3. New order/Creation states: Set to 'processing'. This means that when orders enter the 'processing' state in WooCommerce, they will trigger actions in Planufac.
4. Shipped/Completed states: Set to 'completed'. Orders marked as completed in WooCommerce will update their status correspondingly in Planufac.
5. Cancelled/Refunded states: Set to 'cancelled'. It ensures that any orders cancelled in WooCommerce reflect the same in Planufac.

Additional Synchronisation Options

6. Sync Products?: If checked, this option keeps your WooCommerce product catalogue in sync with Planufac, updating product details and inventory levels.
7. Sync Orders?: Enables the synchronisation of order details between WooCommerce and Planufac.
8. Sync Stock?: Keeps inventory levels aligned between both systems. Particularly useful for inventory management and to prevent overselling.

Invoice and Tax Settings

9. Invoice On Ship?: Generates an invoice when an order is marked as shipped. This is useful for accounting and tracking purposes.
10. Invoice On Creation?: Generates an invoice as soon as the order is created in WooCommerce, which might be required for prepayment scenarios or specific accounting practices.
11. Use Order Date for Invoices?: This setting will use the order date from WooCommerce as the invoice date in Planufac, ensuring consistency in record-keeping.

Advanced Configuration

12. Fail on missing products?: If checked, the integration will not proceed with orders that include products not found in Planufac, avoiding errors in order processing.
13. Create hidden contacts?: Allows the system to create contacts in Planufac that are not visible in the normal contact lists. Useful for internal management and special cases.
14. Prices include tax?: Indicates whether product prices inputted into Planufac should be considered as tax-inclusive.
15. Mark Invoice Paid?: Automatically marks invoices as paid when an order reaches a specified state, simplifying the accounting process.
16. Finalise On Creation?: If checked, order data is finalised immediately upon creation, locking the details for editing in Planufac.