friendly_shipping 0.8.1 → 0.9.0

data/lib/friendly_shipping/services/ups_json/label_options.rb

@@ -0,0 +1,177 @@
+# frozen_string_literal: true
+
+require 'friendly_shipping/services/ups_json/label_package_options'
+require 'friendly_shipping/services/ups_json/label_billing_options'
+
+module FriendlyShipping
+  module Services
+    # Option container for a generating UPS labels for a shipment
+    #
+    # Required:
+    #
+    # @param shipping_method [FriendlyShipping::ShippingMethod] The shipping method to use. We only need the
+    #   service_code to be set.
+    # @param shipper_number [String] account number for the shipper
+    #
+    # Optional:
+    #
+    # @param shipper [Physical::Location] The company sending the shipment. Defaults to the shipment's origin.
+    # @param sub_version [String] The UPS API sub-version to use for requests. Default: 1707
+    # @param customer_context [String ] Optional element to identify transactions between client and server
+    # @param validate_address [Boolean] Validate the city field with ZIP code and state. If false, only ZIP code
+    #   and state are validated. Default: true
+    # @param negotiated_rates [Boolean] if truthy negotiated rates will be requested from ups. Only valid if
+    #   shipper account has negotiated rates. Default: false
+    # @option sold_to [Physical::Location] The person or company who imports and pays any duties due on the
+    #   current shipment. Default: The shipment's destination
+    # @option saturday_delivery [Boolean] should we request Saturday delivery?. Default: false
+    # @option label_format [String] GIF, EPL, ZPL, STARPL and SPL
+    # @option label_size [Array<Integer>] Dimensions of the label. Default: [4, 6]
+    # @option delivery_confirmation [Symbol] Can be set to any key from SHIPMENT_DELIVERY_CONFIRMATION_CODES.
+    #   Only possible for international shipments that are not between the US and Puerto Rico.
+    # @option carbon_neutral [Boolean] Ship with UPS' carbon neutral program
+    # @option return_service_code [Symbol] If present, marks this a return label. The kind
+    #   of return label is specified by the symbol, one of the keys in RETURN_SERVICE_CODES. Default: nil
+    #
+    # Shipment options for international shipping:
+    #
+    # @option paperless_invoice [Boolean] set to truthy if using paperless invoice to ship internationally. Default false
+    # @option terms_of_shipment [Symbol] used with paperless invoice to specify who pays duties and taxes.
+    #   See TERMS_OF_SHIPMENT constant for possible options.
+    # @option reason_for_export [String] A reason to export the current shipment. Possible values: 'SALE', 'GIFT', 'SAMPLE',
+    #   'RETURN', 'REPAIR', 'INTERCOMPANYDATA', Any other reason. Default: 'SALE'.
+    # @option invoice_date [Date] The invoice date for the shipment
+    # @param declaration_statement [String ] Optional element to add customs declaration text
+    #
+    class UpsJson
+      class LabelOptions < FriendlyShipping::ShipmentOptions
+        SHIPMENT_DELIVERY_CONFIRMATION_CODES = {
+          delivery_confirmation_signature_required: 1,
+          delivery_confirmation_adult_signature_required: 2
+        }.freeze
+
+        TERMS_OF_SHIPMENT_CODES = {
+          cost_and_freight: 'CFR',
+          cost_insurance_and_freight: 'CIF',
+          carriage_and_insurance_paid: 'CIP',
+          carriage_paid_to: 'CPT',
+          delivered_at_frontier: 'DAF',
+          delivery_duty_paid: 'DDP',
+          delivery_duty_unpaid: 'DDU',
+          delivered_ex_quay: 'DEQ',
+          delivered_ex_ship: 'DES',
+          ex_works: 'EXW',
+          free_alongside_ship: 'FAS',
+          free_carrier: 'FCA',
+          free_on_board: 'FOB'
+        }.freeze
+
+        RETURN_SERVICE_CODES = {
+          ups_print_and_mail: 2, # UPS Print and Mail (PNM)
+          ups_return_1_attempt: 3, # UPS Return Service 1-Attempt
+          ups_return_3_attempt: 5, # UPS Return Service 3-Attempt (RS3)
+          ups_electronic_return_label: 8, # UPS Electronic Return Label (ERL)
+          ups_print_return_label: 9, # UPS Print Return Label (PRL)
+          ups_exchange_print_return: 10, # UPS Exchange Print Return Label
+          ups_pack_collect_1_attemt_box_1: 11, # UPS Pack & Collect Service 1-Attempt Box 1
+          ups_pack_collect_1_attemt_box_2: 12, # UPS Pack & Collect Service 1-Attempt Box 2
+          ups_pack_collect_1_attemt_box_3: 13, # UPS Pack & Collect Service 1-Attempt Box 3
+          ups_pack_collect_1_attemt_box_4: 14, # UPS Pack & Collect Service 1-Attempt Box 4
+          ups_pack_collect_1_attemt_box_5: 15, # UPS Pack & Collect Service 1-Attempt Box 5
+          ups_pack_collect_3_attemt_box_1: 16, # UPS Pack & Collect Service 1-Attempt Box 1
+          ups_pack_collect_3_attemt_box_2: 17, # UPS Pack & Collect Service 1-Attempt Box 2
+          ups_pack_collect_3_attemt_box_3: 18, # UPS Pack & Collect Service 1-Attempt Box 3
+          ups_pack_collect_3_attemt_box_4: 19, # UPS Pack & Collect Service 1-Attempt Box 4
+          ups_pack_collect_3_attemt_box_5: 20 # UPS Pack & Collect Service 1-Attempt Box 5
+        }.freeze
+
+        SUB_VERSIONS = %w[1601 1607 1701 1707 1801 1807 2108 2205].freeze
+
+        attr_reader :shipping_method,
+                    :shipper_number,
+                    :shipper,
+                    :sub_version,
+                    :customer_context,
+                    :validate_address,
+                    :negotiated_rates,
+                    :billing_options,
+                    :sold_to,
+                    :saturday_delivery,
+                    :label_format,
+                    :label_size,
+                    :carbon_neutral,
+                    :paperless_invoice,
+                    :reason_for_export,
+                    :invoice_date,
+                    :declaration_statement
+
+        def initialize(
+          shipping_method:,
+          shipper_number:,
+          shipper: nil,
+          sub_version: '2205',
+          customer_context: nil,
+          validate_address: true,
+          negotiated_rates: false,
+          billing_options: LabelBillingOptions.new,
+          sold_to: nil,
+          saturday_delivery: false,
+          label_format: 'GIF',
+          label_size: [4, 6],
+          delivery_confirmation: nil,
+          carbon_neutral: true,
+          return_service: nil,
+          paperless_invoice: false,
+          terms_of_shipment: nil,
+          reason_for_export: 'SALE',
+          invoice_date: nil,
+          package_options_class: LabelPackageOptions,
+          declaration_statement: nil,
+          **kwargs
+        )
+          raise ArgumentError, "Invalid sub-version: #{sub_version}" unless sub_version.in?(SUB_VERSIONS)
+
+          @shipping_method = shipping_method
+          @shipper_number = shipper_number
+          @shipper = shipper
+          @sub_version = sub_version
+          @customer_context = customer_context
+          @validate_address = validate_address
+          @negotiated_rates = negotiated_rates
+          @billing_options = billing_options
+          @sold_to = sold_to
+          @saturday_delivery = saturday_delivery
+          @label_format = label_format
+          @label_size = label_size
+          @delivery_confirmation = delivery_confirmation
+          @carbon_neutral = carbon_neutral
+          @return_service = return_service
+          @paperless_invoice = paperless_invoice
+          @terms_of_shipment = terms_of_shipment
+          @reason_for_export = reason_for_export
+          @invoice_date = invoice_date
+          @declaration_statement = declaration_statement
+          super(**kwargs.reverse_merge(package_options_class: package_options_class))
+        end
+
+        def delivery_confirmation_code
+          SHIPMENT_DELIVERY_CONFIRMATION_CODES[delivery_confirmation]
+        end
+
+        def terms_of_shipment_code
+          TERMS_OF_SHIPMENT_CODES[terms_of_shipment]
+        end
+
+        def return_service_code
+          RETURN_SERVICE_CODES[return_service]
+        end
+
+        private
+
+        attr_reader :terms_of_shipment,
+                    :return_service,
+                    :delivery_confirmation
+      end
+    end
+  end
+end

