Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch from "invoice" to "order details" in our emails. #45395

Merged
merged 6 commits into from Mar 13, 2024

Conversation

barryhughes
Copy link
Member

@barryhughes barryhughes commented Mar 7, 2024

Submission Review Guidelines:

Changes proposed in this Pull Request:

We refer to some of our order emails as 'invoices', which turns out to be problematic for some merchants/in some jurisdictions. This change drops the use of 'invoice', preferring 'order details' instead.

Some existing uses of 'invoice' remain in place (for instance, in relation to class and template names) to preserve backward compatibility and minimize disruption.

Closes #26692.

How to test the changes in this Pull Request:

💡 When testing this, you will benefit from the ability to see the emails dispatched by WooCommerce. So long as your site is configured correctly, 'real emails' are fine for this—otherwise you may benefit from a tool such as Email Log.

Open an existing order for editing, and look at the order actions meta box (typically found in the top right of the screen). You should see an entry reading, "Send order details to customer." Previously, this read, "Email invoice / order details to customer."

Order actions meta box, showing the 'send order details to customer' option.

Select the above option and click on Update. The email should be sent to the customer:

  • The email subject should read Details for order #1234 on My Site (of course, the order number and site name will be different). Previously, it was either Invoice for order #1234 on My Site or Your latest My Site invoice (depending on order payment status).
  • The email header should simply be Details for order #1234. Previously, it was either Invoice for order #1234 or Your invoice for order #1234.
Part of the order details email.

Now visit WooCommerce ▸ Settings ▸ Emails. You should see an entry for the Order details email (previously was referred to as Customer invoice / Order details):

Section of the order admin user interface, showing the newly renamed 'Order details' email.

Finally, consider clicking through via the above admin screen and modifying the settings for this email. Your changes should be reflected just as they would have been before this PR was written.

Changelog entry

  • Automatically create a changelog entry from the details below.

Significance

  • Patch
  • Minor
  • Major

Type

  • Fix - Fixes an existing bug
  • Add - Adds functionality
  • Update - Update existing functionality
  • Dev - Development related task
  • Tweak - A minor adjustment to the codebase
  • Performance - Address performance issues
  • Enhancement - Improvement to existing functionality

Message

Comment

@barryhughes
Copy link
Member Author

As was previously true, the email subject and header text can anyway be defined and overridden by the merchant (via the email settings screen). This change is really intended just to tweak the defaults, since use of 'invoice' is problematic in some contexts and geographies.

@webdados
Copy link
Contributor

webdados commented Mar 7, 2024

"Order details" on the order actions menu and as email name is perfect.

I would set the default email subject to "Details for order #1245 on My Site" and "Details for order #1245" as header.

Copy link
Contributor

github-actions bot commented Mar 7, 2024

Test Results Summary

Commit SHA: f608530

Test 🧪Passed ✅Failed 🚨Broken 🚧Skipped ⏭️Unknown ❔Total 📊Duration ⏱️
API Tests25900202610m 38s
E2E Tests34400803527m 19s

To view the full API test report, click here.
To view the full E2E test report, click here.
To view all test reports, visit the WooCommerce Test Reports Dashboard.

@github-actions github-actions bot added focus: e2e tests Issues related to e2e tests plugin: woocommerce Issues related to the WooCommerce Core plugin. labels Mar 7, 2024
@barryhughes
Copy link
Member Author

I would set the default email subject to "Details for order #1245 on My Site" and "Details for order #1245" as header.

Thanks, @webdados: updated.

@github-actions github-actions bot added the focus: api tests Issues related to API tests. label Mar 7, 2024
@barryhughes barryhughes marked this pull request as ready for review March 7, 2024 20:24
@barryhughes barryhughes requested review from a team and jorgeatorres and removed request for a team March 7, 2024 20:24
Copy link
Contributor

github-actions bot commented Mar 7, 2024

Hi @jorgeatorres,

Apart from reviewing the code changes, please make sure to review the testing instructions as well.

You can follow this guide to find out what good testing instructions should look like:
https://github.com/woocommerce/woocommerce/wiki/Writing-high-quality-testing-instructions

Copy link
Member

@jorgeatorres jorgeatorres left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thank you @barryhughes! Tests well.

Adding that I pushed a tiny commit to fix a typo in a docblock (f608530).

@jorgeatorres jorgeatorres enabled auto-merge (squash) March 13, 2024 19:14
@jorgeatorres jorgeatorres merged commit 3f1dbd5 into trunk Mar 13, 2024
31 checks passed
@jorgeatorres jorgeatorres deleted the fix/26692-order-invoice-nomenclature branch March 13, 2024 19:34
@github-actions github-actions bot added this to the 8.8.0 milestone Mar 13, 2024
@github-actions github-actions bot added the needs: analysis Indicates if the PR requires a PR testing scrub session. label Mar 13, 2024
@alopezari alopezari added needs: external testing Indicates if the PR requires further testing conducted by testers external to the development team. and removed needs: analysis Indicates if the PR requires a PR testing scrub session. labels Mar 14, 2024
@alopezari alopezari added the status: analysis complete Indicates if a PR has been analysed by Solaris label Mar 14, 2024
@webdados
Copy link
Contributor

Thanks for this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
focus: api tests Issues related to API tests. focus: e2e tests Issues related to e2e tests needs: external testing Indicates if the PR requires further testing conducted by testers external to the development team. plugin: woocommerce Issues related to the WooCommerce Core plugin. status: analysis complete Indicates if a PR has been analysed by Solaris
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove "invoice" from the customer invoice email
4 participants