[IMP] Added Negotiated Rates & Unit Test Cases

Author: sudhir-erpharbor

delivery_ups_oca/README.rst

@@ -62,6 +62,9 @@ To configure this module, you need to:
    ``ups`` delivery type and check the "Cash on Delivery" checkbox under the "UPS" tab.
    It is required to select the "UPS COD Funds Code" when the "Cash on Delivery" option
    is selected.
+#. The "Negotiated Rates" checkbox is enabled by default. When checked, UPS will use your
+   account's negotiated rates for shipping cost calculations. If your UPS account does not
+   have negotiated rates, you should uncheck this option.
 #. To enable insurance for your shipments, set the "Declared Value (%)" field in the
    "Insurance" section of the UPS tab. This percentage will be applied to the total
    value of the picking to determine the insurance amount. Set to 0 to disable insurance.

delivery_ups_oca/models/delivery_carrier.py

@@ -103,6 +103,11 @@ class DeliveryCarrier(models.Model):
         help="If the destination country is in one of these country groups, "
         "the paperless invoice option will be automatically enabled.",
     )
+    ups_negotiated_rates = fields.Boolean(
+        string="Negotiated Rates",
+        default=True,
+        help="If checked, UPS will use the account's negotiated rates for shipping.",
+    )
 
     def _ups_get_response_price(self, total_charges, currency, company):
         """We need to convert the price if the currency is different."""

delivery_ups_oca/models/ups_request.py

@@ -31,6 +31,7 @@ def __init__(self, carrier):
         self.client_secret = self.carrier.ups_client_secret
         self.token = self.carrier.ups_token
         self.token_expiration_date = self.carrier.ups_token_expiration_date
+        self.negotiated_rates = self.carrier.ups_negotiated_rates
         self.url = "https://wwwcie.ups.com"
         if self.carrier.prod_environment:
             self.url = "https://onlinetools.ups.com"
@@ -266,12 +267,12 @@ def _add_insurance_to_package(
 
         return package_item
 
-    def _prepare_create_shipping(self, picking):
-        """Return a dict that can be passed to the shipping endpoint of the UPS API"""
+    def _prepare_packages_from_picking(self, picking):
+        """Prepare packages data from picking packages"""
+        packages = []
 
         if self.use_packages_from_picking and picking.package_ids:
-            # model: stock.quant.package
-            packages = []
+            # Use actual packages from the picking
             for package in picking.package_ids:
                 package_item = self._quant_package_data_from_picking(
                     package, picking, True
@@ -285,20 +286,22 @@ def _prepare_create_shipping(self, picking):
 
                 packages.append(package_item)
         else:
-            # model: stock.package.type
-            packages = []
+            # Create packages based on default packaging
             package_info = self._quant_package_data_from_picking(
                 self.default_packaging_id, picking, False
             )
-            package_weight = 0
+
+            # Calculate package weight
             if picking.number_of_packages > 0:
                 package_weight = round(
                     (picking.shipping_weight / picking.number_of_packages), 2
                 )
             else:
                 package_weight = picking.shipping_weight
+
             # Ensure at least one package is created
             num_packages = max(1, picking.number_of_packages)
+
             for i in range(0, num_packages):
                 package_item = package_info.copy()
                 package_name = "%s (%s)" % (picking.name, i + 1)
@@ -311,37 +314,11 @@ def _prepare_create_shipping(self, picking):
                 package_item = self._add_insurance_to_package(package_item, picking)
 
                 packages.append(package_item)
-        vals = {
-            "ShipmentRequest": {
-                "Shipment": {
-                    "Description": picking.name,
-                    "Shipper": self._partner_to_shipping_data(
-                        partner=picking.company_id.partner_id,
-                        ShipperNumber=self.shipper_number,
-                    ),
-                    "ShipTo": self._partner_to_shipping_data(picking.partner_id),
-                    "ShipFrom": self._partner_to_shipping_data(
-                        picking.picking_type_id.warehouse_id.partner_id
-                        or picking.company_id.partner_id
-                    ),
-                    "PaymentInformation": {
-                        "ShipmentCharge": {
-                            "Type": "01",
-                            "BillShipper": {
-                                # we ignore the alternatives paying per credit card or
-                                # paypal for now
-                                "AccountNumber": self.shipper_number,
-                            },
-                        }
-                    },
-                    "Service": {"Code": self.service_code},
-                    "Package": packages,
-                },
-                "LabelSpecification": self._label_data(),
-            }
-        }
 
-        # Add ShipmentServiceOptions if needed
+        return packages
+
+    def _prepare_shipment_service_options(self, picking):
+        """Prepare shipment service options including COD and paperless invoice"""
         shipment_service_options = {}
 
         # Add COD if enabled
@@ -375,11 +352,57 @@ def _prepare_create_shipping(self, picking):
                     "UserCreatedForm": {"DocumentID": picking.document_id},
                 }
 
-        # Add ShipmentServiceOptions to the request if not empty
+        return shipment_service_options
+
+    def _prepare_create_shipping(self, picking):
+        """Return a dict that can be passed to the shipping endpoint of the UPS API"""
+        # Prepare packages
+        packages = self._prepare_packages_from_picking(picking)
+
+        # Build the base request structure
+        vals = {
+            "ShipmentRequest": {
+                "Shipment": {
+                    "Description": picking.name,
+                    "Shipper": self._partner_to_shipping_data(
+                        partner=picking.company_id.partner_id,
+                        ShipperNumber=self.shipper_number,
+                    ),
+                    "ShipTo": self._partner_to_shipping_data(picking.partner_id),
+                    "ShipFrom": self._partner_to_shipping_data(
+                        picking.picking_type_id.warehouse_id.partner_id
+                        or picking.company_id.partner_id
+                    ),
+                    "PaymentInformation": {
+                        "ShipmentCharge": {
+                            "Type": "01",
+                            "BillShipper": {
+                                # we ignore the alternatives paying per credit card or
+                                # paypal for now
+                                "AccountNumber": self.shipper_number,
+                            },
+                        }
+                    },
+                    "Service": {"Code": self.service_code},
+                    "Package": packages,
+                },
+                "LabelSpecification": self._label_data(),
+            }
+        }
+
+        # Add negotiated rates if enabled
+        if self.negotiated_rates:
+            vals["ShipmentRequest"]["Shipment"]["ShipmentRatingOptions"] = {
+                "NegotiatedRatesIndicator": "ABR"
+            }
+
+        # Add shipment service options (COD, paperless invoice)
+        shipment_service_options = self._prepare_shipment_service_options(picking)
         if shipment_service_options:
             vals["ShipmentRequest"]["Shipment"][
                 "ShipmentServiceOptions"
             ] = shipment_service_options
+
         return vals
 
     def _send_shipping(self, picking):
@@ -419,9 +442,14 @@ def _send_shipping(self, picking):
                         "datas": label["ShippingLabel"]["GraphicImage"],
                     }
                 )
