[IMP] api: Add and enhance multiple endpoints for improved functionality #25

JAntonioSalas · 2024-05-14T21:05:01Z

Summary

This pull request introduces improvements and new features across multiple endpoints to enhance the overall functionality and user experience of the system. The changes include better error handling, more detailed responses, and additional validation.

Changes Included

/create_schedule_activity_invoice
- Added documentation and improved error handling for creating scheduled activities related to invoices.
/get_states_mexico
- Enhanced endpoint to retrieve the list of states in Mexico with improved error handling and detailed responses.
/get_inventory_by_sku
- Updated endpoint to retrieve inventory details based on SKU, ensuring accurate and detailed information is returned.
/get_inventory
- Improved retrieval of inventory details for all products with a SKU, providing more detailed responses.
/send_message_sale_order
- Added functionality to post messages to sale orders, with improved logging and error handling.
/create_schedule_activity
- Enhanced the creation of scheduled activities related to sale orders, including additional validation and detailed responses.
/confirm_sale_order
- Simplified the process of confirming sale orders, with detailed logging and responses.
/send_invoice_by_email/int:invoice_id
- Improved the functionality for sending invoices by email, ensuring better user feedback and error handling.
/stamp_invoice/int:invoice_id
- Enhanced the invoice stamping process, including detailed error messages and success responses.
/download_invoice/int:invoice_id
- Streamlined the invoice download process to generate and deliver PDFs more efficiently.
/get_shipping_info/<model("sale.order"):order>
- Added functionality to retrieve detailed shipping information for sale orders, including delivery address details and shipping records.
/register_payment_invoice/<model("account.move"):invoice>
- Improved the payment registration process for invoices, ensuring accurate logging and error handling.
/invoice_sale_order
- Enhanced the process of invoicing sale orders, including better handling of invoice creation and posting.
/update_sale_order
- Improved the update process for sale orders, with better validation and detailed logging.
/create_sale_order
- Enhanced the creation process for sale orders, with better validation and handling of optional fields.
/delivery_address
- Improved the process for creating or updating delivery addresses, including better handling of address formatting and validation.
/address_invoice
- Enhanced the process for creating or updating billing addresses, ensuring better validation and error handling.
/update_contact
- Improved the contact update process, with better validation and detailed logging.
/create_contact
- Enhanced the contact creation process with better search logic and validation based on email, phone, or store name.
README.rst
- README.rst for module documentation

Related PR

Closes Hantec API Ecommerce #24 (close related PR on GitHub)

Please review the changes and provide feedback. Thank you!

hantec_api_ecommerce/__init__.py

hugho-ad · 2024-05-16T18:19:56Z

hantec_api_ecommerce/__manifest__.py

+    "installable": True,
+    "development_status": "Production/Stable",
+    "maintainers": ["C&O PROJECTS AND SOLUTIONS"],
+}


hantec_api_ecommerce/controllers/__init__.py

hantec_api_ecommerce/controllers/main.py

hugho-ad · 2024-05-16T18:47:35Z

hantec_api_ecommerce/controllers/main.py

