Ersal Documentation

Type-safe PHP library for Iranian shipping and courier services.

Learning Resources

• Getting Started — Install and book your first shipment in 5 minutes
• Core Concepts — Lifecycle, provider model, and design principles
• Cookbook — Practical recipes for common scenarios
• FAQ — Design decisions and common questions

Provider Catalog

• Iran Post
• Tipax
• Chapar
• Mahex
• Amadast
• Paygan
• Alopeyk

Technical Reference

• API Reference — Complete class and method reference
• Money & Currency — Amount value object, Rial/Toman safety
• Addresses & Parcels — Phone/postal-code normalization, grams/mm
• Tracking & Webhooks — Polling pattern, webhook bridging
• Events — Shipment lifecycle events
• Error Handling — Exception hierarchy and provider error codes
• HTTP & Logging — Custom HTTP clients, loggers, SOAP