+        # Use negotiated rates if available and enabled
+        if self.negotiated_rates and "NegotiatedRates" in res:
+            price = res["NegotiatedRates"]["TotalCharge"]
+        else:
+            price = res["ShipmentCharges"]["TotalCharges"]
 
         return {
-            "price": res["ShipmentCharges"]["TotalCharges"],
+            "price": price,
             "ShipmentIdentificationNumber": res["ShipmentIdentificationNumber"],
             "labels": labels,
         }
@@ -448,7 +476,7 @@ def _quant_package_data_from_order(self, order):
 
     def _prepare_rate_shipment(self, order):
         packages = [self._quant_package_data_from_order(order)]
-        return {
+        rate_request = {
             "RateRequest": {
                 "Shipment": {
                     "Shipper": self._partner_to_shipping_data(
@@ -465,6 +493,14 @@ def _prepare_rate_shipment(self, order):
             }
         }
 
+        # Add negotiated rates if enabled
+        if self.negotiated_rates:
+            rate_request["RateRequest"]["Shipment"]["ShipmentRatingOptions"] = {
+                "NegotiatedRatesIndicator": "ABR"
+            }
+
+        return rate_request
+
     def _rate_shipment(self, order, skip_errors=False):
         status = self._process_reply(
             url="%s/api/rating/v1/Rate" % self.url,
@@ -475,7 +511,13 @@ def _rate_shipment(self, order, skip_errors=False):
 
     def rate_shipment(self, order):
         status = self._rate_shipment(order)
-        return status["RateResponse"]["RatedShipment"]["TotalCharges"]
+        rated_shipment = status["RateResponse"]["RatedShipment"]
+
+        # Use negotiated rates if available and enabled
+        if self.negotiated_rates and "NegotiatedRateCharges" in rated_shipment:
+            return rated_shipment["NegotiatedRateCharges"]["TotalCharge"]
+
+        return rated_shipment["TotalCharges"]
 
     def _prepare_shipping_label(self, carrier_tracking_ref):
         return {

delivery_ups_oca/readme/CONFIGURE.rst

@@ -11,6 +11,9 @@ To configure this module, you need to:
    ``ups`` delivery type and check the "Cash on Delivery" checkbox under the "UPS" tab.
    It is required to select the "UPS COD Funds Code" when the "Cash on Delivery" option
    is selected.
+#. The "Negotiated Rates" checkbox is enabled by default. When checked, UPS will use your
+   account's negotiated rates for shipping cost calculations. If your UPS account does not
+   have negotiated rates, you should uncheck this option.
 #. To enable insurance for your shipments, set the "Declared Value (%)" field in the
    "Insurance" section of the UPS tab. This percentage will be applied to the total
    value of the picking to determine the insurance amount. Set to 0 to disable insurance.

delivery_ups_oca/static/description/index.html

@@ -410,6 +410,9 @@ <h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
 <tt class="docutils literal">ups</tt> delivery type and check the “Cash on Delivery” checkbox under the “UPS” tab.
 It is required to select the “UPS COD Funds Code” when the “Cash on Delivery” option
 is selected.</li>
+<li>The “Negotiated Rates” checkbox is enabled by default. When checked, UPS will use your
+account’s negotiated rates for shipping cost calculations. If your UPS account does not
+have negotiated rates, you should uncheck this option.</li>
 <li>To enable insurance for your shipments, set the “Declared Value (%)” field in the
 “Insurance” section of the UPS tab. This percentage will be applied to the total
 value of the picking to determine the insurance amount. Set to 0 to disable insurance.</li>

delivery_ups_oca/tests/__init__.py

@@ -4,3 +4,4 @@
 from . import test_ups_insurance
 from . import test_send_paperless_invoice
 from . import test_residential_address
+from . import test_negotiated_rates