3brs / sylius-shipment-export-plugin
Shipping export plugin for Sylius
Installs: 657
Dependents: 1
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 5
Open Issues: 1
Type:sylius-plugin
Requires
- php: ^7.3|^8.0
- ext-curl: *
- sylius/sylius: 1.7.*|1.8.*|1.9.*|1.10.*
Requires (Dev)
- behat/behat: ^3.6.1
- behat/mink-selenium2-driver: ^1.4
- dmore/behat-chrome-extension: ^1.3
- dmore/chrome-mink-driver: ^2.7
- friends-of-behat/mink: ^1.8
- friends-of-behat/mink-browserkit-driver: ^1.4
- friends-of-behat/mink-extension: ^2.4
- friends-of-behat/page-object-extension: ^0.3
- friends-of-behat/suite-settings-extension: ^1.0
- friends-of-behat/symfony-extension: ^2.1
- friends-of-behat/variadic-extension: ^1.3
- friendsofsymfony/oauth-server-bundle: ^1.6 || >2.0.0-alpha.0 ^2.0@dev
- lakion/mink-debug-extension: ^2.0.0
- phpspec/phpspec: ^7.0
- phpstan/phpstan: 0.12.88
- phpstan/phpstan-doctrine: 0.12.37
- phpstan/phpstan-symfony: ^0.12.7
- phpunit/phpunit: ^8.5
- sensiolabs/security-checker: ^6.0
- sylius-labs/coding-standard: ^4.0.0
- symfony/browser-kit: ^4.4|^5.2
- symfony/debug-bundle: ^4.4|^5.2
- symfony/dotenv: ^4.4|^5.2
- symfony/intl: ^4.4|^5.2
- symfony/web-profiler-bundle: ^4.4|^5.2
This package is auto-updated.
Last update: 2024-11-30 01:57:50 UTC
README
Shipment Export Plugin
Features
- See list of all ready to ship orders (offline payment method or payment completed for non offline method)
- Mark more orders at once as shipped
- Download CSV for submitting batch shipments with Geis
- Download CSV for submitting batch shipments with Czech Post
- You can easily extend the module to support custom CSV format for other shipping providers
Installation
- Run
$ composer require 3brs/sylius-shipment-export-plugin
. - Register
\ThreeBRS\SyliusShipmentExportPlugin\ThreeBRSSyliusShipmentExportPlugin
in your Kernel. - Import
@ThreeBRSSyliusShipmentExportPlugin/Resources/config/routing.yml
in the routing.yml.
threebrs_shipment_export_plugin:
resource: "@ThreeBRSSyliusShipmentExportPlugin/Resources/config/routing.yml"
prefix: /admin
Usage
You can use predefined CSV type for shipment providers Geis and Czech Post) or write your own exporter.
Your custom exporter has to implement ThreeBRS\SyliusShipmentExportPlugin\Model\ShipmentExporterInterface
and must be defined as service. Check out our sample implementations.
Predefined shipping providers:
- Czech post
ThreeBRS\SyliusShipmentExportPlugin\Model\CeskaPostaShipmentExporter:
public: true
arguments:
$currencyConverter: '@sylius.currency_converter'
tags:
- name: threebrs.shipment_exporter_type
type: 'ceska_posta'
label: 'Česká pošta'
- Geis
ThreeBRS\SyliusShipmentExportPlugin\Model\GeisShipmentExporter:
public: true
arguments:
$currencyConverter: '@sylius.currency_converter'
tags:
- name: threebrs.shipment_exporter_type
type: 'geis'
label: 'Geis'
Development
Usage
- Develop your plugin in
/src
- See
bin/
for useful commands
Testing
After your changes you must ensure that the tests are still passing.
$ composer install $ bin/phpstan.sh $ bin/ecs.sh
License
This library is under the MIT license.