+            }
+        )
+        logger.info(
+            "Scheduled activity created with ID %s for invoice %s",


do you really need this log?

what about move it as logger.debug

hugho-ad · 2024-05-16T18:48:55Z

hantec_api_ecommerce/controllers/main.py

+        """
+        # Delivery address data
+        shipping_address = order.partner_shipping_id
+        address_data = {


better use
shipping_address.read([fields])

hugho-ad · 2024-05-16T18:51:27Z

hantec_api_ecommerce/controllers/main.py

+            ),
+        }
+
+        # Get related shipping records


what about to move this logic to the model picking or order itself?

you will need to createa dir
models/sale_order.py

and inside the sale_order.py you create the get method with all this logic, this is in order to separated the controllers and the data models

- Moved the logic of retrieving shipping information from the controller to the sale.order model to improve code maintainability. - Added the method get_shipping_info in the sale_order.py model to handle the retrieval of detailed shipping information, including address and picking data. Updated the controller to call the new model method, ensuring a cleaner and more modular design. - Added a route to retrieve states by country, which enhances the flexibility of the application in handling different countries dynamically. Implemented the get_inventory and get_inventory_by_sku methods in the controller to provide comprehensive inventory data based on SKUs. - Ensured that __init__.py and __manifest__ files include EOF. - Get the sales order through the sales order model. - Combined get_inventory and get_inventory_by_sku endpoints into a single endpoint in the controller. This unified approach simplifies the API and improves code maintainability. Implemented logic to handle both GET (all products with SKUs) and POST (specific product by SKU) requests in the same method. - Refactored the endpoint for scheduling activities related to invoices to use the invoice.activity_schedule method. These changes improve the modularity, readability, and maintainability of the codebase, making it easier to manage and extend in the future. Closes #25

Modified the get_inventory endpoint to allow filtering of inventory based on a given location. This enhancement improves the ability to retrieve inventory details specific to a stock location, providing more targeted and relevant data. This change ensures that users can query inventory data specific to a particular stock location, enhancing the accuracy and usefulness of the inventory information provided by the endpoint. Closes #25

Modified the get_inventory endpoint to allow filtering of inventory based on a given location for GET requests. This enhancement improves the ability to retrieve inventory details specific to a stock location, providing more targeted and relevant data. This change ensures that users can query inventory data specific to a particular stock location, enhancing the accuracy and usefulness of the inventory information provided by the endpoint. Closes #25

Modified the get_inventory endpoint to allow filtering of inventory based on a given location and optionally by SKU. This enhancement improves the ability to retrieve inventory details specific to a stock location and a product SKU, providing more targeted and relevant data. This change ensures that users can query inventory data specific to a particular stock location and product SKU, enhancing the accuracy and usefulness of the inventory information provided by the endpoint. Closes #25

JAntonioSalas · 2024-05-21T03:02:53Z

I made the changes, could you please review it @hugho-ad ?

hugho-ad · 2024-05-21T16:03:39Z

hantec_api_ecommerce/controllers/main.py

+
+        inventory_data = []
+        for product in products:
+            quants = request.env["stock.quant"].search([("product_id", "=", product.id), ("location_id", "=", location_id)])


Suggested change

quants = request.env["stock.quant"].search([("product_id", "=", product.id), ("location_id", "=", location_id)])

product.with_context(location=location_id).read(["name", "default_code", "qty_available", "virtual_available"])

Don't need to look for quants

hugho-ad · 2024-05-21T16:06:19Z

hantec_api_ecommerce/controllers/main.py

+        contact_data = data.get("contact_data", {})
+
+        if email or phone:
+            email_pattern = r"^([a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*)"  # Email pattern to get the value before @


line too long (140 > 119 characters)

hugho-ad · 2024-05-21T16:07:36Z

hantec_api_ecommerce/controllers/main.py

+        partner_id = data.get("partner_id")
+        invoice_data = data.get("invoice_data")
+
+        partner = env["res.partner"].browse(partner_id)


hugho-ad · 2024-05-21T16:08:20Z

hantec_api_ecommerce/controllers/main.py

+        partner_id = data.get("partner_id")
+        delivery_data = data.get("address_data")
+        only_create = data.get("only_create", False)  # Boolean to omit address update
+        partner = env["res.partner"].browse(partner_id)


same, not used

hugho-ad · 2024-05-21T16:09:05Z

hantec_api_ecommerce/controllers/main.py

+
+        """
+        # Find the invoice
+        invoice = request.env["account.move"].browse(invoice_id).exists()


hugho-ad · 2024-05-21T16:11:27Z

hantec_api_ecommerce/controllers/main.py

+        return order.get_shipping_info()
+
+    @route(
+        "/download_invoice/<int:invoice_id>", methods=["GET"], type="http", auth="user"


what about to use the model
https://github.com/Vauxoo/addons-vauxoo/blob/15.0/website_sale_brand_catalogs/controllers/portal.py#L10

Do I use this model for a new endpoint? @hugho-ad

for the actual endpoints, the Idea is that you avoid make always the browse over the id you get from data

hugho-ad · 2024-05-21T16:12:02Z

hantec_api_ecommerce/controllers/main.py

+        Returns:
+            dict: A dictionary with a message and the inventory details of the products.
+        """
+        location_id = request.jsonrequest.get("location_id") or request.params.get("location_id")


not used location_id

- Added model in URL and removed browse search: Updated endpoints to use model binding in the URL, removing the need for browsing by ID. This change improves performance and code readability. - Code formatting: Applied consistent code formatting to enhance readability and maintainability. - Improved inventory retrieval: Enhanced the inventory retrieval logic to utilize context and simplify queries. Closes #25

Removed unnecessary fields from the shipping_info in the get_shipping_info endpoint. This change simplifies the response structure and improves performance. Changes: - Removed specific fields from the shipping_info response to streamline the data returned by the endpoint. Closes #25

JAntonioSalas · 2024-05-21T22:41:22Z

I pushed the new changes, could you please review it ? @hugho-ad

hugho-ad · 2024-05-21T22:44:12Z

hantec_api_ecommerce/models/sale_order.py

@@ -0,0 +1,69 @@
+from odoo import models, fields


Suggested change

from odoo import models, fields

from odoo import models

not used

hugho-ad · 2024-05-21T22:49:04Z

hantec_api_ecommerce/controllers/main.py

+        }
+
+    @route("/delivery_address", methods=["POST"], type="json", auth="user")
+    def delivery_address(self):


suggestion:

you could merge this endpoint at the one above at create_address_invoice

it's the same code, just here are handaling the only_create boolean

my recomendation is to merge them in a sigle method

hugho-ad · 2024-05-21T22:55:03Z

hantec_api_ecommerce/controllers/main.py

+        type="json",
+        auth="user",
+    )
+    def create_schedule_activity_invoice(self, invoice=False):


same here, you can merge this method with the above, you can handle them if you do it like this
https://github.com/odoo/odoo/blob/15.0/addons/website_crm_partner_assign/controllers/main.py#L210-L214

se how they handle different records sets by model type

the thing is you can avoid duplicated code

- Merge the endpoints for scheduling activities for both sale orders and invoices into a single endpoint and merge the endpoints delivery and invoicing address. This refactoring simplifies the API by reducing the number of endpoints and centralizing similar functionalities, enhancing the efficiency and maintainability of our code. - Remove import unnecessary Closes #25

JAntonioSalas · 2024-05-22T00:31:10Z

I pushed the new changes @hugho-ad

JAntonioSalas · 2024-05-22T23:08:06Z

could you please review it? @hugho-ad

hugho-ad · 2024-05-23T12:51:14Z

hantec_api_ecommerce/controllers/main.py

+
+        if only_create:
+            address = False
+        if address:


Suggested change

if address:

if address and not only_create:

this way we can avoid the if above

hugho-ad · 2024-05-23T12:53:27Z

LGTM 👍

Just squash again please

git rebase --autosquash -i origin/15.0

The code now combines the condition 'only_create' and 'address' into a single line, ensuring that an address is only updated if it exists and it is not flagged with the 'only_create' option. This change makes the code easier to read and understand. Closes #25

Added docstring, clarified the purpose and improved of multiple endpoints to enhance the user experience and maintain consistency in the application. 1. `/create_schedule_activity_invoice`: Improved error handling for creating scheduled activities related to invoices. 2. `/get_states_mexico`: Enhanced the endpoint to retrieve the list of states in Mexico, including better error handling and more detailed responses. 3. `/get_inventory_by_sku`: Updated the endpoint to retrieve inventory details based on SKU, ensuring accurate and detailed inventory information is returned. Filter inventory by location. 4. `/get_inventory`: Improved the retrieval of inventory details for all products with a SKU, adding more detailed responses. Filter inventory by location. 5. `/send_message_sale_order`: Added functionality to post messages to sale orders, with better logging and error handling. 6. `/create_schedule_activity`: Enhanced the creation of scheduled activities related to sale orders, including additional validation and detailed responses. 7. `/confirm_sale_order`: Simplified the process of confirming sale orders and added detailed logging and responses. 8. `/send_invoice_by_email/<int:invoice_id>`: Improved the functionality for sending invoices by email, ensuring better user feedback and error handling. 9. `/stamp_invoice/<int:invoice_id>`: Enhanced the invoice stamping process, including detailed error messages and success responses. 10. `/download_invoice/<int:invoice_id>`: Streamlined the invoice download process to generate and deliver PDFs more efficiently. 11. `/get_shipping_info/<model("sale.order"):order>`: Added functionality to retrieve detailed shipping information for sale orders, including delivery address details and shipping records. 12. `/register_payment_invoice/<model("account.move"):invoice>`: Improved the payment registration process for invoices, ensuring accurate logging and error handling. 13. `/invoice_sale_order`: Enhanced the process of invoicing sale orders, including better handling of invoice creation and posting. 14. `/update_sale_order`: Improved the update process for sale orders, including validation and detailed logging. 15. `/create_sale_order`: Enhanced the creation process for sale orders with better validation and handling of optional fields. 16. Unify scheduling and address endpoints 17. `/delivery_address`: Improved the process for creating or updating delivery addresses, including better handling of address formatting and validation. 18. `/address_invoice`: Enhanced the process for creating or updating billing addresses, ensuring better validation and error handling. 19. `/update_contact`: Improved the contact update process, including better validation and detailed logging. 20. `/create_contact`: Enhanced the contact creation process with better search logic and validation based on email, phone, or store name (contact name). 21. doc: add README.rst for module documentation 22. Filter inventory by location and SKU 23. Unify scheduling and address endpoints These changes improve the overall robustness and maintainability of the system by ensuring that each endpoint handles data consistently and provides meaningful feedback to users. Closes #24 Closes #25

JAntonioSalas · 2024-05-23T16:54:31Z

It is ready @hugho-ad

hugho-ad · 2024-05-23T17:44:37Z

@JAntonioSalas

one important thing, its the uni tests, did you plan to include them?

JAntonioSalas · 2024-05-23T18:10:34Z

I think not at the moment because they need to use those endpoints as soon as possible. @hugho-ad

Added docstring, clarified the purpose and improved of multiple endpoints to enhance the user experience and maintain consistency in the application. 1. `/create_schedule_activity_invoice`: Improved error handling for creating scheduled activities related to invoices. 2. `/get_states_mexico`: Enhanced the endpoint to retrieve the list of states in Mexico, including better error handling and more detailed responses. 3. `/get_inventory_by_sku`: Updated the endpoint to retrieve inventory details based on SKU, ensuring accurate and detailed inventory information is returned. Filter inventory by location. 4. `/get_inventory`: Improved the retrieval of inventory details for all products with a SKU, adding more detailed responses. Filter inventory by location. 5. `/send_message_sale_order`: Added functionality to post messages to sale orders, with better logging and error handling. 6. `/create_schedule_activity`: Enhanced the creation of scheduled activities related to sale orders, including additional validation and detailed responses. 7. `/confirm_sale_order`: Simplified the process of confirming sale orders and added detailed logging and responses. 8. `/send_invoice_by_email/<int:invoice_id>`: Improved the functionality for sending invoices by email, ensuring better user feedback and error handling. 9. `/stamp_invoice/<int:invoice_id>`: Enhanced the invoice stamping process, including detailed error messages and success responses. 10. `/download_invoice/<int:invoice_id>`: Streamlined the invoice download process to generate and deliver PDFs more efficiently. 11. `/get_shipping_info/<model("sale.order"):order>`: Added functionality to retrieve detailed shipping information for sale orders, including delivery address details and shipping records. 12. `/register_payment_invoice/<model("account.move"):invoice>`: Improved the payment registration process for invoices, ensuring accurate logging and error handling. 13. `/invoice_sale_order`: Enhanced the process of invoicing sale orders, including better handling of invoice creation and posting. 14. `/update_sale_order`: Improved the update process for sale orders, including validation and detailed logging. 15. `/create_sale_order`: Enhanced the creation process for sale orders with better validation and handling of optional fields. 16. Unify scheduling and address endpoints 17. `/delivery_address`: Improved the process for creating or updating delivery addresses, including better handling of address formatting and validation. 18. `/address_invoice`: Enhanced the process for creating or updating billing addresses, ensuring better validation and error handling. 19. `/update_contact`: Improved the contact update process, including better validation and detailed logging. 20. `/create_contact`: Enhanced the contact creation process with better search logic and validation based on email, phone, or store name (contact name). 21. doc: add README.rst for module documentation 22. Filter inventory by location and SKU 23. Unify scheduling and address endpoints These changes improve the overall robustness and maintainability of the system by ensuring that each endpoint handles data consistently and provides meaningful feedback to users. Closes #24 Closes #25

…ers and groups management.

…ference

This app will help the manager to set the price fix as the product price in sale order, purchase order, invoicing and account price.

…elds

Add new optional fields when a sale order is created

Add new optional field when a sale order is created

Add dynamic optional fields when creating a sales order

Remove required field when creating sale order.

JAntonioSalas requested a review from hugho-ad May 14, 2024 21:05

JAntonioSalas force-pushed the ecommerce branch from 19617b9 to 3c2e61e Compare May 15, 2024 18:12

hugho-ad reviewed May 16, 2024

View reviewed changes

JAntonioSalas force-pushed the ecommerce branch from 439b116 to 230edf2 Compare May 21, 2024 03:02

hugho-ad reviewed May 21, 2024

View reviewed changes

hugho-ad reviewed May 23, 2024

View reviewed changes

JAntonioSalas force-pushed the ecommerce branch from f49eb3a to 6874cda Compare May 23, 2024 16:52

JAntonioSalas force-pushed the ecommerce branch from f88f061 to 51c6765 Compare May 24, 2024 17:06

JAntonioSalas and others added 18 commits July 22, 2024 17:32

[ADD] ks_dashboard_ninja: module to dashboard with AI

2546815

[ADD] base_user_role: module to extend the functionality regarding us…

cf253b0

…ers and groups management.

[IMP] hantec_api_ecommerce: Endpoint to get product ID by internal re…

dd045f3

…ference

[IMP] API: Search by name and create contact

1251e14

[ADD] eg_lock_price: New module Lock Price

3d3426e

This app will help the manager to set the price fix as the product price in sale order, purchase order, invoicing and account price.

[ADD] sale_product_stock_app: New module sale product stock

3de79f8

[IMP] sale_product_stock_app: Add values in SaleWarehouseLine

e2a837f

[IMP] sale_product_stock_app: Change position fields and string of fi…

7c87250

…elds

[IMP] sale_product_stock_app: Translate tags

cd4ae90

[IMP] hantec_api_ecommerce: new fields

0a1994d

Add new optional fields when a sale order is created

[IMP] hantec_api_ecommerce: new field

9307de8

Add new optional field when a sale order is created

[REF] hantec_api_ecommerce: Remove optional fields.

5ce8529

Add dynamic optional fields when creating a sales order

[IMP] hantec_api_ecommerce: Remove required field

669e493

Remove required field when creating sale order.

[ADD] .gitmodules: Welcome Server Backend and Base_user_role module

abe5c7c

Merge 15.0-add-user-role-module-hugho-ad into ecommerce

c7dc735

[IMP] hantec_api_ecommerce: Allow more fields in invoices.

58dfa4d

[IMP] hantec_api_ecommerce: Add new field in invoices.

cf69b42

[IMP] hantec_api_ecommerce: Add field in invoices if exists.

c86a05a

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[IMP] api: Add and enhance multiple endpoints for improved functionality #25

[IMP] api: Add and enhance multiple endpoints for improved functionality #25

JAntonioSalas commented May 14, 2024

hugho-ad May 16, 2024

hugho-ad May 16, 2024

hugho-ad May 16, 2024

hugho-ad May 21, 2024

hugho-ad May 16, 2024

hugho-ad May 21, 2024

JAntonioSalas commented May 21, 2024

hugho-ad May 21, 2024

hugho-ad May 21, 2024

hugho-ad May 21, 2024

hugho-ad May 21, 2024

hugho-ad May 21, 2024

hugho-ad May 21, 2024

JAntonioSalas May 21, 2024

hugho-ad May 21, 2024

hugho-ad May 21, 2024

JAntonioSalas commented May 21, 2024

hugho-ad May 21, 2024

hugho-ad May 21, 2024

hugho-ad May 21, 2024

JAntonioSalas commented May 22, 2024

JAntonioSalas commented May 22, 2024

hugho-ad May 23, 2024

hugho-ad commented May 23, 2024

JAntonioSalas commented May 23, 2024

hugho-ad commented May 23, 2024

JAntonioSalas commented May 23, 2024

	quants = request.env["stock.quant"].search([("product_id", "=", product.id), ("location_id", "=", location_id)])
	product.with_context(location=location_id).read(["name", "default_code", "qty_available", "virtual_available"])

[IMP] api: Add and enhance multiple endpoints for improved functionality #25

Are you sure you want to change the base?

[IMP] api: Add and enhance multiple endpoints for improved functionality #25

Conversation

JAntonioSalas commented May 14, 2024

Summary

Changes Included

Related PR

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JAntonioSalas commented May 21, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JAntonioSalas commented May 21, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JAntonioSalas commented May 22, 2024

JAntonioSalas commented May 22, 2024

Choose a reason for hiding this comment

hugho-ad commented May 23, 2024

JAntonioSalas commented May 23, 2024

hugho-ad commented May 23, 2024

JAntonioSalas commented May 23, 2024