Connect Brick Owl
Learn how to connect your Brick Owl store using API key authentication for automated order synchronization.
Connecting your Brick Owl store enables automated order synchronization. Brick Owl uses a simple API key authentication system, making it straightforward to set up.
Before You Start
Prerequisites
- Active Brick Owl seller account
- Admin access to your Brick Owl account
- Completed settings configuration
What You'll Need
- API Key - Single authentication token with appropriate permissions
Step 1: Access Brick Owl API Settings
- Log into your Brick Owl account
- Visit:
https://www.brickowl.com/api_docs
- Click on the link "API Key"
Step 2: Generate API Key
- Click on "Add API Key"
- Give it a name (e.g. BrickInvoice) and permissions for "Orders View/Edit"
- Enter the generated API Key on the form on the Brick Owl connect form and click "Create" on the Brick Owl website
Step 3: Configure in Platform
- Navigate to:
/home/store/connect/brickowl
- Enter your API key in the provided field
- Click "Connect Brick Owl" to verify the key and save the connection
Connection Status
Status Indicators
- Connected: Green indicator shows successful connection
- Disconnected: Red indicator shows connection issues
- Testing: Yellow indicator during connection validation
Troubleshooting Common Issues
"Invalid API Key"
- Cause: Incorrect or malformed API key
- Solution:
- Verify key is copied exactly from Brick Owl
- Check for extra spaces or characters
- Regenerate key if necessary
"Insufficient Permissions"
- Cause: API key lacks required permissions
- Solution:
- Ensure "Orders View/Edit" permission is enabled
- Regenerate key with correct permissions
- Check that account has necessary access rights
Security Features
API Key Protection
- Encryption: API key is encrypted before storage
- Secure Transmission: HTTPS used for all API communications
Connection Validation
- Real-time Testing: API key verified against live API
- Automatic Cleanup: Invalid credentials are removed automatically
What Happens After Connection
- Orders: New orders are synchronized regularly
- Automated Processing: Orders flow seamlessly to accounting software
Managing Your Brick Owl Connection
Updating API Key
- Click "Edit" on the connection page
- Update API key in the form
- Test connection to verify changes
- Save to update stored credentials
Next Steps
After connecting your Brick Owl store:
- Verify connection status - Ensure status shows "Connected"
- Check initial sync - Wait for first order synchronization
- Connect Brick Owl - If you also use Brick Owl
- Set up accounting - Link your accounting software for complete automation
Ready to connect BrickLink as well? Continue with the Connect BrickLink guide.