spiderweb / sylius-sendcloud-plugin
Sylius 2 plugin for SendCloud shipping automation
Package info
github.com/Zalastan/sylius-sendcloud
Type:sylius-plugin
pkg:composer/spiderweb/sylius-sendcloud-plugin
Requires
- php: >=8.2
- psr/cache: ^1.0 || ^2.0 || ^3.0
- sylius/core-bundle: ^2.0
- sylius/shipping-bundle: ^2.0
- symfony/cache: ^6.4 || ^7.0
- symfony/form: ^6.4 || ^7.0
- symfony/http-client: ^6.4 || ^7.0
- symfony/routing: ^6.4 || ^7.0
- symfony/ux-live-component: ^2.0
- symfony/ux-twig-component: ^2.0
Requires (Dev)
- phpunit/phpunit: ^11.0
README
Sylius 2 plugin for SendCloud shipping automation. Automatically creates parcels in SendCloud when a shipment is marked as shipped, and stores the tracking number back on the shipment.
Features
- Creates a SendCloud parcel automatically on the
shipworkflow transition - Stores the tracking number returned by SendCloud on the Sylius shipment
- Encrypts API credentials at rest using libsodium (
ext-sodium) - Admin configuration page under
/admin/sendcloud/configuration
Requirements
- PHP 8.2+
- Sylius 2.0+
ext-sodium
Installation
composer require spiderweb/sylius-sendcloud-plugin
Register the plugin in your Symfony application:
// config/bundles.php return [ // ... SpiderWeb\Sylius\SendCloudPlugin\SendCloudPlugin::class => ['all' => true], ];
Import the routes:
# config/routes/sendcloud.yaml spiderweb_sendcloud: resource: "@SendCloudPlugin/config/routes.yaml"
Run the database migration:
php bin/console doctrine:migrations:diff php bin/console doctrine:migrations:migrate
Configuration
Go to Admin → SendCloud and enter your SendCloud API credentials (Settings → Integrations → API in your SendCloud account).
API keys are encrypted in the database using your application's APP_SECRET. If APP_SECRET changes, you will need to re-enter the credentials.
License
MIT — Spider Web