[ADD] sale_flipkart: add documentation for flipkart connector

task-3179096

content/applications/sales/sales.rst

@@ -21,3 +21,4 @@ deliver and invoice what has been sold.
    sales/products_prices
    sales/amazon_connector
    sales/ebay_connector
+   sales/flipkart_connector

content/applications/sales/sales/flipkart_connector.rst

@@ -0,0 +1,12 @@
+:nosearch:
+
+==================
+Flipkart Connector
+==================
+
+.. toctree::
+   :titlesonly:
+
+   flipkart_connector/features
+   flipkart_connector/setup
+   flipkart_connector/verify

content/applications/sales/sales/flipkart_connector/features.rst

@@ -0,0 +1,53 @@
+===========================
+Flipkart Connector Features
+===========================
+
+The **Flipkart Connector** synchronizes the orders between Flipkart and your Odoo database, which
+reduces considerably the amount of time spent on your Flipkart Seller dashboard, making your
+daily routine a lot easier.
+
+.. _flipkart/supported_features:
+
+Supported Features
+==================
+
+The connector is able to:
+
+- Synchronize (Flipkart to Odoo) all confirmed orders (both FBF and FBS) and their order items which
+  include:
+
+  - the product’s SKU, selling price, flipkart discount and quantity
+  - If the product's SKU is not available in the database,
+    a new product is created with the listed name and SKU of the product
+  - the shipping costs for the product
+
+- Create on Odoo any missing partner related to an order (contact types supported: contact and
+  delivery).
+- Notify Flipkart of a shipping confirmed on Odoo (FBS) in order to pickup the shipment.
+
+
++----------------------+------------------------------+-------------------------------------+
+|                      | Fulfilled By Flipkart (FBF)  | Fulfilled By Seller   (FBS)         |
++======================+==============================+=====================================+
+| **Orders**           | Synchronize shipped and      | Synchronize unshipped and canceled  |
+|                      | canceled orders              | orders                              |
++----------------------+------------------------------+-------------------------------------+
+| **Shipping**         | - Handled By Flipkart        | - Delivery created                  |
+|                      |                              | - Generate Shipping Label           |
+|                      |                              | - Fetch Shipping Label              |
++----------------------+------------------------------+-------------------------------------+
+| **Stock Management** | One stock move created       | - Handled by the delivery           |
+|                      | per sales order item         | - Products available quantity       |
+|                      |                              |   updated from Odoo to Flipkart     |
++----------------------+------------------------------+-------------------------------------+
+| **Confirmation**     | Handled by Flipkart          | Notify Flipkart when confirming     |
+|                      |                              | delivery                            |
++----------------------+------------------------------+-------------------------------------+
+
+.. note::
+   The connector is designed to synchronize orders' data as detailed above. Other actions, such as
+   listing management and managing products, must be managed from Flipkart Seller dashboard.
+
+.. seealso::
+   - :doc:`setup`
+   - :doc:`verify`

content/applications/sales/sales/flipkart_connector/setup.rst

@@ -0,0 +1,57 @@
+==================================
+How to configure Flipkart in Odoo?
+==================================
+
+Create a new Access on Flipkart Seller Account
+==============================================
+
+In order to start syncing Flipkart orders in Odoo, you need to login to your Flipkart seller account on the
+`seller hub <https://seller.flipkart.com/>`_.
+Once you are logged in, you need to follow the following steps to create a new **Access**
+by clicking on top right side of the page :menuselection:`Profile --> Manage Profile` as show in the below image.
+
+.. image:: setup/setup01.png
+  :align: center
+
+Click on **View** next to **Developer Access**
+
+.. image:: setup/setup02.png
+  :align: center
+
+Click on **Create a New Access**
+
+.. image:: setup/setup03.png
+  :align: center
+
+Enter **Application Name** (i.e. Odoo) and **Description**
+
+.. image:: setup/setup04.png
+  :align: center
+
+Now copy the **API key** and **Secret**. It will be needed to configure Flipkart Connector in Odoo
+
+.. image:: setup/setup05.png
+  :align: center
+
+.. important::
+   API key and Secret is confidential must not be shared.
+
+.. _flipkart/configure_connector:
+
+Configure Flipkart Connector in Odoo
+====================================
+
+In Odoo you can find the Flipkart Configuration under :menuselection:`Settings --> Sale --> Flipkart Connector`
+
+.. image:: setup/setup06.png
+  :align: center
+
+Enter the **API key** and **Secret** generated from Flipkart Seller Dashboard as **Client Id** and **Client Secret** and save it.
+Now you have succesfully configured your credentials in Odoo. Now you just need to :ref:`verify your Flipkart credentials<flipkart/verify_credential>`
+
+.. note::
+  Odoo will setup a default Sale Team and Flipkart Location for Flipkart Connector. If not selected by the user.
+
+.. seealso::
+   - :doc:`features`
+   - :doc:`verify`

content/applications/sales/sales/flipkart_connector/verify.rst

@@ -0,0 +1,30 @@
+=======================================================
+Verify your Flipkart Credentials and Manual Sync Orders
+=======================================================
+
+.. _flipkart/verify_credential:
+
+Verify Connection
+=================
+
+To verify your Flipkart credential, Click on **Test button**
+
+.. image:: verify/verify01.png
+  :align: center
+
+Once the test is successful, it means Odoo has verified your credentials with Flipkart. Now, Odoo's automated action will fetch Flipkart orders in every 24hr.
+
+Manual Sync Orders
+==================
+
+You can manually sync Flipkart orders from the last sync date and time performed by Odoo up to the current moment.
+
+You need to click on **Sync Orders** in Flipkart Connector Configuration Panel as show below
+
+.. image:: verify/verify02.png
+  :align: center
+
+Odoo will fetch all the Flipkarts as mentioned in the :ref:`Supported Features<flipkart/supported_features>`
+
+.. seealso::
+   - :doc:`setup`