common maintained by laravelshipping
Laravel Shipping Common
The shared foundation package of the Laravel Shipping Suite. It provides the Laravel shipping API contracts, value objects, DTOs, enums, events, and exceptions used by UPS, FedEx, USPS, DHL, rate shopping, address validation, tracking, and shipping label packages.
Use this package when you want a consistent Laravel interface for carrier integrations, shipping rates, shipment requests, label generation, tracking events, return labels, and address validation results.
Installation
composer require laravelshipping/common
Publish Configuration
php artisan vendor:publish --tag=laravelshipping-common-config
What's Included
| Component | Description |
|---|---|
CarrierInterface |
The single contract all carriers implement |
| Value Objects | ShipFrom, ShipTo, Package, Dimensions, Money, Address |
| DTOs | RateRequest, ShipmentRequest, ShipmentResult, AddressValidationResult |
| Collections | RateCollection, TrackingEventCollection |
| Enums | ServiceType, ReturnType, SignatureOption, LabelFormat |
| Events | RatesRetrieved, ShipmentCreated, ReturnShipmentCreated, ShipmentVoided, TrackingStatusUpdated, RateShopCompleted |
| Exceptions | CarrierException, UnsupportedReturnTypeException |
| Hook Contracts | BeforeQuoteHook, AfterQuoteHook |
| HTTP Controllers | Single-carrier rate/shipment endpoints |
Related Packages
laravelshipping/ups— free MIT-licensed UPS REST API integration for Laravel.- FedEx, USPS, DHL, Rate Shopper, and BoxPacker commercial packages are available from laravelshipping.com.
Documentation
Full documentation at gitlab.com/laravelshipping/docs.
License
MIT — see LICENSE.