[ADD] sale_flipkart: add documentation for flipkart connector

task-3179096

Author: hamo-odoo

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/manual_sync

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:`manual_sync`

content/applications/sales/sales/flipkart_connector/manual_sync.rst

@@ -0,0 +1,18 @@
+==================
+Manual Sync Orders
+==================
+
+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/verify01.png
+  :align: center
+
+Odoo will fetch all the Flipkarts as mentioned in the :ref:`Supported Features<flipkart/supported_features>`
+
+.. seealso::
+   - :doc:`setup`

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

@@ -0,0 +1,32 @@
+==================================
+How to configure Flipkart in Odoo?
+==================================
+
+Connect Flipkart with OAuth
+===========================
+
+In Odoo you can find the Flipkart Configuration under :menuselection:`Settings --> Sale --> Flipkart Connector`
+
+.. image:: setup/setup01.png
+  :align: center
+
+All you have to do is click on the Connect button and you will be redirected to Flipkart Permission Registration page
+
+.. image:: setup/setup02.png
+  :align: center
+
+After successful login, seller would be presented with a Request for Authorization dialog.
+
+.. image:: setup/setup03.png
+  :align: center
+
+After clicking on Allow you will be redirected to Odoo back and now you can sync your flipkart orders to Odoo
+
+.. image:: setup/setup04.png
+  :align: center
+.. note::
+  Odoo will setup a default Sale Team and Flipkart Location for Flipkart Connector.
+
+.. seealso::
+   - :doc:`features`
+   - :doc:`manual_sync`