3PL Tracking Regex Extractor Documentation

    Overview

    Documentation for WebMe 3PL Tracking Regex Extractor.

    User Documentation

    What this plugin does

    The plugin watches WooCommerce order notes for recognizable tracking numbers, stores matches as structured order data, and lets staff decide which records should become customer-facing.

    Setup

    1. Install and activate WooCommerce.
    2. Activate WebMe 3PL Tracking Regex Extractor.
    3. Open WooCommerce > Tracking Regex.
    4. Choose enabled carriers.
    5. Decide whether to:
      • auto-parse new order notes
      • append confirmed tracking to customer emails
      • require manual confirmation for low-confidence matches
      • retain source note metadata
    6. Save settings.

    Custom carrier JSON

    Each custom carrier entry needs:

    • carrier_id
    • label
    • pattern

    Optional fields:

    • tracking_url
    • confidence
    • required_keywords
    • reason

    Example:

    [
  {
    "carrier_id": "custom_ground",
    "label": "Custom Ground",
    "pattern": "CG\\d{10}",
    "confidence": "medium",
    "required_keywords": ["custom", "ground"],
    "tracking_url": "https://example.test/track/{tracking_number}"
  }
]

    Order workflow

    1. A 3PL note lands on the order.
    2. If auto-parse is enabled, plugin scans the note immediately.
    3. Extracted records appear in the order metabox.
    4. Staff can confirm or dismiss each candidate.
    5. Confirmed records can render in customer emails when email output is enabled.

    Sample note tester

    Settings page includes a sample note tester. Paste raw note content, run the test, and review:

    • carrier match
    • tracking number
    • confidence
    • source
    • keyword hit
    • reason codes

    Current limitations

    • Existing historical notes are not bulk-processed automatically
    • Plugin does not fetch live carrier statuses
    • Customer output is limited to order emails