{"id":20499850,"url":"https://github.com/sherlockode/syliusmondialrelayplugin","last_synced_at":"2025-04-13T18:52:02.767Z","repository":{"id":40564852,"uuid":"472664288","full_name":"sherlockode/SyliusMondialRelayPlugin","owner":"sherlockode","description":"This plugin enables Mondial Relay shipping method on your Sylius website","archived":false,"fork":false,"pushed_at":"2024-04-22T07:35:28.000Z","size":209,"stargazers_count":3,"open_issues_count":0,"forks_count":2,"subscribers_count":6,"default_branch":"main","last_synced_at":"2024-04-23T11:15:03.508Z","etag":null,"topics":["php","sylius"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sherlockode.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-03-22T07:52:57.000Z","updated_at":"2024-08-05T09:32:53.197Z","dependencies_parsed_at":"2024-08-05T09:42:32.310Z","dependency_job_id":null,"html_url":"https://github.com/sherlockode/SyliusMondialRelayPlugin","commit_stats":{"total_commits":71,"total_committers":4,"mean_commits":17.75,"dds":0.4084507042253521,"last_synced_commit":"121397232933843c7ae1d52bdbd4e956194d1a4d"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sherlockode%2FSyliusMondialRelayPlugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sherlockode%2FSyliusMondialRelayPlugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sherlockode%2FSyliusMondialRelayPlugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sherlockode%2FSyliusMondialRelayPlugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sherlockode","download_url":"https://codeload.github.com/sherlockode/SyliusMondialRelayPlugin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248765984,"owners_count":21158296,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["php","sylius"],"created_at":"2024-11-15T18:18:48.700Z","updated_at":"2025-04-13T18:52:02.734Z","avatar_url":"https://github.com/sherlockode.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sherlockode SyliusMondialRelayPlugin\n\n----\n\n[ ![](https://img.shields.io/packagist/l/sherlockode/sylius-mondial-relay-plugin) ](https://packagist.org/packages/sherlockode/sylius-mondial-relay-plugin \"License\")\n[ ![](https://img.shields.io/packagist/v/sherlockode/sylius-mondial-relay-plugin) ](https://packagist.org/packages/sherlockode/sylius-mondial-relay-plugin \"Version\")\n[ ![](https://poser.pugx.org/sherlockode/sylius-mondial-relay-plugin/downloads)](https://packagist.org/packages/sherlockode/sylius-mondial-relay-plugin \"Total Downloads\")\n[ ![Support](https://img.shields.io/badge/support-contact%20author-blue])](https://www.sherlockode.fr/contactez-nous/?utm_source=github\u0026utm_medium=referral\u0026utm_campaign=plugins_mondial_relay)\n\n\n## Table of Content\n\n***\n\n* [Overview](#overview)\n* [Installation](#installation)\n    * [Usage](#usage)\n* [Demo](#demo-sylius-shop)\n* [License](#license)\n* [Contact](#contact)\n\n# Overview\n\n----\nThis plugin enables Mondial Relay shipping method on your Sylius website.\n\n![image](https://user-images.githubusercontent.com/12657400/222396640-ecdf3c1d-7532-4ee9-85d7-44bdf628936c.png)\n\n----\n\n# Installation\n\n----\nInstall the plugin with composer:\n\n```bash\n$ composer require sherlockode/sylius-mondial-relay-plugin\n```\n\nComplete the configuration:\n\n```yaml\n# config/packages/sherlockode_sylius_mondial_relay.yaml\n\nsherlockode_sylius_mondial_relay:\n    wsdl: The mondial relay WSDL\n    merchant_id: Your merchant ID\n    private_key: Your private key\n```\n\nImport routing:\n\n```yaml\n# config/routes.yaml\n\nsherlockode_sylius_mondial_relay_plugin:\n    resource: \"@SherlockodeSyliusMondialRelayPlugin/Resources/config/routing.xml\"\n```\n\nIn your Shipment entity, import the `PickupPointTrait`:\n\n```php\n\u003c?php\n\n// App/Entity/Shipping/Shipment.php\n\nnamespace App\\Entity\\Shipping;\n\nuse Doctrine\\ORM\\Mapping as ORM;\nuse Sherlockode\\SyliusMondialRelayPlugin\\Model\\PickupPointTrait;\nuse Sylius\\Component\\Core\\Model\\Shipment as BaseShipment;\n\n/**\n * @ORM\\Entity\n * @ORM\\Table(name=\"sylius_shipment\")\n */\nclass Shipment extends BaseShipment\n{\n    use PickupPointTrait;\n}\n```\n\nDon't forget to make a migration or a d:s:u after that\n\nUpdate your webpack configuration to add entries both in shop config and admin config:\n```js\n// Shop config\nEncore\n  // ...\n  .addEntry('sherlockode-mondial-relay', './vendor/sherlockode/sylius-mondial-relay-plugin/src/Resources/public/js/entry.js')\n\n// Admin config\nEncore\n  // ...\n  .addEntry('sherlockode-mondial-relay', './vendor/sherlockode/sylius-mondial-relay-plugin/src/Resources/public/js/admin.js')\n```\n\n----\n\n## Usage\n\n### Shipping method configuration\n\nNow you only have to create a new shipping method.\nFor the Shipping charges option, select \"Mondial Relay\"\n\n![image](https://user-images.githubusercontent.com/12657400/222396964-61c3871c-247b-454c-92f4-c1a8e3d13c42.png)\n\n### Google API integration\n\nIn order to show a Google map to select pickup points, you need to enable Google Map API for your token.\nYou can do it in the [Google Cloud Console](https://console.cloud.google.com).\nThen, update the plugin configuration:\n\n```yaml\n# config/packages/sherlockode_sylius_mondial_relay.yaml\n\nsherlockode_sylius_mondial_relay:\n    # ...\n    map_provider: google\n    google_api_key: '%env(GOOGLE_API_KEY)%'\n```\n\nAdditionally, you may want to enable Google Place API to show places suggestions when searching pickup points.\n\n### Open Street Map integration\n\nThis plugin also supports Open Street Map. To enable it, you just have to update the `map_provider` setting in your plugin configuration:\n\n```yaml\n# config/packages/sherlockode_sylius_mondial_relay.yaml\n\nsherlockode_sylius_mondial_relay:\n    # ...\n    map_provider: open_street_map\n```\n\n### Print expedition tickets\n\nWhen an order has been placed with Mondial Relay, you can print the expedition ticket from the Sylius admin.\nGo on the order details page and use the \"Print ticket\" button. \n\n![image](https://user-images.githubusercontent.com/12657400/222398571-bdc7072a-b0ee-483e-9db0-19526983f0da.png)\n\nThis feature can be disabled from the bundle configuration:\n\n```yaml\nsherlockode_sylius_mondial_relay:\n    # ...\n    enable_ticket_printing: false\n```\n\n----\n\n# Demo Sylius Shop\n\n---\n\nWe created a demo app with some useful use-cases of plugins!\nVisit [sylius-demo.sherlockode.fr](https://sylius-demo.sherlockode.fr/) to take a look at it. The admin can be accessed under\n[sylius-demo.sherlockode.fr/admin/login](https://sylius-demo.sherlockode.fr/admin/login) link.\nPlugins that we have used in the demo:\n\n| Plugin name                  | GitHub                                                     | Sylius' Store |\n|------------------------------|------------------------------------------------------------|---------------|\n| Advance Content Bundle (ACB) | https://github.com/sherlockode/SyliusAdvancedContentPlugin | -             |\n| Mondial Relay                | https://github.com/sherlockode/SyliusMondialRelayPlugin    | -             |\n| Checkout Plugin              | https://github.com/sherlockode/SyliusCheckoutPlugin        | -             |\n| FAQ                          | https://github.com/sherlockode/SyliusFAQPlugin             | -             |\n\n## Additional resources for developers\n\n---\nTo learn more about our contribution workflow and more, we encourage you to use the following resources:\n* [Sylius Documentation](https://docs.sylius.com/en/latest/)\n* [Sylius Contribution Guide](https://docs.sylius.com/en/latest/contributing/)\n* [Sylius Online Course](https://sylius.com/online-course/)\n\n## License\n\n---\n\nThis plugin's source code is completely free and released under the terms of the MIT license.\n\n[//]: # (These are reference links used in the body of this note and get stripped out when the markdown processor does its job. There is no need to format nicely because it shouldn't be seen.)\n\n## Contact\n\n---\nIf you want to contact us, the best way is to fill the form on [our website](https://www.sherlockode.fr/contactez-nous/?utm_source=github\u0026utm_medium=referral\u0026utm_campaign=plugins_mondial_relay) or send us an e-mail to contact@sherlockode.fr with your question(s). We guarantee that we answer as soon as we can!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsherlockode%2Fsyliusmondialrelayplugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsherlockode%2Fsyliusmondialrelayplugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsherlockode%2Fsyliusmondialrelayplugin/lists"}