sylius/gmv-bundle

Lightweight local command to calculate the Sylius instance GMV within a specific period

Installs: 15 306

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 6

Forks: 3

Open Issues: 0

Type:symfony-bundle

v1.0.0 2024-12-06 05:20 UTC

This package is auto-updated.

Last update: 2024-12-11 14:56:35 UTC


README

GmvBundle

Lightweight local command to calculate the Sylius instance GMV within a specific period

Features

  • Calculate GMV for a specified period. Default period is the last whole year.
  • Exclude taxes and shipping costs from GMV calculation.
  • Provide GMV in multiple currencies.

Installation

Add the bundle to your Sylius project:

composer require sylius/gmv-bundle

Usage

Command Line

You can calculate the GMV for a specified period using the Symfony console command:

bin/console sylius:gmv:calculate [periodStart] [periodEnd]

The periodStart and periodEnd arguments are optional and should be in the mm/YYYY format. If not provided, the command will calculate the GMV for the last whole year.

Example

The following command will calculate the GMV for the period from 1 January 2024 to 31 May 2024:

bin/console sylius:gmv:calculate 01/2024 5/2024

Example command output:

GMV Calculation
Period Start: 2024-01-01
Period End: 2024-05-31
GMV in USD: $3,247.28

Contributing

This page contains all the information about contributing to Sylius.

Follow Sylius' Development

If you want to keep up with the updates and latest features, follow us on the following channels:

Bug tracking

Sylius uses GitHub issues. If you have found bug, please create an issue.

MIT License

License can be found here.

Authors

See the list of contributors.