data/lib/friendly_shipping/services/ups_json/label_package_options.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'friendly_shipping/services/ups_json/label_item_options'
+
+module FriendlyShipping
+  module Services
+    class UpsJson
+      # Package properties relevant for generating a UPS shipping label
+      #
+      # @option reference_numbers [Hash] a Hash where keys are _reference number codes_ and
+      #   values are _reference number values_. Example: `{ reference_numbers: { xn: 'my_reference_1 }`
+      # @option delivery_confirmation [Symbol] Can be set to any key from PACKAGE_DELIVERY_CONFIRMATION_CODES.
+      #   Only possible for domestic shipments or shipments between the US and Puerto Rico.
+      # @option shipper_release [Boolean] Indicates that the package may be released by driver without a signature from
+      #   the consignee. Default: false
+      # @option declared_value [Boolean] When true, declared value (calculated as the sum of all items in the shipment)
+      #   will be included in the request. Default: false
+      class LabelPackageOptions < FriendlyShipping::PackageOptions
+        PACKAGE_DELIVERY_CONFIRMATION_CODES = {
+          delivery_confirmation: 1,
+          delivery_confirmation_signature_required: 2,
+          delivery_confirmation_adult_signature_required: 3
+        }.freeze
+
+        attr_reader :reference_numbers, :shipper_release, :declared_value
+
+        def initialize(
+          reference_numbers: {},
+          delivery_confirmation: nil,
+          shipper_release: false,
+          declared_value: false,
+          **kwargs
+        )
+          @reference_numbers = reference_numbers
+          @delivery_confirmation = delivery_confirmation
+          @shipper_release = shipper_release
+          @declared_value = declared_value
+          super(**kwargs.reverse_merge(item_options_class: LabelItemOptions))
+        end
+
+        def delivery_confirmation_code
+          PACKAGE_DELIVERY_CONFIRMATION_CODES[delivery_confirmation]
+        end
+
+        private
+
+        attr_reader :delivery_confirmation
+      end
+    end
+  end
+end

