Zamp for Shopware: Technical Reference

Technical Reference

API Documentation

The Zamp Tax plugin integrates with the following API endpoints:

Authentication

  • Bearer token authentication required
  • API token configured in plugin settings
  • All requests include header: Authorization: Bearer {token}

Endpoints

Endpoint Method Description
https://api.zamp.com/calculations POST Calculate tax rates for orders
https://api.zamp.com/transactions POST Record completed transactions
https://api.zamp.com/transactions/{id} GET Retrieve transaction details
https://api.zamp.com/transactions/{id} DELETE Remove transaction record

Data Structure

Tax Provider Configuration

{
    'id': UUID,
    'identifier': 'ZampTax\Checkout\Cart\Tax\ZampTax',
    'priority': 1,
    'active': boolean,
    'availabilityRuleId': UUID
}

Translation Entity

{
    'taxProviderId': UUID,
    'languageId': UUID,
    'name': 'Zamp Tax'
}

Event Subscribers

The plugin listens for the following Shopware events:

Event Purpose
Order Written Event Trigger tax calculations on order creation
Order Transaction Status Change Handle paid and refund status changes
Order Delete Event Remove associated transaction records

Database Schema

Main Tables

  • zamp_settings
    • id (primary key)
    • api_token
    • taxable_states
    • calculations_enabled
    • transactions_enabled
    • retain_logs
  • zamp_transactions
    • id (primary key)
    • order_id
    • first_version_id
    • order_number
    • current_id_suffix
    • status
  • zamp_product_tax_codes
    • id (primary key)
    • product_id
    • product_tax_code

Related Shopware Tables

  • tax_provider - Stores tax provider configuration
  • tax_provider_translation - Stores localized tax provider names
  • rule - Stores availability rules for tax provider
Note: Database migrations are handled automatically during plugin installation/update.