How-To Guide¶
This guide provides step-by-step workflows for common tasks with ADCELL Commission Approval.
How the Plugin Works¶
Data Flow Overview¶
ADCELL API (open commissions) → Plugin (reconciliation with Shopware orders) → Decisions → ADCELL API (approval/cancellation)
Detailed Flow:
- The plugin fetches open commissions from the ADCELL API
- For each commission, the corresponding Shopware order is looked up (via the order number in the "reference" field)
- The decision algorithm checks in this order:
- Is there a program mapping? → If no: Not mapped
- Does the order exist in Shopware? → If no: Cancel
- Is the order cancelled/failed? → Cancel
- Was the delivery fully returned? → Cancel
- Was the payment fully refunded? → Cancel
- Is the payment open/pending? → Cancel
- Did the payment fail? → Cancel
- Has it not been shipped yet? → Cancel
- Is there a partial refund? → Adjust
- Does the cart value deviate (beyond tolerance)? → Adjust
- Everything OK? → Approve
- Decisions are saved as a batch (status: "Prepared")
- You review the results and can override decisions
- When sending, decisions are submitted to the ADCELL API
Amount Calculation¶
The shop value is calculated as follows:
For gross-priced shops (B2C), VAT is automatically deducted. This value is compared against the ADCELL cart value.
Common Workflows¶
How to: Initial Setup¶
Goal: Fully set up the plugin and run the first reconciliation.
Time Required: Approximately 10 minutes
Steps:
- Activate the plugin
- Navigate to:
Extensions → My Extensions -
Activate ADCELL Commission Approval
-
Enable test mode
- Navigate to:
Extensions → My Extensions → ADCELL Commission Approval → Configure - Set Test mode to On
-
Save
-
Create an ADCELL account
- Navigate to:
Orders → ADCELL Commission Approval → Accounts - Create an account with username and password
-
Test the connection
-
Set up program mapping
- Navigate to:
Orders → ADCELL Commission Approval → Program Mapping - Select account → Load programs
-
Create a mapping for each active program to the appropriate sales channel
-
Run the first reconciliation
- Navigate to:
Orders → ADCELL Commission Approval → Reconciliation - Select account and date range (e.g. 30 days)
-
Start reconciliation and review results
-
Disable test mode (after successful review)
- Settings → Set Test mode to Off
Result: The plugin is ready for production. The next reconciliation will send decisions to ADCELL.
How to: Run a Manual Reconciliation¶
Goal: Review open commissions and send decisions to ADCELL.
Steps:
- Start reconciliation
- Navigate to:
Orders → ADCELL Commission Approval → Reconciliation - Select account and date range
-
Start reconciliation
-
Review results
- Use filters to focus on specific decisions (e.g. cancellations only)
-
Override individual decisions via the dropdown if needed
-
Send to ADCELL
- Click Send to ADCELL
- Wait for the confirmation message
Result: All decisions have been submitted to ADCELL. The batch appears in the dashboard.
How to: Resume a Prepared Batch¶
Goal: Open a previously created reconciliation that has not been sent yet and send it.
Steps:
- Open the dashboard
-
Navigate to:
Orders → ADCELL Commission Approval → Dashboard -
Select the batch
- In the "Recent reconciliations" table, find the desired batch (status: "Prepared")
-
Click the date link or use the context menu (three dots) → "View details"
-
Review and send
- Review decisions, adjust if needed
- Click Send to ADCELL
How to: Set Up Automatic Approval¶
Goal: Have commissions reconciled and approved automatically every day.
Prerequisites: - At least one active ADCELL account - Program mappings configured - Shopware message queue worker running
Steps:
- Configure settings
- Navigate to:
Extensions → My Extensions → ADCELL Commission Approval → Configure - Enable automatic approval: On
- Days before auto-accept deadline: 3 (recommended)
-
Save
-
Ensure the message queue is running
- Verify that
bin/console messenger:consumeis running as a cron job or Supervisor process
Result: The plugin runs a daily reconciliation and sends decisions to ADCELL automatically.
Quick Reference¶
| Task | Location | Prerequisites |
|---|---|---|
| Create account | Accounts | ADCELL credentials |
| Set up mapping | Program Mapping | Active account |
| Manual reconciliation | Reconciliation | Account + Mapping |
| Resume batch | Dashboard → Click batch | Prepared batch |
| Auto-approval | Settings | Account + Mapping + Worker |
Best Practices¶
- Test first: Use test mode to verify decisions before going live
- Reconcile regularly: Run reconciliations at least weekly to act before the auto-accept deadline
- Keep mappings current: New ADCELL programs should be mapped to a sales channel promptly
- Set minimum order age: Use the minimum order age (e.g. 14 days) to only approve commissions after the return period has passed
What to Avoid¶
- Do not leave test mode accidentally enabled in production — decisions will not be sent
- Do not run the same reconciliation multiple times without sending previous batches — dashboard statistics only count sent items, but you create unnecessary prepared batches
- Do not set tolerance values too high, as legitimate adjustments may be skipped