Requirements
Prepare the following before configuring the integration.
A working WordPress website with administrator access.
Install and activate WooCommerce before using this plugin.
Obtain an API access token and the appropriate environment details from REDX.
Installation
Install the plugin through your WordPress dashboard.
- Open Plugins
Go to Plugins → Add New Plugin in your WordPress dashboard.
- Upload the plugin ZIP
Use Upload Plugin and select the plugin ZIP file supplied to you.
- Install and activate
Click Install Now, then activate the plugin.
- Open REDX settings
Locate the REDX settings page in your WordPress administration menu and configure the integration.
The plugin is being prepared for WordPress.org submission. The installation instructions above apply when you have a valid plugin ZIP available.
Configure your REDX API
Open the plugin's REDX settings page. Configure the connection before synchronizing data or creating parcels.
Select an environment
Choose the environment that matches your REDX credentials.
- Sandbox: Use for development and testing with appropriate sandbox credentials.
- Production: Use for live operations with your production REDX token.
Do not use production credentials for sandbox testing, or vice versa.
Enter your API access token
Enter the REDX API access token in the designated field and save the settings. The plugin stores the token as a WordPress setting and does not display the saved token as plain text on the settings page.
If a token is already configured, leave the token field blank when saving other settings if you want to keep the existing token.
Choose shipping methods
Select the WooCommerce shipping methods that represent REDX deliveries. The selected methods determine where the plugin enables its REDX delivery-location and parcel workflow.
Keep API credentials private. Only authorized store administrators should have access to the plugin settings.
Synchronize REDX data
The plugin can synchronize delivery-area data and pickup-store information into WordPress for use by the integration.
Delivery areas
Use Sync Delivery Areas to retrieve delivery-area data. The settings page displays the number of locally stored areas and the last synchronization time when available.
Pickup stores
Use Sync Pickup Stores to retrieve pickup-store information for the store's configuration.
- Confirm API settings
Check that the environment and API token are correct.
- Run synchronization
Use the relevant synchronization button on the REDX settings page.
- Review the result
Check the status message and confirm that the synchronized data is available.
If synchronization fails, review your API credentials, selected environment, and connection, then try again. Contact support if the issue continues.
Shipping and pickup settings
Configure how the integration should work with your WooCommerce shipping methods and REDX pickup arrangements.
| Setting | Purpose |
|---|---|
| Shipping methods | Identifies the WooCommerce shipping methods that should use the REDX workflow. |
| Pickup store | Selects a synchronized REDX pickup store when required. If only one store is synchronized, the plugin indicates that REDX can use it automatically when none is selected. |
| Delivery areas | Uses synchronized local delivery-area data for the plugin's checkout workflow. |
Test checkout with the shipping methods you configured and verify that the delivery-location selection works as expected.
Parcel creation
The plugin provides automatic and manual parcel-creation options. Select the workflow that fits your store's fulfilment process.
Automatic creation
Enable Automatic Parcel Creation if you want the plugin to create parcels automatically when its configured order workflow is triggered.
Manual creation
Disable automatic creation to use the manual parcel-creation workflow from the WooCommerce order screen.
Parcel creation delay
The settings page provides delay choices for parcel creation. Choose the delay that matches your order-processing policy. Confirm the behavior on a test order before enabling it for live orders.
Use a controlled test order and verify the resulting order and parcel information before processing real shipments. Do not assume that an order has been accepted by REDX unless the plugin reports a successful result.
Common issues
The plugin says the API token is missing
Open the REDX settings page, enter the correct API token for the selected environment, and save the settings.
Delivery areas are not available
Check the API configuration and run the delivery-area synchronization. Confirm that the synchronization completes successfully.
No pickup stores are listed
Check the API connection and run pickup-store synchronization. Confirm that the REDX account provides the pickup-store data required by your setup.
Parcel creation fails
Check the API environment, token, selected shipping method, pickup-store configuration, and order details. Review the plugin's displayed error or status message before retrying.
The integration does not appear at checkout
Confirm that the relevant WooCommerce shipping method is selected in the plugin settings and test the checkout flow with that method enabled.
Frequently asked questions
Do I need WooCommerce?
Yes. WooCommerce must be installed and activated for this integration to work.
Can I test before switching to production?
The plugin includes a Sandbox environment option. Use it with valid sandbox credentials and verify the behavior before switching to Production.
Can I choose automatic or manual parcel creation?
Yes. The plugin settings provide an automatic parcel-creation option. When automatic creation is disabled, the plugin provides a manual workflow from the order screen.
Where can I get help?
Visit our Support page and provide the plugin version, WordPress and WooCommerce versions, the steps that caused the issue, and the exact error message. Remove API tokens and customer personal data from screenshots or logs.
Still have questions?
Visit our support page for help with installation and configuration.