data/lib/friendly_shipping/services/ups_json/parse_address_classification_response.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsJson
+      class ParseAddressClassificationResponse
+        extend Dry::Monads::Result::Mixin
+
+        class << self
+          def call(request:, response:)
+            parsed_response = ParseJsonResponse.call(
+              request: request,
+              response: response,
+              expected_root_key: 'XAVResponse'
+            )
+            parsed_response.bind do |classification_response|
+              address_type = classification_response.dig('XAVResponse', 'AddressClassification', 'Description')&.downcase
+              Success(
+                FriendlyShipping::ApiResult.new(
+                  address_type,
+                  original_request: request,
+                  original_response: response
+                )
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/friendly_shipping/services/ups_json/parse_json_response.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsJson
+      class ParseJsonResponse
+        extend Dry::Monads::Result::Mixin
+        SUCCESSFUL_RESPONSE_STATUS_CODE = '1'
+
+        class << self
+          def call(request:, response:, expected_root_key:)
+            api_error_message = response.headers.try(:[], :errordescription)
+            response_body = JSON.parse(response.body)
+
+            # UPS may return a 2xx status code on an unsuccessful request and include the error description in
+            # the response headers, which we will consider a failure
+            if api_error_message.present?
+              wrap_failure(api_error_message, request, response)
+            elsif response_body.nil? || response_body.keys.first != expected_root_key
+              wrap_failure('Empty or unexpected root key', request, response)
+            else
+              Success(response_body)
+            end
+          rescue JSON::ParserError => e
+            # when the response is not valid JSON(?!), the error description in the header is more descriptive
+            wrap_failure(api_error_message || e, request, response)
+          end
+
+          private
+
+          def wrap_failure(failure, request, response)
+            Failure(
+              FriendlyShipping::ApiFailure.new(
+                failure,
+                original_request: request,
+                original_response: response
+              )
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/friendly_shipping/services/ups_json/parse_labels_response.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsJson
+      class ParseLabelsResponse
+        class << self
+          def call(request:, response:)
+            parsed_response = ParseJsonResponse.call(
+              request: request,
+              response: response,
+              expected_root_key: 'ShipmentResponse'
+            )
+            parsed_response.fmap do |parsing_result|
+              FriendlyShipping::ApiResult.new(
+                build_labels(parsing_result),
+                original_request: request,
+                original_response: response
+              )
+            end
+          end
+
+          def build_labels(labels_result)
+            shipment_result = labels_result["ShipmentResponse"]["ShipmentResults"]
+
+            Array.wrap(shipment_result["PackageResults"]).map do |package|
+              cost_breakdown = build_cost_breakdown(package)
+              package_cost = cost_breakdown.values.any? ? cost_breakdown.values.sum : nil
+
+              FriendlyShipping::Services::UpsJson::Label.new(
+                shipment_id: shipment_result["ShipmentIdentificationNumber"],
+                tracking_number: package["TrackingNumber"],
+                usps_tracking_number: package["USPSPICNumber"],
+                label_data: Base64.decode64(package["ShippingLabel"]["GraphicImage"]),
+                label_format: package["ShippingLabel"]["ImageFormat"]["Code"],
+                label_href: package["LabelURL"],
+                cost: package_cost,
+                shipment_cost: get_shipment_cost(shipment_result),
+                data: {
+                  cost_breakdown: cost_breakdown,
+                  negotiated_rate: get_negotiated_rate(shipment_result),
+                  customer_context: labels_result["ShipmentResponse"]["Response"]["TransactionReference"]["CustomerContext"]
+                }.compact
+              )
+            end
+          end
+
+          def build_cost_breakdown(package)
+            costs = [
+              package["BaseServiceCharge"],
+              Array.wrap(package["ServiceOptionsCharges"]),
+              Array.wrap(package["ItemizedCharges"])
+            ].flatten
+
+            costs.map { |cost| ParseMoneyHash.call(cost, "UnknownSurcharge") }.compact.to_h
+          end
+
+          def get_shipment_cost(shipment_result)
+            total_charges_hash = shipment_result.dig("ShipmentCharges", "TotalCharges")
+            ParseMoneyHash.call(total_charges_hash, "TotalCharges")&.last
+          end
+
+          def get_negotiated_rate(shipment_result)
+            negotiated_total_hash = shipment_result.dig("NegotiatedRateCharges", "TotalCharge")
+            ParseMoneyHash.call(negotiated_total_hash, "TotalCharge")&.last
+          end
+        end
+      end
+    end
+  end
+end

data/lib/friendly_shipping/services/ups_json/parse_money_hash.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsJson
+      class ParseMoneyHash
+        def self.call(money_hash, key_name)
+          return unless money_hash
+
+          monetary_value = money_hash['MonetaryValue']&.to_d
+          return if monetary_value.zero?
+
+          currency_code = money_hash['CurrencyCode']
+          currency = Money::Currency.new(currency_code)
+          amount = Money.new(monetary_value * currency.subunit_to_unit, currency)
+
+          surcharge_code = money_hash['Code']
+          label = surcharge_code ? UPS_SURCHARGE_CODES[surcharge_code] : key_name
+
+          [label, amount]
+        end
+
+        UPS_SURCHARGE_CODES = {
+          "100" => "ADDITIONAL HANDLING",
+          "110" => "COD",
+          "120" => "DELIVERY CONFIRMATION",
+          "121" => "SHIP DELIVERY CONFIRMATION",
+          "153" => "PKG EMAIL SHIP NOTIFICATION",
+          "154" => "PKG EMAIL RETURN NOTIFICATION",
+          "155" => "PKG EMAIL INBOUND RETURN NOTIFICATION",
+          "156" => "PKG EMAIL QUANTUM VIEW SHIP NOTIFICATION",
+          "157" => "PKG EMAIL QUANTUM VIEW EXCEPTION NOTIFICATION",
+          "158" => "PKG EMAIL QUANTUM VIEW DELIVERY NOTIFICATION",
+          "165" => "PKG FAX INBOUND RETURN NOTIFICATION",
+          "166" => "PKG FAX QUANTUM VIEW SHIP NOTIFICATION",
+          "171" => "SHIP EMAIL ERL NOTIFICATION",
+          "173" => "SHIP EMAIL SHIP NOTIFICATION",
+          "174" => "SHIP EMAIL RETURN NOTIFICATION",
+          "175" => "SHIP EMAIL INBOUND RETURN NOTIFICATION",
+          "176" => "SHIP EMAIL QUANTUM VIEW SHIP NOTIFICATION",
+          "177" => "SHIP EMAIL QUANTUM VIEW EXCEPTION NOTIFICATION",
+          "178" => "SHIP EMAIL QUANTUM VIEW DELIVERY NOTIFICATION",
+          "179" => "SHIP EMAIL QUANTUM VIEW NOTIFY",
+          "187" => "SHIP UPS ACCESS POINT NOTIFICATION",
+          "188" => "SHIP EEI FILING NOTIFICATION",
+          "189" => "SHIP UAP SHIPPER NOTIFICATION",
+          "190" => "EXTENDED AREA",
+          "200" => "DRY ICE",
+          "220" => "HOLD FOR PICKUP",
+          "240" => "ORIGIN CERTIFICATE",
+          "250" => "PRINT RETURN LABEL",
+          "258" => "EXPORT LICENSE VERIFICATION",
+          "260" => "PRINT N MAIL",
+          "270" => "RESIDENTIAL ADDRESS",
+          "280" => "RETURN SERVICE 1ATTEMPT",
+          "290" => "RETURN SERVICE 3ATTEMPT",
+          "300" => "SATURDAY DELIVERY",
+          "310" => "SATURDAY PICKUP",
+          "330" => "PKG VERBAL CONFIRMATION",
+          "350" => "ELECTRONIC RETURN LABEL",
+          "372" => "QUANTUM VIEW NOTIFY DELIVERY",
+          "374" => "UPS PREPARED SED FORM",
+          "375" => "FUEL SURCHARGE",
+          "376" => "DELIVERY AREA",
+          "377" => "LARGE PACKAGE",
+          "378" => "SHIPPER PAYS DUTY TAX",
+          "379" => "SHIPPER PAYS DUTY TAX UNPAID",
+          "400" => "INSURANCE",
+          "401" => "SHIP ADDITIONAL HANDLING",
+          "402" => "SHIPPER RELEASE",
+          "403" => "CHECK TO SHIPPER",
+          "404" => "UPS PROACTIVE RESPONSE",
+          "405" => "GERMAN PICKUP",
+          "406" => "GERMAN ROAD TAX",
+          "407" => "EXTENDED AREA PICKUP",
+          "410" => "RETURN OF DOCUMENT",
+          "430" => "PEAK SEASON",
+          "431" => "LARGE PACKAGE SEASONAL SURCHARGE",
+          "432" => "ADDITIONAL HANDLING SEASONAL SURCHARGE",
+          "440" => "SHIP LARGE PACKAGE",
+          "441" => "CARBON NEUTRAL",
+          "442" => "PKG QV IN TRANSIT NOTIFICATION",
+          "443" => "SHIP QV IN TRANSIT NOTIFICATION",
+          "444" => "IMPORT CONTROL",
+          "445" => "COMMERCIAL INVOICE REMOVAL",
+          "446" => "IMPORT CONTROL ELECTRONIC LABEL",
+          "447" => "IMPORT CONTROL PRINT LABEL",
+          "448" => "IMPORT CONTROL PRINT AND MAIL LABEL",
+          "449" => "IMPORT CONTROL ONE PICK UP ATTEMPT LABEL",
+          "450" => "IMPORT CONTROL THREE PICK UP ATTEMPT LABEL",
+          "452" => "REFRIGERATION",
+          "454" => "PAC 1A BOX1",
+          "455" => "PAC 3A BOX1",
+          "456" => "PAC 1A BOX2",
+          "457" => "PAC 3A BOX2",
+          "458" => "PAC 1A BOX3",
+          "459" => "PAC 3A BOX3",
+          "460" => "PAC 1A BOX4",
+          "461" => "PAC 3A BOX4",
+          "462" => "PAC 1A BOX5",
+          "463" => "PAC 3A BOX5",
+          "464" => "EXCHANGE PRINT RETURN LABEL",
+          "465" => "EXCHANGE FORWARD",
+          "466" => "SHIP PREALERT NOTIFICATION",
+          "470" => "COMMITTED DELIVERY WINDOW",
+          "480" => "SECURITY SURCHARGE",
+          "492" => "CUSTOMER TRANSACTION FEE",
+          "500" => "SHIPMENT COD",
+          "510" => "LIFT GATE FOR PICKUP",
+          "511" => "LIFT GATE FOR DELIVERY",
+          "512" => "DROP OFF AT UPS FACILITY",
+          "515" => "UPS PREMIUM CARE",
+          "520" => "OVERSIZE PALLET",
+          "530" => "FREIGHT DELIVERY SURCHARGE",
+          "531" => "FREIGHT PICKUP SURCHARGE",
+          "540" => "DIRECT TO RETAIL",
+          "541" => "DIRECT DELIVERY ONLY",
+          "542" => "DELIVER TO ADDRESSEE ONLY",
+          "543" => "DIRECT TO RETAIL COD",
+          "544" => "RETAIL ACCESS POINT545 SHIPPING TICKET NOTIFICATION",
+          "546" => "ELECTRONIC PACKAGE RELEASE AUTHENTICATION",
+          "547" => "PAY AT STORE"
+        }.freeze
+        private_constant :UPS_SURCHARGE_CODES
+      end
+    end
+  end
+end

data/lib/friendly_shipping/services/ups_json/parse_rate_modifier_hash.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsJson
+      class ParseRateModifierHash
+        # @param [Hash] hash the RateModifier hash from the source JSON
+        # @param [String] currency_code The currency code for this modifier's amount (i.e. 'USD')
+        # @return [Hash]
+        def self.call(rate_modifier, currency_code:)
+          return unless rate_modifier
+
+          amount = rate_modifier['Amount'].to_d
+          return if amount.zero?
+
+          currency = Money::Currency.new(currency_code)
+          amount = Money.new(amount * currency.subunit_to_unit, currency)
+
+          modifier_type = rate_modifier['ModifierType']
+          modifier_description = rate_modifier['ModifierDesc']
+          label = "#{modifier_type} (#{modifier_description})"
+
+          { label => amount }
+        end
+      end
+    end
+  end
+end

data/lib/friendly_shipping/services/ups_json/parse_rates_response.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsJson
+      class ParseRatesResponse
+        class << self
+          def call(request:, response:, shipment:)
+            parsed_response = ParseJsonResponse.call(
+              request: request,
+              response: response,
+              expected_root_key: 'RateResponse'
+            )
+            parsed_response.fmap do |parsing_result|
+              FriendlyShipping::ApiResult.new(
+                build_rates(parsing_result, shipment),
+                original_request: request,
+                original_response: response
+              )
+            end
+          end
+
+          def build_rates(rates_result, shipment)
+            rates = []
+
+            rated_shipments = Array.wrap(rates_result.dig('RateResponse', 'RatedShipment'))
+            rated_shipments.each do |rated_shipment|
+              service_code = rated_shipment.dig('Service', 'Code')
+              shipping_method = CARRIER.shipping_methods.detect do |sm|
+                sm.service_code == service_code && shipment.origin.country.in?(sm.origin_countries)
+              end
+              days_to_delivery = rated_shipment.dig('GuaranteedDelivery', 'BusinessDaysInTransit').to_i
+              total_cost = ParseMoneyHash.call(rated_shipment['TotalCharges'], 'TotalCharges').last
+              insurance_price = ParseMoneyHash.call(rated_shipment['ServiceOptionsCharges'], 'ServiceOptionsCharges')&.last
+              negotiated_rate = ParseMoneyHash.call(rated_shipment.dig('NegotiatedRates', 'NetSummaryCharges', 'GrandTotal'), 'GrandTotal')&.last
+              negotiated_charges = ParseMoneyHash.call(rated_shipment.dig('NegotiatedRates', 'ItemizedCharges'), 'ItemizedCharges')&.last
+
+              itemized_charges = Array.wrap(rated_shipment['ItemizedCharges'])
+              itemized_charges = itemized_charges.map do |charge|
+                ParseMoneyHash.call(charge, 'MonetaryValue')
+              end
+
+              rated_shipment_warnings = Array.wrap(rated_shipment['RatedShipmentAlert'])
+              rated_shipment_warnings = rated_shipment_warnings.map { |alert| alert["Description"] }
+              if rated_shipment_warnings.any? { |e| e.match?(/to Residential/) }
+                new_address_type = 'residential'
+              elsif rated_shipment_warnings.any? { |e| e.match?(/to Commercial/) }
+                new_address_type = 'commercial'
+              end
+
+              rates << FriendlyShipping::Rate.new(
+                shipping_method: shipping_method,
+                amounts: { total: total_cost },
+                warnings: rated_shipment_warnings,
+                errors: [],
+                data: {
+                  insurance_price: insurance_price,
+                  negotiated_rate: negotiated_rate,
+                  negotiated_charges: negotiated_charges,
+                  days_to_delivery: days_to_delivery,
+                  new_address_type: new_address_type,
+                  itemized_charges: itemized_charges,
+                  packages: build_packages(rated_shipment)
+                }.compact
+              )
+            end
+            rates
+          end
+
+          private
+
+          def build_packages(rated_shipment)
+            package_array = Array.wrap(rated_shipment['RatedPackage'])
+            package_array.map do |rated_package|
+              currency_code = rated_package.dig('TotalCharges', 'CurrencyCode')
+              {
+                transportation_charges: ParseMoneyHash.call(rated_package['TransportationCharges'], 'TransportationCharges'),
+                base_service_charge: ParseMoneyHash.call(rated_package['BaseServiceCharge'], 'BaseServiceCharge'),
+                service_options_charges: ParseMoneyHash.call(rated_package['ServiceOptionsCharges'], 'ServiceOptionsCharges'),
+                itemized_charges: extract_charges(rated_package['ItemizedCharges'], 'ItemizedCharges'),
+                total_charges: ParseMoneyHash.call(rated_package['TotalCharges'], 'TotalCharges'),
+                negotiated_charges: extract_charges(rated_package.dig('NegotiatedRateCharges', 'ItemizedCharges'), 'ItemizedCharges'),
+                rate_modifiers: extract_modifiers(rated_package['RateModifier'], currency_code: currency_code).inject(:merge),
+                weight: BigDecimal(rated_package['Weight']),
+                billing_weight: BigDecimal(rated_package.dig('BillingWeight', 'Weight'))
+              }.compact
+            end
+          end
+
+          def extract_charges(charges, key_name)
+            Array.wrap(charges).map do |charge|
+              ParseMoneyHash.call(charge, key_name)
+            end.compact
+          end
+
+          def extract_modifiers(modifiers, currency_code:)
+            Array.wrap(modifiers).map do |modifier|
+              ParseRateModifierHash.call(modifier, currency_code: currency_code)
+            end.compact
+          end
+        end
+      end
+    end
+  end
+end