Help
Magento
This guide covers what ParcelPilot needs to connect to Magento (Magento 2), where to find it, and where to enter it in ParcelPilot.
What ParcelPilot needs
- Base URL (your Magento store URL)
- Access Token (Magento integration token)
- Store Code (optional; for multi-store setups)
- Optional tuning:
- Page Size (pagination size for imports)
- Timeout (API timeout)
Where to find it in Magento
Magento Admin → System → Extensions → Integrations (menu names vary slightly by version).
Create an integration
- Click Add New Integration
- Enter a name like ParcelPilot
- On the API tab, select the resources/permissions required
- For import-only: read access to orders/products/customers as needed
- For pushing shipment tracking back: permissions to create shipments / update orders (Magento-specific)
- Save the integration
Activate and get the access token
- Back on the Integrations list, click Activate for the ParcelPilot integration
- Approve the requested access
- Magento will show an Access Token (copy it)
Important: store this token securely.
Store code (optional)
If your Magento has multiple store views, you may need a store code.
Common places to find it:
- Magento Admin → Stores → Settings → All Stores (store view code)
- Or your storefront URLs if they include a code segment
Where to enter it in ParcelPilot
ParcelPilot Admin → Integrations → Client Integrations → create/edit an integration with Platform = Magento.
Fill these fields:
- Base URL →
credentials.magento.base_url(e.g.https://store.example.com) - Access Token →
credentials.magento.access_token - Store Code (optional) →
credentials.magento.store_code
Optional tuning:
- Page Size →
credentials.magento.page_size(default 100) - Timeout (seconds) →
credentials.magento.timeout(default 20)
Operational settings:
- Push shipment confirmations (tracking) back to ecommerce platform →
settings.push_ship_confirms
Troubleshooting
401 Unauthorized
- Ensure the integration is activated.
- Regenerate the token (deactivate/reactivate) if needed.
Base URL issues
- Use the storefront base URL (not the admin URL).
- Ensure HTTPS is correct and the site is reachable from the ParcelPilot server.
Missing orders?
If orders are missing in ParcelPilot, you can manually backfill using Pull Orders on the integration:
Security notes
- Treat the access token like a password.
- Rotate tokens if exposed.