Difference between revisions of "Registrar TLD Sync"
(→ResellerClub) |
(→Unable to display TLD cost pricing as currency 'XXX' is not defined with an exchange rate) |
||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
<div class="docs-alert-warning"> | <div class="docs-alert-warning"> | ||
| − | + | This feature requires a domain registrar module that supports TLD pricing (for example, [[Enom]] and all [[ResellerClub|LogicBoxes]] modules). | |
</div> | </div> | ||
| − | The Registrar TLD | + | The '''Registrar TLD Sync''' tool allows import of domain extensions and pricing from supported registrars. On import, a markup amount of either a percentage or a fixed amount can be applied automatically, as well as a rounding amount from a range of options. |
| − | + | You can access this feature at '''Utilities > Registrar TLD Sync'''. | |
==How to Sync TLDs and Pricing== | ==How to Sync TLDs and Pricing== | ||
| − | |||
| − | |||
Choose the domain registrar that you wish to perform the import or sync with by clicking on the relevant icon. | Choose the domain registrar that you wish to perform the import or sync with by clicking on the relevant icon. | ||
| Line 15: | Line 13: | ||
[[File:RegistrarTldSyncStepOneV2.png]] | [[File:RegistrarTldSyncStepOneV2.png]] | ||
| − | If you do not see your desired registrar module in this list, it suggests the domain registrar module you are using does not support the TLD | + | If you do not see your desired registrar module in this list, it suggests the domain registrar module you are using does not support the TLD sync functionality. Try a different registrar or contact the developer of your domain registrar module. |
| − | + | After you choose a domain registrar, the system will establish a connection to the domain registrar and a list of available extensions along with cost pricing. This may take a couple of minutes to download. | |
==Extension List== | ==Extension List== | ||
| − | + | After the system obtains the TLD and pricing information from the domain registrar, you will see a list of all available TLDs in categories. | |
| − | For each TLD, you will see the selling status, minimum registration period, and cost price. | + | For each TLD, you will see the selling status, minimum registration period, and cost price. For TLDs that you are already selling, you will also see the current selling price in bold and the margin for each of the pricing options: '''Register''', '''Renew''', '''Transfer''', and '''Redemption'''. |
| + | |||
| + | The margin is a percentage of the profit (<tt>selling price</tt> - <tt>cost price</tt>) divided by the cost. | ||
[[File:RegistrarTldSyncStepTwo.png]] | [[File:RegistrarTldSyncStepTwo.png]] | ||
| − | Any extensions that are being sold at a loss | + | Any extensions that are being sold at a loss (selling price is below the cost price) will have a red background. |
| − | + | Click '''Pricing''' in the right column to open the WHMCS '''Pricing''' matrix for a given TLD. This allows you to quickly make manual adjustments to the selling pricing of a TLD. | |
| − | + | Like all pricing in WHMCS, making changes to product or domain pricing here applies to new customers only. Existing customers will retain the prices from the time of their signup or order. To adjust pricing for existing customers, see [[Bulk_Pricing_Updater_Addon|Bulk Pricing Updater]]. | |
===Categories=== | ===Categories=== | ||
| − | TLDs | + | The system groups TLDs by category using Enom's category mapping provided. These are the same categories that display domain pricing within the shopping cart. |
| − | A single extension may appear in more than one category | + | A single extension may appear in more than one category. Selecting the extension on one category will automatically select it in any categories it appears in. |
| − | If a category is empty or | + | If a category is empty or the currently-selected domain registrar does not return any TLDs, the category will not display. |
===Sync Options=== | ===Sync Options=== | ||
| − | Set the desired margin type and profit margin options for the import process | + | Set the desired margin type and profit margin options for the import process: |
| − | * Margin Type | + | * '''Margin Type''' — ''Percentage'' or ''Fixed''. The type of margin to apply to the imported extensions. |
| − | * Profit Margin | + | * '''Profit Margin''' — Numerical. Depending on the '''Margin Type''' value, the amount to apply to the imported extension registrar pricing. |
| − | * Round to Nearest | + | * '''Round to Nearest''' — Choose the number to round up to when setting the import pricing. For example, <tt>x.95</tt> will set all pricing to the next <tt>.95</tt>. |
| − | * Sync Redemption/Grace Fee | + | * '''Sync Redemption/Grace Fee''' — Whether to import the redemption and grace fees and apply the same markup. Not all registrars support a grace fee. |
| − | * Automatic Registration | + | * '''Automatic Registration''' — Whether to sync the TLD's auto register value to the synced registrar. |
[[File:RegistrarTldSyncStepTwoPart2.png]] | [[File:RegistrarTldSyncStepTwoPart2.png]] | ||
| + | |||
| + | ====ResellerClub==== | ||
| + | |||
| + | Due to limitations with the ResellerClub API, the prices this returns exclude any taxes that ResellerClub charges. If ResellerClub levies a tax on your account, adjust the '''Profit Margin''' setting to include taxes plus the desired profit margin. | ||
===Auto-select TLDs associated with Registrar=== | ===Auto-select TLDs associated with Registrar=== | ||
| − | + | ||
| + | Click to automatically select all configured TLDs within the WHMCS installation to automatically register them with the selected domain registrar. | ||
===Performing the Import=== | ===Performing the Import=== | ||
| − | To perform the import process, click | + | |
| + | To perform the import process, click '''Import TLDs''' at the top or bottom of the domain extensions pricing matrix table. | ||
==Import Complete== | ==Import Complete== | ||
| − | + | After completion of an import, a confirmation screen will list all of the imported and updated extensions. | |
[[File:RegistrarTldSyncStepThree.png]] | [[File:RegistrarTldSyncStepThree.png]] | ||
| − | If any errors occurred importing or updating an extension, | + | If any errors occurred importing or updating an extension, they will appear separately. |
==Currency== | ==Currency== | ||
| − | |||
| − | + | Domain registrars can return TLD cost pricing information in any currency they define. Typically, cost pricing information returns in the primary currency of your domain registrar or based on a setting within your domain registrar account. | |
| − | + | Regardless of the currency cost pricing returns in, WHMCS will always convert and display pricing in your WHMCS system default currency. | |
| − | If a currency is encountered that does not exist in WHMCS, or for which no exchange rate | + | For this reason, you must ensure that you always have set up and configured this returned currency with a valid exchange rate before you attempt to sync. |
| + | |||
| + | If a currency is encountered that does not exist in WHMCS, or for which there is no exchange rate, you will see a message indicating the currency to add: | ||
[[File:RegistrarTLDSyncNoCurrency.png]] | [[File:RegistrarTLDSyncNoCurrency.png]] | ||
| − | When a pricing import and synchronisation | + | When the system performs a pricing import and synchronisation, it will also set pricing for all active currencies in WHMCS. |
| + | |||
| + | * Currency conversion uses the rates at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Currencies]]''' or, prior to WHMCS 8.0, '''Setup > Currencies'''. | ||
| + | * Any rounding that you define in the [[#Sync_Options|sync options]] will apply after the conversion. | ||
==Troubleshooting== | ==Troubleshooting== | ||
| + | |||
===Unable to display TLD cost pricing as currency 'XXX' is not defined with an exchange rate=== | ===Unable to display TLD cost pricing as currency 'XXX' is not defined with an exchange rate=== | ||
| − | This message occurs when a currency in WHMCS is missing, or does not have an exchange rate. Navigate to ''' | + | |
| + | This message occurs when a currency in WHMCS is missing, or does not have an exchange rate. Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Currencies]]''' or, prior to WHMCS 8.0, '''Setup > Payments > Currencies''' and either add or update the currency. | ||
==Developer Documentation== | ==Developer Documentation== | ||
| − | |||
| − | + | To add support for TLD syncing to a custom or third-party registrar module, see our [https://developers.whmcs.com/domain-registrars/ Registrar Module] documentation. | |
| − | |||
| − | |||
Latest revision as of 20:23, 5 May 2022
This feature requires a domain registrar module that supports TLD pricing (for example, Enom and all LogicBoxes modules).
The Registrar TLD Sync tool allows import of domain extensions and pricing from supported registrars. On import, a markup amount of either a percentage or a fixed amount can be applied automatically, as well as a rounding amount from a range of options.
You can access this feature at Utilities > Registrar TLD Sync.
Contents
How to Sync TLDs and Pricing
Choose the domain registrar that you wish to perform the import or sync with by clicking on the relevant icon.
If you do not see your desired registrar module in this list, it suggests the domain registrar module you are using does not support the TLD sync functionality. Try a different registrar or contact the developer of your domain registrar module.
After you choose a domain registrar, the system will establish a connection to the domain registrar and a list of available extensions along with cost pricing. This may take a couple of minutes to download.
Extension List
After the system obtains the TLD and pricing information from the domain registrar, you will see a list of all available TLDs in categories.
For each TLD, you will see the selling status, minimum registration period, and cost price. For TLDs that you are already selling, you will also see the current selling price in bold and the margin for each of the pricing options: Register, Renew, Transfer, and Redemption.
The margin is a percentage of the profit (selling price - cost price) divided by the cost.
Any extensions that are being sold at a loss (selling price is below the cost price) will have a red background.
Click Pricing in the right column to open the WHMCS Pricing matrix for a given TLD. This allows you to quickly make manual adjustments to the selling pricing of a TLD.
Like all pricing in WHMCS, making changes to product or domain pricing here applies to new customers only. Existing customers will retain the prices from the time of their signup or order. To adjust pricing for existing customers, see Bulk Pricing Updater.
Categories
The system groups TLDs by category using Enom's category mapping provided. These are the same categories that display domain pricing within the shopping cart.
A single extension may appear in more than one category. Selecting the extension on one category will automatically select it in any categories it appears in.
If a category is empty or the currently-selected domain registrar does not return any TLDs, the category will not display.
Sync Options
Set the desired margin type and profit margin options for the import process:
- Margin Type — Percentage or Fixed. The type of margin to apply to the imported extensions.
- Profit Margin — Numerical. Depending on the Margin Type value, the amount to apply to the imported extension registrar pricing.
- Round to Nearest — Choose the number to round up to when setting the import pricing. For example, x.95 will set all pricing to the next .95.
- Sync Redemption/Grace Fee — Whether to import the redemption and grace fees and apply the same markup. Not all registrars support a grace fee.
- Automatic Registration — Whether to sync the TLD's auto register value to the synced registrar.
ResellerClub
Due to limitations with the ResellerClub API, the prices this returns exclude any taxes that ResellerClub charges. If ResellerClub levies a tax on your account, adjust the Profit Margin setting to include taxes plus the desired profit margin.
Auto-select TLDs associated with Registrar
Click to automatically select all configured TLDs within the WHMCS installation to automatically register them with the selected domain registrar.
Performing the Import
To perform the import process, click Import TLDs at the top or bottom of the domain extensions pricing matrix table.
Import Complete
After completion of an import, a confirmation screen will list all of the imported and updated extensions.
If any errors occurred importing or updating an extension, they will appear separately.
Currency
Domain registrars can return TLD cost pricing information in any currency they define. Typically, cost pricing information returns in the primary currency of your domain registrar or based on a setting within your domain registrar account.
Regardless of the currency cost pricing returns in, WHMCS will always convert and display pricing in your WHMCS system default currency.
For this reason, you must ensure that you always have set up and configured this returned currency with a valid exchange rate before you attempt to sync.
If a currency is encountered that does not exist in WHMCS, or for which there is no exchange rate, you will see a message indicating the currency to add:
When the system performs a pricing import and synchronisation, it will also set pricing for all active currencies in WHMCS.
- Currency conversion uses the rates at Configuration () > System Settings > Currencies or, prior to WHMCS 8.0, Setup > Currencies.
- Any rounding that you define in the sync options will apply after the conversion.
Troubleshooting
Unable to display TLD cost pricing as currency 'XXX' is not defined with an exchange rate
This message occurs when a currency in WHMCS is missing, or does not have an exchange rate. Navigate to Configuration () > System Settings > Currencies or, prior to WHMCS 8.0, Setup > Payments > Currencies and either add or update the currency.
Developer Documentation
To add support for TLD syncing to a custom or third-party registrar module, see our Registrar Module documentation.