Plugin Settings Reference
Complete Guide to All Plugin Settings
Every setting explained in one place!
__________________________________________________
Accessing Settings
Navigate to Settings:
- WordPress → WooCommerce → Settings
- Click "Shipping" tab
- Click your shipping zone
- Click "Shaloz Shipping"
- Settings page opens
__________________________________________________
Basic Settings Section
Enable/Disable Shaloz Shipping
Setting: Checkbox
Default: Unchecked
What It Does: Turns Shaloz shipping method on/off
When to Enable: After configuration complete and tested
When to Disable: Temporarily stop offering Shaloz (maintenance, issues, etc.)
Example:
- Checked: Customers see Shaloz at checkout
- Unchecked: Shaloz hidden from checkout
__________________________________________________
Method Title
Setting: Text field
Default: "Shaloz Express Delivery"
What It Does: Name customers see for this shipping option
Character Limit: Recommended under 40 characters
Best Practices:
- Clear and descriptive
- Mention speed ("Same-Day", "Express", "Fast")
- Match your brand voice
- Test on mobile (shorter is better)
Examples:
- "Same-Day Local Delivery"
- "Express Delivery by Shaloz"
- "Local Delivery - Today!"
- "Fast Shipping"
__________________________________________________
API Configuration Section
API Environment
Setting: Dropdown
Options:
- Sandbox
- Production
Default: Sandbox
What It Does: Chooses which Shaloz environment to use
Sandbox:
- For testing
- No real charges
- No real deliveries
- Use Sandbox API key
- Test orders don't affect real operations
Production:
- For live orders
- Real charges
- Real deliveries
- Use Production API key
- Actual business operations
When to Change:
- Start in Sandbox
- Switch to Production when ready to go live
- Can switch back to Sandbox for testing
__________________________________________________
API Key
Setting: Text field (password-style)
Required: Yes
Format: Starts with pk_sandbox_ or pk_live_
What It Does: Authenticates connection to Shaloz
Where to Get: Shaloz Portal → Settings → API Keys
Important:
- Must match environment (Sandbox key for Sandbox, Production key for Production)
- Public key only (starts with pk\_)
- Keep secret (but public keys are less sensitive than secret keys)
- Copy entire key, no spaces
Test Connection Button:
- Located below API Key field
- Click after entering key
- Success: "API key is valid! Connection successful"
- Error: Check key is correct and matches environment
__________________________________________________
Webhook Configuration Section
Webhook Secret
Setting: Text field (password-style)
Required: Recommended (not required but highly recommended)
Format: Starts with whsec_
What It Does: Secures webhooks from Shaloz to WooCommerce
Where to Get: Shaloz Portal → Settings → Webhook Secret
Why Important:
- Enables automatic order status updates
- Two-way sync between WooCommerce and Shaloz
- Customer gets tracking updates automatically
- Order marks complete automatically when delivered
Test Webhook Button:
- Click after entering webhook secret
- Tests webhook configuration
- Success: "Webhook test successful"
- Error: Check secret is correct
Your Webhook URL (Display Only)
Setting: Read-only text
Format: https://yoursite.com/wp-json/shaloz/v1/webhook
What It Does: Shows your store's webhook endpoint
What to Do: Copy this and paste in Shaloz Portal Settings
Important:
- Must be HTTPS (secure connection) for production
- HTTP only allowed for localhost (testing)
- Copy exact URL
- Paste in Shaloz Portal → Settings → Webhook URL field
__________________________________________________
Display Options Section
Show Delivery Time Estimate
Setting: Checkbox
Default: Checked
What It Does: Shows estimated delivery time to customers
Display: "Est. 45 min delivery"
Recommended: Keep enabled
Benefits:
- Customers see how fast delivery is
- Increases conversion
- Sets expectations
- Transparency
Example With:
Shaloz Express - Est. 45 min - $X.XX
Example Without:
Shaloz Express - $X.XX
__________________________________________________
Enable Delivery Date Picker
Setting: Checkbox
Default: Unchecked
What It Does: Lets customers choose future delivery date
Display: Calendar at checkout
Date Range: Today to 30 days in future
When to Enable:
- Offer scheduled deliveries
- Gift deliveries
- Customer wants to choose date
When to Disable:
- Same-day delivery focus
- Immediate fulfillment only
- Simpler checkout
Most Stores: Leave unchecked
__________________________________________________
Advanced Settings Section
Debug Mode
Setting: Checkbox
Default: Unchecked
What It Does: Logs all API requests/responses
Log Location: WooCommerce → Status → Logs
File Name: shaloz-for-woocommerce-YYYY-MM-DD.log
When to Enable:
- Initial setup (to verify everything works)
- Troubleshooting issues
- Testing integration
- Checking what's sent to Shaloz
When to Disable:
- After successful testing
- Production use (logs can get large)
- Everything working normally
Viewing Logs:
- Enable Debug Mode
- Perform actions (test checkout, fulfill order, etc.)
- WooCommerce → Status → Logs
- Select Shaloz log file
- See detailed information
What's Logged:
- API requests to Shaloz
- Responses from Shaloz
- Webhook receipts
- Errors and warnings
- Timestamps
__________________________________________________
Save Changes Button
Location: Bottom of settings page
Important: Always click after making changes!
What It Does: Saves all settings to database
Don't Forget:
- Change settings
- Scroll to bottom
- Click "Save changes"
- Success message confirms
__________________________________________________
Recommended Settings
For Testing (Sandbox Mode):
Enable Shaloz Shipping: Checked
Method Title: "Same-Day Delivery (TEST)"
API Environment: Sandbox
API Key: pk_sandbox_yourkey
Webhook Secret: whsec_yoursecret
Show Delivery Time: Checked
Debug Mode: Checked (for testing)
For Production (Live Orders):
Enable Shaloz Shipping: Checked
Method Title: "Same-Day Local Delivery"
API Environment: Production
API Key: pk_live_yourkey
Webhook Secret: whsec_yoursecret
Show Delivery Time: Checked
Debug Mode: Unchecked (unless troubleshooting)
__________________________________________________
Settings Validation
When You Save:
Plugin Checks:
- API key format valid
- Environment and key match
- Webhook secret format valid (if entered)
- Required fields filled
Error Messages:
- "API key is required"
- "Invalid API key format"
- "Test connection failed"
Fix Errors:
- Check each field
- Verify copied entire key
- Test connection
- Save again
__________________________________________________
Troubleshooting Settings
Problem: Changes Not Saving
Fixes:
- Click "Save changes" button
- Check for error messages
- Try different browser
- Check WordPress file permissions
- Disable other plugins temporarily
Problem: Test Connection Always Fails
Check:
- API key is complete (no spaces)
- Environment matches key (Sandbox/Production)
- Your server can make outbound API calls
- Not blocked by firewall
Problem: Settings Reset After Save
Cause: Usually a caching plugin
Fix:
- Clear all caches
- Disable caching temporarily
- Save settings
- Re-enable caching
__________________________________________________
Settings Backup
Recommended:
- Note your settings somewhere safe
- Screenshot settings page
- Document in password manager
- Helps if you need to reinstall
What to Back Up:
- API Environment
- API Key
- Webhook Secret
- Method Title
- All checkbox states
__________________________________________________
Need Help?
Settings Questions?
- Review this article
- Check recommended settings above
- help.shaloz.com
Technical Issues?
- Enable Debug Mode
- Check logs
- Contact help.shaloz.com with log excerpt
Comments
Please sign in to leave a comment.