ParcelPilot
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

  1. Base URL (your Magento store URL)
  2. Access Token (Magento integration token)
  3. Store Code (optional; for multi-store setups)
  4. 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

  1. Click Add New Integration
  2. Enter a name like ParcelPilot
  3. 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)
  4. Save the integration

Activate and get the access token

  1. Back on the Integrations list, click Activate for the ParcelPilot integration
  2. Approve the requested access
  3. 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 URLcredentials.magento.base_url (e.g. https://store.example.com)
  • Access Tokencredentials.magento.access_token
  • Store Code (optional)credentials.magento.store_code

Optional tuning:

  • Page Sizecredentials.magento.page_size (default 100)
  • Timeout (seconds)credentials.magento.timeout (default 20)

Operational settings:

  • Push shipment confirmations (tracking) back to ecommerce platformsettings.push_ship_confirms

Product Data / Units

Magento now uses the shared Product Data / Units section for dimension handling.

  • Auto-detect or use store default preserves the existing Magento behavior. ParcelPilot uses the legacy Magento dimension-unit setting when present and otherwise falls back to Magento's default import path.
  • Fixed override stores a shared dimension-unit override at settings.product_units.dimension_mode = fixed and settings.product_units.dimension_unit.

Magento product weight handling does not currently require a separate integration-level unit override because Magento weights are already treated on the importer's existing canonical path.

Super-admin targeted SKU check

On the Client Integration edit page, super admins have a Check SKU tool for Magento.

Use it when you need to inspect one upstream Magento product by SKU and, when valid, import that exact item immediately.

Current behavior:

  • the modal keeps the lookup result visible instead of relying on a transient notification
  • Parcel Pilot checks the Magento product status and current import-rule eligibility, including disabled-product and simple-product restrictions configured on the integration
  • if the SKU already maps to a Parcel Pilot item, the modal reports that the existing item can be refreshed safely
  • if the product is valid, Import Item imports the exact checked Magento product using the checked Magento product ID rather than re-running an unchecked SKU lookup

Notes:

  • this tool is super-admin-only
  • existing Magento collision and importer protection rules still apply during import
  • if the upstream product changes between check and import, Parcel Pilot rejects the import and asks the operator to run Check SKU again

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.

See also