diff --git a/content/applications/sales/sales/ebay_connector/media/ebay-notification-endpoint.png b/content/applications/sales/sales/ebay_connector/media/ebay-notification-endpoint.png new file mode 100644 index 000000000..2f298196e Binary files /dev/null and b/content/applications/sales/sales/ebay_connector/media/ebay-notification-endpoint.png differ diff --git a/content/applications/sales/sales/ebay_connector/media/ebay-your-account.png b/content/applications/sales/sales/ebay_connector/media/ebay-your-account.png new file mode 100644 index 000000000..73a02a1c4 Binary files /dev/null and b/content/applications/sales/sales/ebay_connector/media/ebay-your-account.png differ diff --git a/content/applications/sales/sales/ebay_connector/media/test-notification.png b/content/applications/sales/sales/ebay_connector/media/test-notification.png new file mode 100644 index 000000000..54e66efb3 Binary files /dev/null and b/content/applications/sales/sales/ebay_connector/media/test-notification.png differ diff --git a/content/applications/sales/sales/ebay_connector/media/verification-token.png b/content/applications/sales/sales/ebay_connector/media/verification-token.png new file mode 100644 index 000000000..3c9c39c9e Binary files /dev/null and b/content/applications/sales/sales/ebay_connector/media/verification-token.png differ diff --git a/content/applications/sales/sales/ebay_connector/setup.rst b/content/applications/sales/sales/ebay_connector/setup.rst index 64cc0dd75..dba77614a 100644 --- a/content/applications/sales/sales/ebay_connector/setup.rst +++ b/content/applications/sales/sales/ebay_connector/setup.rst @@ -36,6 +36,117 @@ on **Sync countries and currencies**, then you can fill in all the other fields. When all the fields are filled in, you can synchronize the categories and the policies by clicking on the adequate buttons. +Accept account deletion notifications +===================================== + +Since September 2021, **eBay requires supporting customer account deletion/closure notifications**. +As such, when eBay receives an account request for deletion, all eBay partners must confirm the +reception of the request and take further action if necessary. + +Odoo has a notification endpoint to receive those notifications, confirm the reception of the +request, and handle the first set of actions to anonymize the account details in **Contacts** and +remove the customer's access to the portal. + +.. important:: + Make sure to correctly :ref:`set up your subscription to the marketplace account deletion + notifications ` as eBay may temporarily disable + the related eBay account until the subscription is completed. + +Verify your installation of Odoo is up to date +---------------------------------------------- + +In order to activate the endpoint, the module **eBay Connector - Account Deletion** must be +installed. If your Odoo database was first created after September 2021, the module is installed +automatically and you can proceed to the :ref:`next step `. + +Update Odoo to the latest release +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The notification endpoint is made available through a new Odoo module; to be able to install it, +you must make sure that your Odoo source code is up-to-date. + +- If you use Odoo on Odoo.com or Odoo.sh platform, your code is already up-to-date and you can + proceed to the next step. +- If you use Odoo with an on-premise setup or through a partner, then you must update your + installation as detailed in :doc:`this documentation page ` or by + contacting your integrating partner. + +Update the list of available modules +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +New modules must be *discovered* by your Odoo instance to be available in the :menuselection:`Apps` +menu. + +To do so, activate the :ref:`developer mode `, and go to :menuselection:`Apps -> +Update Apps List`. A wizard will ask for confirmation. + +Install the eBay Connector - Account Deletion update +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. warning:: + You should never install new modules in your production database without testing them in a + duplicate or staging environment. For Odoo.com customers, a duplicate database can be created + from the database management page. For Odoo.sh users, you should use a staging or duplicate + database. For on-premise users, you should use a staging environment - you should contact your + integrating partner for more information regarding how to test a new module in your particular + setup. + +To install the module, go to the :menuselection:`Apps` menu, remove the `Apps` search facet and +search for `ebay`. If the module **eBay Connector - Account Deletion** is present and marked as +installed, your Odoo database is already up-to-date and you can proceed with the next step. If it is +not yet installed, install it now. + +.. _ebay/retrieve-endpoint-details: + +Retrieve endpoint details from Odoo +----------------------------------- + +The endpoint details can be found in :menuselection:`Sales --> Configuration --> Settings --> eBay`. +Click on *Generate Token* to retrieve your **Verification Token**. + +.. image:: media/verification-token.png + :align: center + :alt: Button to generate an eBay verification token in Odoo + +.. _ebay/subscribe-account-deletion-notifications: + +Subscribe to account deletion notifications +------------------------------------------- + +Log in on the `developer portal of eBay `_ and go to **Alerts & +Notifications**. + +.. image:: media/ebay-your-account.png + :align: center + :alt: Overview of the Alerts & Notifications dashboard of eBay + +To subscribe to deletion/closure notifications, eBay needs a few details: + +- An **email address** to send notifications to if the endpoint is unreachable. +- The **endpoint details**: + + - The URL to Odoo's account deletion notification endpoint + - A verification token + +.. image:: media/ebay-notification-endpoint.png + :align: center + :alt: Dedicated fields to enter the endpoint details + +.. tip:: + You can edit the last two fields once the email address field is filled out. + +Verify the connectivity with the endpoint +----------------------------------------- + +After setting the retrieved endpoint details in eBay's dashboard, consider testing the connectivity +with the **Send Test Notification** button. + +You should get the following confirmation message: "A test notification was sent successfully!" + +.. image:: media/test-notification.png + :align: center + :alt: Button to send test notification + Using the updated synchronisation method ======================================== @@ -51,7 +162,9 @@ To switch to the new synchronization mechanism: #. Activate the :ref:`developer mode `. #. Go to :menuselection:`Settings --> Technical --> Scheduled Actions` #. Archive the old synchronization actions (both are named *Ebay: update product status*) -#. Activate the new synchronization actions (*Ebay: get new orders* which runs every 15min by default and *Ebay: synchronise stock (for 'get new orders' synchronisation)* which runs once a day per default) +#. Activate the new synchronization actions (*Ebay: get new orders* which runs every 15min by + default and *Ebay: synchronise stock (for 'get new orders' synchronisation)* which runs once a + day per default) #. Ensure that the **Next Execution Date** for both these actions are in the near future Starting with the next execution date, the new method will be used instead of the old one.