Pixxi Property Importer – Complete Documentation
Introduction
What is Pixxi Property Importer?
Pixxi Property Importer is a WordPress plugin that syncs property listings from the PIXXI CRM API into the Houzez theme. It automates property management, keeping listings current without manual entry.
Key Benefits
- Automated property synchronization
- Real-time updates from PIXXI CRM
- Automatic agent profile creation
- Customizable field mapping
- Scheduled automatic sync (CRON)
- Support for rent, sell, and new project listings
- Built-in support ticket system
Installation
Step 1: Download the Plugin
Download the plugin ZIP file from your purchase or developer.
Step 2: Install via WordPress Admin
- Go to WordPress Admin → Plugins → Add New
- Click Upload Plugin
- Choose the ZIP file
- Click Install Now
- Click Activate Plugin
Step 3: Verify Installation
- A new menu item “Pixxi Importer” appears in the WordPress admin sidebar
- The plugin creates necessary database tables on activation
- Check Plugins page to confirm activation
Requirements
System Requirements
- WordPress: 5.0 or higher
- PHP: 7.0 or higher
- PHP Extensions: curl, json, mbstring
- Theme: Houzez theme installed and activated
- PHP Settings:
- set_time_limit enabled (default: 300 seconds)
- memory_limit at least 128MB (256MB recommended)
- max_execution_time at least 300 seconds
Required Access
- PIXXI CRM Account with API access
- API Endpoint URL from PIXXI CRM
- API Token from PIXXI CRM
- WordPress Admin access with manage_options capability
Getting Started
Initial Setup
- Navigate to Pixxi Importer in the WordPress admin menu
- You’ll see the dashboard with statistics and settings
- Configure your API credentials (see Configuration section)
- Save settings
- Click “Update Properties” to perform your first import
First Import Process
- Click “Update Properties” on the dashboard
- The plugin fetches properties from the PIXXI API
- Properties are processed and imported
- Progress is shown in real time
- Once complete, check your Properties in WordPress
Configuration
API Settings
API Endpoint URL
Format: https://dataapi.pixxicrm.ae/pixxiapi/v1/properties/YourCompanyName
Example: https://dataapi.pixxicrm.ae/pixxiapi/v1/properties/Woolhawk%20Real%20Estate%20LLC
Note: Company names with spaces should be URL-encoded (e.g., %20 for spaces)
API Token
Obtain from your PIXXI CRM account. Keep this token secure and private.
Automatic Delete
Purpose: Automatically delete properties removed from the API
When Enabled: Properties not in the API response are deleted during sync
Taxonomy Cleanup
Purpose: Remove orphaned taxonomy terms
When Enabled: Terms with zero associated properties are deleted
Automatic Sync Schedule (CRON)
Enable Automatic Sync
Toggle to enable/disable scheduled synchronization. When enabled, properties sync automatically based on your schedule.
Sync Interval Options
- Every X Minutes: 1-60 minutes (plan-dependent)
- Hourly: Every hour
- Daily: Once per day
- Weekly: Once per week
Features Guide
Dashboard Overview
Statistics Cards
- Total Properties: Total properties in the import database
- Synced Properties: Properties successfully synced to WordPress
- Pending Sync: Properties awaiting synchronization
- Last Sync: Time since last successful sync
- API Status: Current API connection status (Online/Offline)
License Status Card
- Shows current license status (Active/Invalid)
- Displays plan name and property limits
- Shows expiration date (if applicable)
- Quick access to activate/refresh license
Manual Import Controls
Update Properties Button
- Fetches latest properties from API
- Updates existing properties
- Adds new properties
- Shows real-time progress
Full Sync Button
- Performs complete synchronization
- Includes delete, update, and insert operations
- Useful for initial setup or major updates
Field Mapping
Default Field Mappings
| Houzez Field | API Field | Description |
|---|---|---|
| post_title | title or name | Property title |
| post_content | description | Property description |
| fave_property_id | propertyId | Unique property ID |
| fave_property_price | price | Property price |
| fave_property_bedrooms | bedRooms | Number of bedrooms |
| fave_property_bathrooms | rentParam.bathrooms | Number of bathrooms |
| fave_property_size | size | Property size (sqft) |
| fave_property_address | region | Property address/region |
Custom Field Mapping
- Access field mapping interface in settings
- Map any API field to any Houzez field
- Supports nested paths (e.g., rentParam.bathrooms)
- Save custom mappings for future imports
License & Subscriptions
License Activation
- License is domain-based (auto-detected)
- No manual license key entry required
- License status shown on dashboard
- Automatic validation on plugin load
Subscription Plans
Free/Basic Plan
- Limited properties
- Core XML import
- Manual imports only
Starter/Pro Plan
- More properties
- Scheduled imports (hourly/daily/weekly)
- Batch processing
Premium/Unlimited Plan
- Unlimited properties
- Hourly auto-sync
- Advanced webhooks
- Priority support
Troubleshooting
Common Issues
Issue: Properties Not Importing
Solutions:
- Verify API endpoint URL is correct
- Check API token is valid
- Ensure license is active
- Check API status on dashboard
- Review error logs in WordPress debug log
Issue: Images Not Uploading
Solutions:
- Check WordPress uploads directory permissions
- Verify wp-content/uploads is writable
- Check PHP allow_url_fopen is enabled
- Ensure sufficient server memory
Issue: CRON Not Working
Solutions:
- Verify CRON is enabled in settings
- Check WordPress CRON is functioning
- Consider using system CRON instead
- Verify server allows scheduled tasks
Debug Mode
Enable WordPress debug mode in wp-config.php:
define('WP_DEBUG', true);
define('WP_DEBUG_LOG', true);
define('WP_DEBUG_DISPLAY', false);
Check logs at: wp-content/debug.log
FAQ
Q: How often should I sync properties?
A: Depends on how often your PIXXI CRM data changes. Daily or hourly is common. Higher-tier plans support more frequent syncs.
Q: Will existing properties be overwritten?
A: Yes, if a property exists (matched by SKU/ID), it will be updated with latest API data.
Q: Can I customize which fields are imported?
A: Yes, use the field mapping interface to customize which API fields map to which Houzez fields.
Q: What happens if a property is removed from PIXXI CRM?
A: If “Automatic Delete” is enabled, the property will be deleted from WordPress during sync.
Q: Can I pause a sync in progress?
A: Yes, use the “Pause” button. You can resume later with “Resume” or restart with “Update Properties”.
Support
Built-in Support System
Creating a Support Ticket
- Click “Support” on the dashboard
- Fill out the support form
- Submit the ticket
- Track responses in the support interface
Support Ticket Features
- Real-time ticket creation
- Automatic system information capture
- Ticket status tracking
- Comment thread for communication
Getting Help
Before Contacting Support
- Check this documentation
- Review troubleshooting section
- Check WordPress debug logs
- Verify API credentials are correct
- Ensure license is active
Additional Resources
- Plugin URI: https://devmizan.com
- Author: Dev Mizan
- Support: Via built-in ticket system
Last updated: