Console Commands

• On this Page

  • example-templates
  • reset-data
  • upgrade

Commerce adds console commands that can be run in your terminal.

See Craft’s Console Commands page for more about using console commands.

example-templates

Customizes and copies example templates into your project’s template folder.

$ php craft commerce/example-templates
A folder will be copied to your templates directory.
Choose folder name: [shop] myshop
Use CDN link to resources (tailwind)? (yes|no) [yes]: yes
Base Tailwind CSS color: [gray,red,yellow,green,blue,indigo,purple,pink,?]: green
Attempting to copy example templates ... 
Copying ...
Done!

reset-data

Cleanses Commerce data without uninstalling the plugin or removing store configuration. This can be useful for removing test data after finishing initial project development.

Deletes all orders, subscriptions, payment sources, customers, addresses and resets discount usages.

php craft commerce/reset-data

upgrade

Support command for the Commerce 3 → Commerce 4 upgrade process, meant to be run after upgrading to Commerce 4.

php craft commerce/upgrade

It goes through several steps to ensure the best-possible migration:

1. Checks that the standard migration has already been run.
2. Prompts for any custom countries that should be swapped to valid two-letter country codes, which will be used to update all addresses and zones.
3. Prompts to select an existing field handle or create a new custom field on the fly for any legacy address fields that were used with Commerce 3:
   • title
   • address3
   • businessId
   • phone
   • alternativePhone
   • custom1
   • custom2
   • custom3
   • custom4
   • notes
4. Converts all legacy customers without user accounts into users.
5. Converts all existing addresses to address elements.
6. Links all user addresses to the appropriate address elements.
7. Links all order addresses to the appropriate address elements.
8. Maps each user’s primary billing and shipping IDs to the appropriate address elements.
9. Creates tax and shipping zone conditions based on legacy country and state lists.
10. Links the store location address to the appropriate address element.
11. Links order history records to their appropriate user accounts.
12. Migrates previously-enabled countries to the store’s Country List and creates an Order Address Condition as needed.