How to Use

This guide explains how to use the Innosend integration in your daily operations.

Customer Experience

Checkout with Pickup Points

When a customer reaches the checkout shipping step:

1. Enter Shipping Address
2. Customer first enters their address data (city, postcode, phone number)
3. The shipping methods only appear after this information is entered

4. The system automatically geocodes the address

5. Select Shipping Method

6. Customer sees the available shipping methods, including "Innosend Afhalen" (Pickup Points)

• Selecting the Pickup Points option shows available pickup points
• The nearest pickup point is automatically selected based on the entered address

1. Choose Pickup Point
2. Click "Choose Another Pickup Point" to open a modal
3. The modal loads nearby pickup points on an interactive map (OpenStreetMap/Leaflet)
4. Left panel: search by address, filter by carrier (PostNL, DPD, etc.), list of pickup points with distance and opening hours
5. Right panel: map with markers for each pickup point
6. Customer can select a different pickup point and click "Choose this Pickup Point"

1. Complete Order
2. On the "Overview & pay" step, the selected pickup point is neatly shown in the order overview
3. The pickup point name and address appear under "Verzenden naar" (Ship to)
4. The shipping method "Innosend Afhalen - Afhaalpunten" is confirmed in the summary

• Selected pickup point is saved with the order
• Customer receives confirmation with pickup point details

Pickup Point Modal Features

Feature	Description
List View	Scrollable list of pickup points with details
Map View	Interactive map with markers for each location
Search	Search by postal code or city
Filter	Filter by carrier (PostNL, DHL, etc.)
Details	View opening hours, address, and distance
Selection	Click to select a pickup point

---

Store Admin Operations

Viewing Orders with Pickup Points

1. Go to Sales → Orders
2. Open an order
3. The chosen pickup point is neatly displayed in the Pickup Point Information section:
4. Selected pickup point name (e.g. Pakketautomaat - De Buren - Gezondheidscentrum Hoendiep)
5. Pickup point address
6. Carrier icon and shipping method (Innosend Afhalen - Afhaalpunten)

Order Information Display

The pickup point information is neatly displayed in:

• Order view in admin – Shows "Pickup Point Information" section with chosen point and address
• Order confirmation emails – Pickup point displayed in "Verzendinformatie" (Shipping Information)

• Packing slips – Pickup point included on printed documents
• Invoices – Address details included

Checking Order Sync Status

1. Go to Sales → Orders
2. Check the order notes for sync status
3. View logs at var/log/system.log for detailed sync information

---

API Health Monitoring

Testing API Connection

1. Go to Stores → Configuration → Innosend → API Configuration
2. Click Test Connection
3. A success or error message will appear. On success, you'll see "Connection successful! API credentials are valid." with debug information (endpoint, HTTP code, response).

Healthcheck Endpoint

The module provides a public healthcheck endpoint:

GET https://your-store.com/innosend/api/ping

Success Response:

{
    "status": "success",
    "message": "API connection successful"
}

Error Response:

{
    "status": "error",
    "message": "API connection failed: Invalid credentials"
}

---

Order Synchronization

Automatic Synchronization

When enabled, orders are automatically synced to Innosend when:

• An order is placed (if "Sync on Order Place" is enabled)
• Cron runs the retry job (for failed syncs)

Manual Synchronization

Currently, orders are synced automatically. Manual sync functionality via the admin panel is planned for a future release.

Coming Soon

A one-click order import feature is being developed that will allow:

• Bulk order sync from the order grid
• Manual sync button on individual orders
• Simplified integration setup

Monitoring Sync Status

Check order sync status in:

1. Magento Logs
2. var/log/system.log - General sync messages

3. var/log/exception.log - Errors and exceptions

4. Innosend Dashboard

5. View synced orders at dashboard.innosend.eu

---

Status and Tracking Updates

Automatic Status Sync

When enabled, the module automatically:

1. Fetches tracking numbers from Innosend
2. Updates order status based on shipment status
3. Creates shipment records with tracking information

Status Mapping

Innosend Status	Magento Action
Shipped	Create shipment with tracking
Delivered	Update to complete (configurable)
Failed Delivery	Log notification

---

Email Notifications

Order Confirmation

Pickup point information is automatically included in:

• Order confirmation emails
• Shipment notification emails

The following variables are available in email templates:

{{var order.getExtensionAttributes().getPickupPoint().getName()}}
{{var order.getExtensionAttributes().getPickupPoint().getAddress()}}
{{var order.getExtensionAttributes().getPickupPoint().getCity()}}

---

Reports and Analytics

Available Data

Track your Innosend shipping data:

Metric	Location
Orders with pickup points	Sales → Orders (filter by shipping method)
Popular pickup locations	Innosend Dashboard
Sync success rate	Magento logs
Carrier usage	Innosend Dashboard

---

Multi-Store Configuration

Different Settings per Store

You can configure different settings for each store view:

1. Go to any configuration section
2. Select the Store View from the scope selector (top-left)
3. Uncheck "Use Website" to override settings
4. Save configuration

Common Multi-Store Scenarios

Scenario	Configuration
Different carriers per region	Set Allowed Carriers per store view
Different API credentials per brand	Configure API settings per website
Enable/disable pickup points per store	Toggle Enable Pickup Points per store

---

Cron Jobs

The module registers the following cron jobs:

Job	Schedule	Description
innosend_sync_orders	Every 5 minutes	Retry failed order syncs
innosend_status_sync	Configurable	Sync status and tracking updates

Verify Cron is Running

# Check cron status
php bin/magento cron:run --group=default

# View scheduled jobs
php bin/magento cron:status

---

Best Practices

Performance

1. Cache Management
2. Clear cache after configuration changes

3. Use Varnish or Redis for production

4. API Calls

5. Pickup points are fetched on-demand
6. Results are not cached to ensure fresh data

Security

1. API Credentials
2. Use read-only tokens for production deployments
3. Rotate API credentials periodically

4. Never commit credentials to version control

5. Allow Write Operations

6. Keep disabled in test environments
7. Only enable in production when ready

Monitoring

1. Regular Checks
2. Monitor var/log/system.log for errors
3. Check Innosend Dashboard for sync status

4. Test API connection periodically

5. Alerts

6. Set up log monitoring for API errors
7. Monitor cron job execution

---

Common Workflows

New Store Setup

1. Install modules
2. Configure API credentials
3. Test connection
4. Enable pickup points
5. Configure shipping method pricing
6. Enable order sync
7. Place test order
8. Verify in Innosend Dashboard

Going Live

1. Switch Mode from Test to Live
2. Enable "Allow Write Operations"
3. Clear all caches
4. Verify API connection
5. Monitor first production orders

Troubleshooting an Order

1. Check order details for pickup point info
2. View order notes for sync status
3. Check var/log/system.log for related errors
4. Verify order exists in Innosend Dashboard
5. Contact support if issues persist