cline/shipit

Shipit SDK for PHP

1.0.0 2025-10-22 05:10 UTC

Requires

• php: ^8.4.0
• saloonphp/laravel-plugin: ^3.6
• saloonphp/pagination-plugin: ^2.2
• saloonphp/saloon: ^3.14
• spatie/laravel-data: ^4.18

Requires (Dev)

• cline/php-cs-fixer: ^1.0.4
• driftingly/rector-laravel: ^2.1.0
• ergebnis/composer-normalize: ^2.49@dev
• laravel/pint: ^1.25.1
• orchestra/testbench: ^10.6
• pestphp/pest: ^3.8.4
• pestphp/pest-plugin-laravel: ^3.2
• pestphp/pest-plugin-type-coverage: ^3.6.1
• phpstan/phpstan: ^2.1.31
• rector/rector: ^2.2.3
• symfony/var-dumper: ^7.3.4

MIT

• Brian Faust

• php
• sdk
• shipit

README

Shipit SDK

A Saloon v3-based PHP SDK for the Shipit API with Spatie Laravel Data v4 DTOs.

Requirements

Requires PHP 8.4+

Installation

composer require cline/shipit

Quick Start

use Cline\Shipit\Connector\ShipitConnector;

// Auto-detect environment (production uses live, non-production uses test)
$shipit = ShipitConnector::new('your-api-token');

// Or explicitly choose environment
$shipit = ShipitConnector::live('your-api-token');  // Production
$shipit = ShipitConnector::test('your-api-token');  // Test environment

Documentation

Comprehensive cookbooks covering all SDK features:

• Getting Started - Installation and basic setup
• Shipping Methods - Query carriers and rates
• Creating Shipments - Create shipments and labels
• Service Points - Find pickup/delivery locations
• Postal Codes - Validate addresses
• Tracking - Track shipments
• Locations - Manage addresses
• Organizations - Manage organizations
• User Management - User accounts
• Balance & Accounting - Financial reporting
• Advanced Features - Carrier contracts, templates, batch processing
• Error Handling - Robust error handling
• Testing - Testing strategies

Features

• Saloon v3 - Modern HTTP client abstraction
• Spatie Laravel Data v4 - Type-safe DTOs
• Full API Coverage - All Shipit API endpoints
• Typed Responses - Complete IDE autocomplete support
• Error Handling - Automatic exception throwing on errors
• Multiple Environments - Easy switching between test/live APIs

Architecture

The SDK uses:

• Saloon v3 for HTTP client abstraction
• Spatie Laravel Data v4 for type-safe DTOs
• Strictly typed based on API form request validations

Change log

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security

If you discover any security related issues, please use the GitHub security reporting form rather than the issue queue.

Credits

• Brian Faust
• All Contributors

License

The MIT License. Please see License File for more information.