Browse project documentation

Tipax

Ersalv0.2.0-beta.2View sourceEnglish / Persian

Nationwide private courier. REST API. Supports label, pickup, branches, and cash-on-delivery.

Configuration

use Eram\Ersal\Provider\Tipax\TipaxConfig;

$config = new TipaxConfig(
    token: 'your-bearer-token',
    sandbox: false,
    baseUrl: null,    // optional override
);
ParameterTypeRequiredDefaultDescription
tokenstringYes—Bearer token from Tipax developer portal
sandboxboolNofalseUse sandbox environment
baseUrl?stringNonullOverride the default API host

Capabilities

  • ✅ ShippingInterface (quote, book, track, cancel)
  • ✅ SupportsLabel
  • ✅ SupportsPickup
  • ✅ SupportsBranches
  • ✅ SupportsCOD

Notes

  • Costs are sent and received in Rials
  • Weight is sent in grams; dimensions in millimeters
  • Verify current endpoint paths with Tipax’s developer portal — the URLs in TipaxProvider reflect common REST conventions

Search documentation

Search across all projects. Close this window to return to your guide.

Tab to navigate · Enter to openEsc to close