Security hardening of admin actions, and clearer privacy information.<\/p>","1.0.1":"
Paid orders released from hold, and paid pre-orders, are now reported instead of being missed.<\/p>","1.0.0":"
First release. Requires WooCommerce 9.2 or later and PHP 8.1 or later.<\/p>"},"ratings":[],"assets_icons":{"icon-128x128.png":{"filename":"icon-128x128.png","revision":3795194,"resolution":"128x128","location":"assets","locale":"","width":128,"height":128},"icon-256x256.png":{"filename":"icon-256x256.png","revision":3795194,"resolution":"256x256","location":"assets","locale":"","width":256,"height":256}},"assets_banners":{"banner-1544x500.png":{"filename":"banner-1544x500.png","revision":3795194,"resolution":"1544x500","location":"assets","locale":"","width":1544,"height":500},"banner-772x250.png":{"filename":"banner-772x250.png","revision":3795194,"resolution":"772x250","location":"assets","locale":"","width":772,"height":250}},"assets_blueprints":{},"all_blocks":[],"tagged_versions":["1.0.2"],"block_files":[],"assets_screenshots":{"screenshot-1.png":{"filename":"screenshot-1.png","revision":3795194,"resolution":"1","location":"assets","locale":"","width":1280,"height":900},"screenshot-2.png":{"filename":"screenshot-2.png","revision":3795194,"resolution":"2","location":"assets","locale":"","width":1280,"height":900},"screenshot-3.png":{"filename":"screenshot-3.png","revision":3795194,"resolution":"3","location":"assets","locale":"","width":1280,"height":900},"screenshot-4.png":{"filename":"screenshot-4.png","revision":3795194,"resolution":"4","location":"assets","locale":"","width":1280,"height":900},"screenshot-5.png":{"filename":"screenshot-5.png","revision":3795194,"resolution":"5","location":"assets","locale":"","width":1280,"height":900}},"screenshots":{"1":"WooCommerce \u2192 Settings \u2192 Royalties HQ: paste the API address and token from Royalties HQ, and test the connection in one click.","2":"The status page: every month's status, totals and refund cut-off, with Build, Validate, Push and Download CSV.","3":"Unticked products: anything that sold but was left out, with a one-click Include.","4":"The Royalties HQ tab on a product: include it, give it a Royalties HQ product ID, or list the books in a bundle sold as one product.","5":"The Products list shows each product's Royalties HQ status, with bulk actions to include or exclude many at once."}},"plugin_section":[],"plugin_tags":[4956,1779,7143,221910,138902],"plugin_category":[],"plugin_contributors":[282319],"plugin_business_model":[],"class_list":["post-400815","plugin","type-plugin","status-publish","hentry","plugin_tags-authors","plugin_tags-books","plugin_tags-publishing","plugin_tags-royalties","plugin_tags-sales-reports","plugin_contributors-consiliencemedia","plugin_committers-consiliencemedia"],"banners":{"banner":"https:\/\/ps.w.org\/royalties-hq-for-woocommerce\/assets\/banner-772x250.png?rev=3795194","banner_2x":"https:\/\/ps.w.org\/royalties-hq-for-woocommerce\/assets\/banner-1544x500.png?rev=3795194","banner_rtl":false,"banner_2x_rtl":false},"icons":{"svg":false,"icon":"https:\/\/ps.w.org\/royalties-hq-for-woocommerce\/assets\/icon-128x128.png?rev=3795194","icon_2x":"https:\/\/ps.w.org\/royalties-hq-for-woocommerce\/assets\/icon-256x256.png?rev=3795194","generated":false},"screenshots":[{"src":"https:\/\/ps.w.org\/royalties-hq-for-woocommerce\/assets\/screenshot-1.png?rev=3795194","caption":"WooCommerce \u2192 Settings \u2192 Royalties HQ: paste the API address and token from Royalties HQ, and test the connection in one click."},{"src":"https:\/\/ps.w.org\/royalties-hq-for-woocommerce\/assets\/screenshot-2.png?rev=3795194","caption":"The status page: every month's status, totals and refund cut-off, with Build, Validate, Push and Download CSV."},{"src":"https:\/\/ps.w.org\/royalties-hq-for-woocommerce\/assets\/screenshot-3.png?rev=3795194","caption":"Unticked products: anything that sold but was left out, with a one-click Include."},{"src":"https:\/\/ps.w.org\/royalties-hq-for-woocommerce\/assets\/screenshot-4.png?rev=3795194","caption":"The Royalties HQ tab on a product: include it, give it a Royalties HQ product ID, or list the books in a bundle sold as one product."},{"src":"https:\/\/ps.w.org\/royalties-hq-for-woocommerce\/assets\/screenshot-5.png?rev=3795194","caption":"The Products list shows each product's Royalties HQ status, with bulk actions to include or exclude many at once."}],"raw_content":"\n
This plugin is for book publishers who sell from their own WooCommerce shop and want to make book royalties easy using Royalties HQ<\/a>. Every sale of a book earns royalties for its authors and other rights holders. This plugin adds up each book's sales every month and sends them to Royalties HQ, ready for your next royalty run. No more wrangling of manually exported spreadsheets.<\/p>\n\n Royalties HQ imports the figures alongside your other sales channels, so your shop's sales appear on the next royalty statements with ease.<\/p>\n\n Requires a Royalties HQ account.<\/strong> No sales are sent until you connect the plugin to your account and switch sending on. Before that, the plugin contacts Royalties HQ only when you click \"Test connection\", which checks your API address and token and sends no sales.<\/p>\n\n No customer data leaves your shop: no names, email addresses or postal addresses, and no order details. No tax amounts are sent either. Royalties HQ receives each included book's monthly sales totals, the book's identifiers, title and list price, your shop's currency, country and time zone, your deduction settings and your site's address. \"External service\" below lists exactly what is sent and when.<\/p>\n\n Royalties HQ is a service of Consilience Media Limited (registered in England and Wales, company number 04214205), which publishes and maintains this plugin as the official WooCommerce integration for its own platform. WooCommerce is a trademark of Automattic Inc.; this plugin is an independent integration and is not affiliated with or endorsed by Automattic.<\/p>\n\n This plugin sends data to Royalties HQ, at the API address you enter in its settings: your publisher's own Royalties HQ account, such as Your use of Royalties HQ is governed by its Terms<\/a> and Privacy Policy<\/a>.<\/p>\n\n\n To see how a month will look before sending anything, go to WooCommerce \u2192 Royalties HQ and click \"Build\" next to it.<\/p>\n\n The plugin works with WooCommerce's High-Performance Order Storage.<\/p>\n\n\n Yes. The plugin sends sales to your Royalties HQ account, which works out the royalties. Without one you can still build months and download them as a CSV.<\/p><\/dd>\n In automatic mode, on the push day you choose (the 15th by default) of the month after each cycle. Monthly is the default and is recommended, but you can choose every 2, 3, 4, 6 or 12 months to match your royalty periods. Waiting until mid-month lets refunds from the first couple of weeks reduce the month they belong to.<\/p>\n\n In manual mode, nothing is sent until you click Push on the status page, one month at a time, oldest first.<\/p><\/dd>\n Leave them unticked. Only products ticked \"Include in Royalties HQ\" are counted. The \"Unticked products\" report lists anything that sold in a month but wasn't included, so you can include it and rebuild the month if it should have been.<\/p><\/dd>\n Under WooCommerce \u2192 Settings \u2192 Royalties HQ, set ISBN source to the GTIN\/ISBN field or to the custom field your shop uses. A product without a valid ISBN is sent with its SKU, or with the Royalties HQ product ID you set on it.<\/p><\/dd>\n An order counts as a sale once it is paid and is processing, completed or, by default, a paid pre-order. An order on hold is left out until you release it. If its month has already been sent by then, it is reported in the month you release it, and the status page lists it as reported late. Once an order has been reported it stays reported, so putting it on hold and releasing it again never counts it twice. Refunds and cancellations of it are taken off the month it was reported in, or reported later if they come after that month was sent.<\/p>\n\n Under WooCommerce \u2192 Settings \u2192 Royalties HQ, \"Paid pre-orders\" chooses when a pre-order paid in advance is reported. \"Report when paid\" (the default) reports it in the month it was paid. \"Report when released\" waits until it leaves pre-order for processing or completed. A pre-order that is charged when it is released is reported once it has been paid, whichever you choose.<\/p><\/dd>\n Yes, until Royalties HQ imports it. Rebuild the month and push it again; Royalties HQ replaces what it holds. Once a month has been imported into royalty statements, it must be undone in Royalties HQ before it can be sent again.<\/p><\/dd>\n Yes. Use a test token from Royalties HQ. Pushes are then checked in full but nothing is imported, and the status page shows \"validated (test key)\".<\/p><\/dd>\n It shouldn't. Months are built in the background, a batch of orders at a time, using the same job queue WooCommerce uses for its own background work.<\/p><\/dd>\n Its settings, the saved API token and its queued jobs are removed. Its record of each month built and sent, the Royalties HQ fields on your products and the dates it recorded on orders (when each was cancelled, and when each first counted as a sale) are kept, in case you reinstall, unless you tick \"Delete all data on uninstall\" in its settings first.<\/p><\/dd>\n\n<\/dl>\n\n\nWhat it does<\/h4>\n\n
\n
Privacy<\/h4>\n\n
External service (Royalties HQ)<\/h3>\n\n
https:\/\/yourpress.royaltieshq.com\/api\/v1<\/code>. It sends nothing anywhere else.<\/p>\n\n\n
ROYALTIES_HQ_WOO_API_TOKEN<\/code> sets the API token instead of the settings screen. ROYALTIES_HQ_WOO_ALLOW_HTTP<\/code> allows an API address that is not HTTPS; leave it unset on a live shop.<\/li>\n<\/ul>\n\n\n
\/wp-content\/plugins\/royalties-hq-for-woocommerce\/<\/code>, and activate it.<\/li>\n\n
Do I need a Royalties HQ account?<\/h3><\/dt>\n
When are sales sent?<\/h3><\/dt>\n
What if I sell things that aren't books?<\/h3><\/dt>\n
My ISBNs aren't in the SKU field.<\/h3><\/dt>\n
How are pre-orders and orders on hold handled?<\/h3><\/dt>\n
Can I fix a month after it has been sent?<\/h3><\/dt>\n
Can I try it without importing anything?<\/h3><\/dt>\n
Does it slow my shop down?<\/h3><\/dt>\n
What happens when I delete the plugin?<\/h3><\/dt>\n
1.0.2<\/h4>\n\n
\n
1.0.1<\/h4>\n\n
\n
1.0.0<\/h4>\n\n
\n