karrio-server-pricing 2025.5__py3-none-any.whl

karrio/server/pricing/migrations/0072_alter_surcharge_carriers_alter_surcharge_services.py

@@ -0,0 +1,24 @@
+# Generated by Django 5.2.7 on 2025-11-19 19:09
+
+import karrio.server.core.fields
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('pricing', '0071_alter_surcharge_carriers_alter_surcharge_services'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='surcharge',
+            name='carriers',
+            field=karrio.server.core.fields.MultiChoiceField(blank=True, choices=[('australiapost', 'australiapost'), ('canadapost', 'canadapost'), ('dhl_express', 'dhl_express'), ('dhl_parcel_de', 'dhl_parcel_de'), ('dhl_poland', 'dhl_poland'), ('dhl_universal', 'dhl_universal'), ('dpd', 'dpd'), ('fedex', 'fedex'), ('generic', 'generic'), ('landmark', 'landmark'), ('laposte', 'laposte'), ('purolator', 'purolator'), ('seko', 'seko'), ('sendle', 'sendle'), ('ups', 'ups'), ('usps', 'usps'), ('usps_international', 'usps_international')], help_text='\n        The list of carriers you want to apply the surcharge to.\n        <br/>\n        Note that by default, the surcharge is applied to all carriers\n        ', null=True),
+        ),
+        migrations.AlterField(
+            model_name='surcharge',
+            name='services',
+            field=karrio.server.core.fields.MultiChoiceField(blank=True, choices=[('australiapost_parcel_post', 'australiapost_parcel_post'), ('australiapost_express_post', 'australiapost_express_post'), ('australiapost_parcel_post_signature', 'australiapost_parcel_post_signature'), ('australiapost_express_post_signature', 'australiapost_express_post_signature'), ('australiapost_intl_standard_pack_track', 'australiapost_intl_standard_pack_track'), ('australiapost_intl_standard_with_signature', 'australiapost_intl_standard_with_signature'), ('australiapost_intl_express_merch', 'australiapost_intl_express_merch'), ('australiapost_intl_express_docs', 'australiapost_intl_express_docs'), ('australiapost_eparcel_post_returns', 'australiapost_eparcel_post_returns'), ('australiapost_express_eparcel_post_returns', 'australiapost_express_eparcel_post_returns'), ('canadapost_regular_parcel', 'canadapost_regular_parcel'), ('canadapost_expedited_parcel', 'canadapost_expedited_parcel'), ('canadapost_xpresspost', 'canadapost_xpresspost'), ('canadapost_xpresspost_certified', 'canadapost_xpresspost_certified'), ('canadapost_priority', 'canadapost_priority'), ('canadapost_library_books', 'canadapost_library_books'), ('canadapost_expedited_parcel_usa', 'canadapost_expedited_parcel_usa'), ('canadapost_priority_worldwide_envelope_usa', 'canadapost_priority_worldwide_envelope_usa'), ('canadapost_priority_worldwide_pak_usa', 'canadapost_priority_worldwide_pak_usa'), ('canadapost_priority_worldwide_parcel_usa', 'canadapost_priority_worldwide_parcel_usa'), ('canadapost_small_packet_usa_air', 'canadapost_small_packet_usa_air'), ('canadapost_tracked_packet_usa', 'canadapost_tracked_packet_usa'), ('canadapost_tracked_packet_usa_lvm', 'canadapost_tracked_packet_usa_lvm'), ('canadapost_xpresspost_usa', 'canadapost_xpresspost_usa'), ('canadapost_xpresspost_international', 'canadapost_xpresspost_international'), ('canadapost_international_parcel_air', 'canadapost_international_parcel_air'), ('canadapost_international_parcel_surface', 'canadapost_international_parcel_surface'), ('canadapost_priority_worldwide_envelope_intl', 'canadapost_priority_worldwide_envelope_intl'), ('canadapost_priority_worldwide_pak_intl', 'canadapost_priority_worldwide_pak_intl'), ('canadapost_priority_worldwide_parcel_intl', 'canadapost_priority_worldwide_parcel_intl'), ('canadapost_small_packet_international_air', 'canadapost_small_packet_international_air'), ('canadapost_small_packet_international_surface', 'canadapost_small_packet_international_surface'), ('canadapost_tracked_packet_international', 'canadapost_tracked_packet_international'), ('dhl_logistics_services', 'dhl_logistics_services'), ('dhl_domestic_express_12_00', 'dhl_domestic_express_12_00'), ('dhl_express_choice', 'dhl_express_choice'), ('dhl_express_choice_nondoc', 'dhl_express_choice_nondoc'), ('dhl_jetline', 'dhl_jetline'), ('dhl_sprintline', 'dhl_sprintline'), ('dhl_air_capacity_sales', 'dhl_air_capacity_sales'), ('dhl_express_easy', 'dhl_express_easy'), ('dhl_express_easy_nondoc', 'dhl_express_easy_nondoc'), ('dhl_parcel_product', 'dhl_parcel_product'), ('dhl_accounting', 'dhl_accounting'), ('dhl_breakbulk_express', 'dhl_breakbulk_express'), ('dhl_medical_express', 'dhl_medical_express'), ('dhl_express_worldwide_doc', 'dhl_express_worldwide_doc'), ('dhl_express_9_00_nondoc', 'dhl_express_9_00_nondoc'), ('dhl_freight_worldwide_nondoc', 'dhl_freight_worldwide_nondoc'), ('dhl_economy_select_domestic', 'dhl_economy_select_domestic'), ('dhl_economy_select_nondoc', 'dhl_economy_select_nondoc'), ('dhl_express_domestic_9_00', 'dhl_express_domestic_9_00'), ('dhl_jumbo_box_nondoc', 'dhl_jumbo_box_nondoc'), ('dhl_express_9_00', 'dhl_express_9_00'), ('dhl_express_10_30', 'dhl_express_10_30'), ('dhl_express_10_30_nondoc', 'dhl_express_10_30_nondoc'), ('dhl_express_domestic', 'dhl_express_domestic'), ('dhl_express_domestic_10_30', 'dhl_express_domestic_10_30'), ('dhl_express_worldwide_nondoc', 'dhl_express_worldwide_nondoc'), ('dhl_medical_express_nondoc', 'dhl_medical_express_nondoc'), ('dhl_globalmail', 'dhl_globalmail'), ('dhl_same_day', 'dhl_same_day'), ('dhl_express_12_00', 'dhl_express_12_00'), ('dhl_express_worldwide', 'dhl_express_worldwide'), ('dhl_parcel_product_nondoc', 'dhl_parcel_product_nondoc'), ('dhl_economy_select', 'dhl_economy_select'), ('dhl_express_envelope', 'dhl_express_envelope'), ('dhl_express_12_00_nondoc', 'dhl_express_12_00_nondoc'), ('dhl_destination_charges', 'dhl_destination_charges'), ('dhl_express_all', 'dhl_express_all'), ('dhl_parcel_de_paket', 'dhl_parcel_de_paket'), ('dhl_parcel_de_warenpost', 'dhl_parcel_de_warenpost'), ('dhl_parcel_de_europaket', 'dhl_parcel_de_europaket'), ('dhl_parcel_de_paket_international', 'dhl_parcel_de_paket_international'), ('dhl_parcel_de_warenpost_international', 'dhl_parcel_de_warenpost_international'), ('dhl_poland_premium', 'dhl_poland_premium'), ('dhl_poland_polska', 'dhl_poland_polska'), ('dhl_poland_09', 'dhl_poland_09'), ('dhl_poland_12', 'dhl_poland_12'), ('dhl_poland_connect', 'dhl_poland_connect'), ('dhl_poland_international', 'dhl_poland_international'), ('dpd_cl', 'dpd_cl'), ('dpd_express_10h', 'dpd_express_10h'), ('dpd_express_12h', 'dpd_express_12h'), ('dpd_express_18h_guarantee', 'dpd_express_18h_guarantee'), ('dpd_express_b2b_predict', 'dpd_express_b2b_predict'), ('fedex_international_priority_express', 'fedex_international_priority_express'), ('fedex_international_first', 'fedex_international_first'), ('fedex_international_priority', 'fedex_international_priority'), ('fedex_international_economy', 'fedex_international_economy'), ('fedex_ground', 'fedex_ground'), ('fedex_cargo_mail', 'fedex_cargo_mail'), ('fedex_cargo_international_premium', 'fedex_cargo_international_premium'), ('fedex_first_overnight', 'fedex_first_overnight'), ('fedex_first_overnight_freight', 'fedex_first_overnight_freight'), ('fedex_1_day_freight', 'fedex_1_day_freight'), ('fedex_2_day_freight', 'fedex_2_day_freight'), ('fedex_3_day_freight', 'fedex_3_day_freight'), ('fedex_international_priority_freight', 'fedex_international_priority_freight'), ('fedex_international_economy_freight', 'fedex_international_economy_freight'), ('fedex_cargo_airport_to_airport', 'fedex_cargo_airport_to_airport'), ('fedex_international_priority_distribution', 'fedex_international_priority_distribution'), ('fedex_ip_direct_distribution_freight', 'fedex_ip_direct_distribution_freight'), ('fedex_intl_ground_distribution', 'fedex_intl_ground_distribution'), ('fedex_ground_home_delivery', 'fedex_ground_home_delivery'), ('fedex_smart_post', 'fedex_smart_post'), ('fedex_priority_overnight', 'fedex_priority_overnight'), ('fedex_standard_overnight', 'fedex_standard_overnight'), ('fedex_2_day', 'fedex_2_day'), ('fedex_2_day_am', 'fedex_2_day_am'), ('fedex_express_saver', 'fedex_express_saver'), ('fedex_same_day', 'fedex_same_day'), ('fedex_same_day_city', 'fedex_same_day_city'), ('fedex_one_day_freight', 'fedex_one_day_freight'), ('fedex_international_economy_distribution', 'fedex_international_economy_distribution'), ('fedex_international_connect_plus', 'fedex_international_connect_plus'), ('fedex_international_distribution_freight', 'fedex_international_distribution_freight'), ('fedex_regional_economy', 'fedex_regional_economy'), ('fedex_next_day_freight', 'fedex_next_day_freight'), ('fedex_next_day', 'fedex_next_day'), ('fedex_next_day_10am', 'fedex_next_day_10am'), ('fedex_next_day_12pm', 'fedex_next_day_12pm'), ('fedex_next_day_end_of_day', 'fedex_next_day_end_of_day'), ('fedex_distance_deferred', 'fedex_distance_deferred'), ('standard_service', 'standard_service'), ('landmark_maxipak_scan_ddp', 'landmark_maxipak_scan_ddp'), ('landmark_maxipak_scan_ddu', 'landmark_maxipak_scan_ddu'), ('landmark_minipak_scan_ddp', 'landmark_minipak_scan_ddp'), ('landmark_minipak_scan_ddu', 'landmark_minipak_scan_ddu'), ('landmark_maxipak_scan_ddp_pudo', 'landmark_maxipak_scan_ddp_pudo'), ('landmark_maxipak_scan_premium_ups_express_ddp', 'landmark_maxipak_scan_premium_ups_express_ddp'), ('landmark_maxipak_scan_premium_ups_express_ddu', 'landmark_maxipak_scan_premium_ups_express_ddu'), ('landmark_maxipak_scan_premium_ups_standard_ddp', 'landmark_maxipak_scan_premium_ups_standard_ddp'), ('landmark_maxipak_scan_premium_ups_standard_ddu', 'landmark_maxipak_scan_premium_ups_standard_ddu'), ('purolator_express_9_am', 'purolator_express_9_am'), ('purolator_express_us', 'purolator_express_us'), ('purolator_express_10_30_am', 'purolator_express_10_30_am'), ('purolator_express_us_9_am', 'purolator_express_us_9_am'), ('purolator_express_12_pm', 'purolator_express_12_pm'), ('purolator_express_us_10_30_am', 'purolator_express_us_10_30_am'), ('purolator_express', 'purolator_express'), ('purolator_express_us_12_00', 'purolator_express_us_12_00'), ('purolator_express_evening', 'purolator_express_evening'), ('purolator_express_envelope_us', 'purolator_express_envelope_us'), ('purolator_express_envelope_9_am', 'purolator_express_envelope_9_am'), ('purolator_express_us_envelope_9_am', 'purolator_express_us_envelope_9_am'), ('purolator_express_envelope_10_30_am', 'purolator_express_envelope_10_30_am'), ('purolator_express_us_envelope_10_30_am', 'purolator_express_us_envelope_10_30_am'), ('purolator_express_envelope_12_pm', 'purolator_express_envelope_12_pm'), ('purolator_express_us_envelope_12_00', 'purolator_express_us_envelope_12_00'), ('purolator_express_envelope', 'purolator_express_envelope'), ('purolator_express_pack_us', 'purolator_express_pack_us'), ('purolator_express_envelope_evening', 'purolator_express_envelope_evening'), ('purolator_express_us_pack_9_am', 'purolator_express_us_pack_9_am'), ('purolator_express_pack_9_am', 'purolator_express_pack_9_am'), ('purolator_express_us_pack_10_30_am', 'purolator_express_us_pack_10_30_am'), ('purolator_express_pack10_30_am', 'purolator_express_pack10_30_am'), ('purolator_express_us_pack_12_00', 'purolator_express_us_pack_12_00'), ('purolator_express_pack_12_pm', 'purolator_express_pack_12_pm'), ('purolator_express_box_us', 'purolator_express_box_us'), ('purolator_express_pack', 'purolator_express_pack'), ('purolator_express_us_box_9_am', 'purolator_express_us_box_9_am'), ('purolator_express_pack_evening', 'purolator_express_pack_evening'), ('purolator_express_us_box_10_30_am', 'purolator_express_us_box_10_30_am'), ('purolator_express_box_9_am', 'purolator_express_box_9_am'), ('purolator_express_us_box_12_00', 'purolator_express_us_box_12_00'), ('purolator_express_box_10_30_am', 'purolator_express_box_10_30_am'), ('purolator_ground_us', 'purolator_ground_us'), ('purolator_express_box_12_pm', 'purolator_express_box_12_pm'), ('purolator_express_international', 'purolator_express_international'), ('purolator_express_box', 'purolator_express_box'), ('purolator_express_international_9_am', 'purolator_express_international_9_am'), ('purolator_express_box_evening', 'purolator_express_box_evening'), ('purolator_express_international_10_30_am', 'purolator_express_international_10_30_am'), ('purolator_ground', 'purolator_ground'), ('purolator_express_international_12_00', 'purolator_express_international_12_00'), ('purolator_ground_9_am', 'purolator_ground_9_am'), ('purolator_express_envelope_international', 'purolator_express_envelope_international'), ('purolator_ground_10_30_am', 'purolator_ground_10_30_am'), ('purolator_express_international_envelope_9_am', 'purolator_express_international_envelope_9_am'), ('purolator_ground_evening', 'purolator_ground_evening'), ('purolator_express_international_envelope_10_30_am', 'purolator_express_international_envelope_10_30_am'), ('purolator_quick_ship', 'purolator_quick_ship'), ('purolator_express_international_envelope_12_00', 'purolator_express_international_envelope_12_00'), ('purolator_quick_ship_envelope', 'purolator_quick_ship_envelope'), ('purolator_express_pack_international', 'purolator_express_pack_international'), ('purolator_quick_ship_pack', 'purolator_quick_ship_pack'), ('purolator_express_international_pack_9_am', 'purolator_express_international_pack_9_am'), ('purolator_quick_ship_box', 'purolator_quick_ship_box'), ('purolator_express_international_pack_10_30_am', 'purolator_express_international_pack_10_30_am'), ('purolator_express_international_pack_12_00', 'purolator_express_international_pack_12_00'), ('purolator_express_box_international', 'purolator_express_box_international'), ('purolator_express_international_box_9_am', 'purolator_express_international_box_9_am'), ('purolator_express_international_box_10_30_am', 'purolator_express_international_box_10_30_am'), ('purolator_express_international_box_12_00', 'purolator_express_international_box_12_00'), ('seko_ecommerce_standard_tracked', 'seko_ecommerce_standard_tracked'), ('seko_ecommerce_express_tracked', 'seko_ecommerce_express_tracked'), ('seko_domestic_express', 'seko_domestic_express'), ('seko_domestic_standard', 'seko_domestic_standard'), ('seko_domestic_large_parcel', 'seko_domestic_large_parcel'), ('sendle_standard_pickup', 'sendle_standard_pickup'), ('sendle_standard_dropoff', 'sendle_standard_dropoff'), ('sendle_express_pickup', 'sendle_express_pickup'), ('ups_standard', 'ups_standard'), ('ups_worldwide_express', 'ups_worldwide_express'), ('ups_worldwide_expedited', 'ups_worldwide_expedited'), ('ups_worldwide_express_plus', 'ups_worldwide_express_plus'), ('ups_worldwide_saver', 'ups_worldwide_saver'), ('ups_2nd_day_air', 'ups_2nd_day_air'), ('ups_2nd_day_air_am', 'ups_2nd_day_air_am'), ('ups_3_day_select', 'ups_3_day_select'), ('ups_ground', 'ups_ground'), ('ups_next_day_air', 'ups_next_day_air'), ('ups_next_day_air_early', 'ups_next_day_air_early'), ('ups_next_day_air_saver', 'ups_next_day_air_saver'), ('ups_expedited_ca', 'ups_expedited_ca'), ('ups_express_saver_ca', 'ups_express_saver_ca'), ('ups_3_day_select_ca_us', 'ups_3_day_select_ca_us'), ('ups_access_point_economy_ca', 'ups_access_point_economy_ca'), ('ups_express_ca', 'ups_express_ca'), ('ups_express_early_ca', 'ups_express_early_ca'), ('ups_express_saver_intl_ca', 'ups_express_saver_intl_ca'), ('ups_standard_ca', 'ups_standard_ca'), ('ups_worldwide_expedited_ca', 'ups_worldwide_expedited_ca'), ('ups_worldwide_express_ca', 'ups_worldwide_express_ca'), ('ups_worldwide_express_plus_ca', 'ups_worldwide_express_plus_ca'), ('ups_express_early_ca_us', 'ups_express_early_ca_us'), ('ups_access_point_economy_eu', 'ups_access_point_economy_eu'), ('ups_expedited_eu', 'ups_expedited_eu'), ('ups_express_eu', 'ups_express_eu'), ('ups_standard_eu', 'ups_standard_eu'), ('ups_worldwide_express_plus_eu', 'ups_worldwide_express_plus_eu'), ('ups_worldwide_saver_eu', 'ups_worldwide_saver_eu'), ('ups_access_point_economy_mx', 'ups_access_point_economy_mx'), ('ups_expedited_mx', 'ups_expedited_mx'), ('ups_express_mx', 'ups_express_mx'), ('ups_standard_mx', 'ups_standard_mx'), ('ups_worldwide_express_plus_mx', 'ups_worldwide_express_plus_mx'), ('ups_worldwide_saver_mx', 'ups_worldwide_saver_mx'), ('ups_access_point_economy_pl', 'ups_access_point_economy_pl'), ('ups_today_dedicated_courrier_pl', 'ups_today_dedicated_courrier_pl'), ('ups_today_express_pl', 'ups_today_express_pl'), ('ups_today_express_saver_pl', 'ups_today_express_saver_pl'), ('ups_today_standard_pl', 'ups_today_standard_pl'), ('ups_expedited_pl', 'ups_expedited_pl'), ('ups_express_pl', 'ups_express_pl'), ('ups_express_plus_pl', 'ups_express_plus_pl'), ('ups_express_saver_pl', 'ups_express_saver_pl'), ('ups_standard_pl', 'ups_standard_pl'), ('ups_2nd_day_air_pr', 'ups_2nd_day_air_pr'), ('ups_ground_pr', 'ups_ground_pr'), ('ups_next_day_air_pr', 'ups_next_day_air_pr'), ('ups_next_day_air_early_pr', 'ups_next_day_air_early_pr'), ('ups_worldwide_expedited_pr', 'ups_worldwide_expedited_pr'), ('ups_worldwide_express_pr', 'ups_worldwide_express_pr'), ('ups_worldwide_express_plus_pr', 'ups_worldwide_express_plus_pr'), ('ups_worldwide_saver_pr', 'ups_worldwide_saver_pr'), ('ups_express_12_00_de', 'ups_express_12_00_de'), ('ups_worldwide_express_freight', 'ups_worldwide_express_freight'), ('ups_worldwide_express_freight_midday', 'ups_worldwide_express_freight_midday'), ('ups_worldwide_economy_ddu', 'ups_worldwide_economy_ddu'), ('ups_worldwide_economy_ddp', 'ups_worldwide_economy_ddp'), ('usps_parcel_select_lightweight', 'usps_parcel_select_lightweight'), ('usps_parcel_select', 'usps_parcel_select'), ('usps_priority_mail_express', 'usps_priority_mail_express'), ('usps_priority_mail', 'usps_priority_mail'), ('usps_library_mail', 'usps_library_mail'), ('usps_media_mail', 'usps_media_mail'), ('usps_bound_printed_matter', 'usps_bound_printed_matter'), ('usps_connect_local', 'usps_connect_local'), ('usps_connect_mail', 'usps_connect_mail'), ('usps_connect_next_day', 'usps_connect_next_day'), ('usps_connect_regional', 'usps_connect_regional'), ('usps_connect_same_day', 'usps_connect_same_day'), ('usps_ground_advantage', 'usps_ground_advantage'), ('usps_domestic_matter_for_the_blind', 'usps_domestic_matter_for_the_blind'), ('usps_all', 'usps_all'), ('usps_first_class_package_international_service', 'usps_first_class_package_international_service'), ('usps_priority_mail_international', 'usps_priority_mail_international'), ('usps_priority_mail_express_international', 'usps_priority_mail_express_international'), ('usps_global_express_guaranteed', 'usps_global_express_guaranteed'), ('usps_all', 'usps_all')], help_text='\n        The list of services you want to apply the surcharge to.\n        <br/>\n        Note that by default, the surcharge is applied to all services\n        ', null=True),
+        ),
+    ]

karrio/server/pricing/models.py

@@ -0,0 +1,153 @@
+import typing
+import functools
+import django.db.models as models
+import django.core.validators as validators
+
+import karrio.lib as lib
+import karrio.core.models as karrio
+import karrio.server.core.models as core
+import karrio.server.core.fields as fields
+import karrio.server.core.datatypes as datatypes
+import karrio.server.providers.models as providers
+import karrio.server.pricing.serializers as serializers
+from karrio.server.core.logging import logger
+
+
+@core.register_model
+class Surcharge(core.ControlledAccessModel, core.Entity):
+    class Meta:
+        db_table = "surcharge"
+        verbose_name = "Markup"
+        verbose_name_plural = "Markups"
+
+    CONTEXT_RELATIONS = ["carrier_accounts"]
+
+    id = models.CharField(
+        max_length=50,
+        primary_key=True,
+        default=functools.partial(core.uuid, prefix="chrg_"),
+        editable=False,
+    )
+    active = models.BooleanField(default=True)
+
+    name = models.CharField(
+        max_length=100,
+        unique=True,
+        help_text="The surcharge name (label) that will appear in the rate (quote)",
+    )
+    amount = models.FloatField(
+        validators=[validators.MinValueValidator(0.1)],
+        default=0.0,
+        help_text="""
+        The surcharge amount or percentage to add to the quote
+        """,
+    )
+    surcharge_type = models.CharField(
+        max_length=25,
+        choices=serializers.SURCHAGE_TYPE,
+        default=serializers.SURCHAGE_TYPE[0][0],
+        help_text="""
+        Determine whether the surcharge is in percentage or net amount
+        <br/><br/>
+        For <strong>AMOUNT</strong>: rate ($22) and amount (1) will result in a new total_charge of ($23)
+        <br/>
+        For <strong>PERCENTAGE</strong>: rate ($22) and amount (5) will result in a new total_charge of ($23.10)
+        """,
+    )
+    carriers = fields.MultiChoiceField(
+        choices=serializers.CARRIERS,
+        null=True,
+        blank=True,
+        help_text="""
+        The list of carriers you want to apply the surcharge to.
+        <br/>
+        Note that by default, the surcharge is applied to all carriers
+        """,
+    )
+    carrier_accounts = models.ManyToManyField(
+        providers.Carrier,
+        blank=True,
+        help_text="""
+        The list of carrier accounts you want to apply the surcharge to.
+        <br/>
+        Note that by default, the surcharge is applied to all carrier accounts
+        """,
+    )
+    services = fields.MultiChoiceField(
+        choices=serializers.SERVICES,
+        null=True,
+        blank=True,
+        help_text="""
+        The list of services you want to apply the surcharge to.
+        <br/>
+        Note that by default, the surcharge is applied to all services
+        """,
+    )
+
+    @property
+    def object_type(self):
+        return "surcharge"
+
+    def __str__(self):
+        type_ = "$" if self.surcharge_type == "AMOUNT" else "%"
+        return f"{self.id} ({self.amount} {type_})"
+
+    def apply_charge(self, response: datatypes.RateResponse) -> datatypes.RateResponse:
+        def apply(rate: datatypes.Rate) -> datatypes.Rate:
+            applicable = []
+            carrier_ids = [c.carrier_id for c in self.carrier_accounts.all()]
+            charges = getattr(rate, "extra_charges", None) or []
+
+            if any(self.carriers or []):
+                # For custom carriers (ext="generic"), check if "generic" is in the addon's carrier list
+                # since rate.carrier_name contains custom_carrier_name but users select "generic"
+                if (
+                    rate.meta
+                    and rate.meta.get("ext") == "generic"
+                    and "generic" in self.carriers
+                ):
+                    applicable.append(True)
+                else:
+                    applicable.append(rate.carrier_name in self.carriers)
+
+            if any(carrier_ids):
+                applicable.append(rate.carrier_id in carrier_ids)
+
+            if any(self.services or []):
+                applicable.append(rate.service in self.services)
+
+            if any(applicable) and all(applicable):
+                logger.debug("Applying broker surcharge to rate", rate_id=rate.id, surcharge_id=self.id)
+
+                amount = lib.to_decimal(
+                    self.amount
+                    if self.surcharge_type == "AMOUNT"
+                    else (rate.total_charge * (typing.cast(float, self.amount) / 100))
+                )
+                total_charge = lib.to_decimal(rate.total_charge + amount)
+                extra_charges = rate.extra_charges + [
+                    karrio.ChargeDetails(
+                        name=typing.cast(str, self.name),
+                        amount=amount,
+                        currency=rate.currency,
+                        id=self.id,
+                    )
+                ]
+
+                return datatypes.Rate(
+                    **{
+                        **lib.to_dict(rate),
+                        "total_charge": total_charge,
+                        "extra_charges": extra_charges,
+                    }
+                )
+
+            return rate
+
+        return datatypes.RateResponse(
+            messages=response.messages,
+            rates=sorted(
+                [apply(rate) for rate in response.rates],
+                key=lambda rate: rate.total_charge,
+            ),
+        )

karrio/server/pricing/serializers.py

@@ -0,0 +1,18 @@
+import enum
+import karrio.server.core.dataunits as dataunits
+from karrio.server.core.serializers import (
+    CARRIERS,
+)
+
+
+class SurchargeType(enum.Enum):
+    AMOUNT = "AMOUNT"
+    PERCENTAGE = "PERCENTAGE"
+
+
+CARRIER_SERVICES = [
+    dataunits.REFERENCE_MODELS["services"][name]
+    for name in sorted(dataunits.REFERENCE_MODELS["services"].keys())
+]
+SERVICES = [(code, code) for services in CARRIER_SERVICES for code in services]
+SURCHAGE_TYPE = [(c.name, c.name) for c in list(SurchargeType)]

karrio/server/pricing/signals.py

@@ -0,0 +1,33 @@
+import functools
+import importlib
+from django.db.models import Q
+
+from karrio.server.serializers import Context
+from karrio.server.core.gateway import Rates
+from karrio.server.core.logging import logger
+import karrio.server.pricing.models as models
+
+
+def register_rate_post_processing(*args, **kwargs):
+    Rates.post_process_functions += [apply_custom_surcharges]
+    logger.info("Signal registration complete", module="karrio.pricing")
+
+
+def apply_custom_surcharges(context: Context, result):
+    _filters = tuple()
+
+    if importlib.util.find_spec("karrio.server.orgs") is not None:
+        _filters += (
+            Q(active=True, org__id=getattr(context.org, "id", None))
+            | Q(active=True, org=None),
+        )
+    else:
+        _filters += (Q(active=True),)
+
+    charges = models.Surcharge.objects.filter(*_filters)
+
+    return functools.reduce(
+        lambda cummulated_result, charge: charge.apply_charge(cummulated_result),
+        charges,
+        result,
+    )

karrio/server/pricing/tests.py

@@ -0,0 +1,301 @@
+import json
+import logging
+from unittest.mock import patch, ANY
+from django.urls import reverse
+from rest_framework import status
+from karrio.core.models import RateDetails, ChargeDetails
+from karrio.server.core.tests import APITestCase
+import karrio.server.pricing.models as models
+
+logging.disable(logging.CRITICAL)
+
+
+class TestPricing(APITestCase):
+    def setUp(self) -> None:
+        super().setUp()
+
+        self.charge: models.Surcharge = models.Surcharge.objects.create(
+            **{
+                "amount": 1.0,
+                "name": "brokerage",
+                "carriers": ["canadapost"],
+                "services": ["canadapost_priority", "canadapost_regular_parcel"],
+            }
+        )
+
+    def test_apply_surcharge_amount_to_shipment_rates(self):
+        url = reverse("karrio.server.proxy:shipment-rates")
+        data = RATING_DATA
+
+        with patch("karrio.server.core.gateway.utils.identity") as mock:
+            mock.return_value = RETURNED_VALUE
+            response = self.client.post(f"{url}", data)
+            response_data = json.loads(response.content)
+
+            self.assertEqual(response.status_code, status.HTTP_200_OK)
+            self.assertDictEqual(response_data, RATING_RESPONSE)
+
+    def test_apply_surcharge_percentage_to_shipment_rates(self):
+        self.charge.amount = 2.0
+        self.charge.surcharge_type = "PERCENTAGE"
+        self.charge.save()
+        url = reverse("karrio.server.proxy:shipment-rates")
+        data = RATING_DATA
+
+        with patch("karrio.server.core.gateway.utils.identity") as mock:
+            mock.return_value = RETURNED_VALUE
+            response = self.client.post(f"{url}", data)
+            response_data = json.loads(response.content)
+
+            self.assertEqual(response.status_code, status.HTTP_200_OK)
+            self.assertDictEqual(response_data, RATING_WITH_PERCENTAGE_RESPONSE)
+
+
+RATING_DATA = {
+    "shipper": {
+        "postal_code": "V6M2V9",
+        "city": "Vancouver",
+        "country_code": "CA",
+        "state_code": "BC",
+        "residential": True,
+        "address_line1": "5840 Oak St",
+    },
+    "recipient": {
+        "postal_code": "E1C4Z8",
+        "city": "Moncton",
+        "country_code": "CA",
+        "state_code": "NB",
+        "residential": False,
+        "address_line1": "125 Church St",
+    },
+    "parcels": [
+        {
+            "weight": 1,
+            "weight_unit": "KG",
+            "packagePreset": "canadapost_corrugated_small_box",
+        }
+    ],
+    "services": [],
+    "carrier_ids": ["canadapost"],
+}
+
+RETURNED_VALUE = (
+    [
+        RateDetails(
+            carrier_id="canadapost",
+            carrier_name="canadapost",
+            currency="CAD",
+            transit_days=7,
+            service="canadapost_expedited_parcel",
+            total_charge=32.99,
+            extra_charges=[
+                ChargeDetails(amount=29.64, currency="CAD", name="Base charge"),
+                ChargeDetails(amount=1.24, currency="CAD", name="Fuel surcharge"),
+                ChargeDetails(amount=-2.19, currency="CAD", name="SMB Savings"),
+                ChargeDetails(amount=4.3, currency="CAD", name="Duty and taxes"),
+                ChargeDetails(amount=-0.95, currency="CAD", name="Discount"),
+            ],
+        ),
+        RateDetails(
+            carrier_id="canadapost",
+            carrier_name="canadapost",
+            currency="CAD",
+            transit_days=2,
+            service="canadapost_xpresspost",
+            total_charge=85.65,
+            extra_charges=[
+                ChargeDetails(amount=75.82, currency="CAD", name="Base charge"),
+                ChargeDetails(amount=3.21, currency="CAD", name="Fuel surcharge"),
+                ChargeDetails(amount=-4.55, currency="CAD", name="SMB Savings"),
+                ChargeDetails(amount=4.3, currency="CAD", name="Duty and taxes"),
+                ChargeDetails(amount=11.17, currency="CAD", name="Discount"),
+            ],
+        ),
+        RateDetails(
+            carrier_id="canadapost",
+            carrier_name="canadapost",
+            currency="CAD",
+            transit_days=2,
+            service="canadapost_priority",
+            total_charge=113.93,
+            extra_charges=[
+                ChargeDetails(amount=101.83, currency="CAD", name="Base charge"),
+                ChargeDetails(amount=4.27, currency="CAD", name="Fuel surcharge"),
+                ChargeDetails(amount=-7.03, currency="CAD", name="SMB Savings"),
+                ChargeDetails(amount=14.86, currency="CAD", name="Duties and taxes"),
+                ChargeDetails(amount=-2.76, currency="CAD", name="Discount"),
+            ],
+        ),
+    ],
+    [],
+)
+
+RATING_RESPONSE = {
+    "messages": [],
+    "rates": [
+        {
+            "id": ANY,
+            "object_type": "rate",
+            "carrier_name": "canadapost",
+            "carrier_id": "canadapost",
+            "currency": "CAD",
+            "estimated_delivery": ANY,
+            "service": "canadapost_expedited_parcel",
+            "total_charge": 32.99,
+            "transit_days": 7,
+            "extra_charges": [
+                {"name": "Base charge", "amount": 29.64, "currency": "CAD", "id": None},
+                {"name": "Fuel surcharge", "amount": 1.24, "currency": "CAD", "id": None},
+                {"name": "SMB Savings", "amount": -2.19, "currency": "CAD", "id": None},
+                {"name": "Duty and taxes", "amount": 4.3, "currency": "CAD", "id": None},
+                {"name": "Discount", "amount": -0.95, "currency": "CAD", "id": None},
+            ],
+            "meta": {
+                "ext": "canadapost",
+                "carrier": "canadapost",
+                "rate_provider": "canadapost",
+                "service_name": "CANADAPOST EXPEDITED PARCEL",
+                "carrier_connection_id": ANY,
+            },
+            "test_mode": True,
+        },
+        {
+            "id": ANY,
+            "object_type": "rate",
+            "carrier_name": "canadapost",
+            "carrier_id": "canadapost",
+            "currency": "CAD",
+            "estimated_delivery": ANY,
+            "service": "canadapost_xpresspost",
+            "total_charge": 85.65,
+            "transit_days": 2,
+            "extra_charges": [
+                {"name": "Base charge", "amount": 75.82, "currency": "CAD", "id": None},
+                {"name": "Fuel surcharge", "amount": 3.21, "currency": "CAD", "id": None},
+                {"name": "SMB Savings", "amount": -4.55, "currency": "CAD", "id": None},
+                {"name": "Duty and taxes", "amount": 4.3, "currency": "CAD", "id": None},
+                {"name": "Discount", "amount": 11.17, "currency": "CAD", "id": None},
+            ],
+            "meta": {
+                "ext": "canadapost",
+                "carrier": "canadapost",
+                "rate_provider": "canadapost",
+                "service_name": "CANADAPOST XPRESSPOST",
+                "carrier_connection_id": ANY,
+            },
+            "test_mode": True,
+        },
+        {
+            "id": ANY,
+            "object_type": "rate",
+            "carrier_name": "canadapost",
+            "carrier_id": "canadapost",
+            "currency": "CAD",
+            "estimated_delivery": ANY,
+            "service": "canadapost_priority",
+            "total_charge": 114.93,
+            "transit_days": 2,
+            "extra_charges": [
+                {"name": "Base charge", "amount": 101.83, "currency": "CAD", "id": None},
+                {"name": "Fuel surcharge", "amount": 4.27, "currency": "CAD", "id": None},
+                {"name": "SMB Savings", "amount": -7.03, "currency": "CAD", "id": None},
+                {"name": "Duties and taxes", "amount": 14.86, "currency": "CAD", "id": None},
+                {"name": "Discount", "amount": -2.76, "currency": "CAD", "id": None},
+                {"name": "brokerage", "amount": 1.0, "currency": "CAD", "id": ANY},
+            ],
+            "meta": {
+                "ext": "canadapost",
+                "carrier": "canadapost",
+                "carrier_connection_id": ANY,
+                "rate_provider": "canadapost",
+                "service_name": "CANADAPOST PRIORITY",
+            },
+            "test_mode": True,
+        },
+    ],
+}
+
+RATING_WITH_PERCENTAGE_RESPONSE = {
+    "messages": [],
+    "rates": [
+        {
+            "id": ANY,
+            "object_type": "rate",
+            "carrier_name": "canadapost",
+            "carrier_id": "canadapost",
+            "currency": "CAD",
+            "estimated_delivery": ANY,
+            "service": "canadapost_expedited_parcel",
+            "total_charge": 32.99,
+            "transit_days": 7,
+            "extra_charges": [
+                {"name": "Base charge", "amount": 29.64, "currency": "CAD", "id": None},
+                {"name": "Fuel surcharge", "amount": 1.24, "currency": "CAD", "id": None},
+                {"name": "SMB Savings", "amount": -2.19, "currency": "CAD", "id": None},
+                {"name": "Duty and taxes", "amount": 4.3, "currency": "CAD", "id": None},
+                {"name": "Discount", "amount": -0.95, "currency": "CAD", "id": None},
+            ],
+            "meta": {
+                "ext": "canadapost",
+                "carrier": "canadapost",
+                "rate_provider": "canadapost",
+                "service_name": "CANADAPOST EXPEDITED PARCEL",
+                "carrier_connection_id": ANY,
+            },
+            "test_mode": True,
+        },
+        {
+            "id": ANY,
+            "object_type": "rate",
+            "carrier_name": "canadapost",
+            "carrier_id": "canadapost",
+            "currency": "CAD",
+            "estimated_delivery": ANY,
+            "service": "canadapost_xpresspost",
+            "total_charge": 85.65,
+            "transit_days": 2,
+            "extra_charges": [
+                {"name": "Base charge", "amount": 75.82, "currency": "CAD", "id": None},
+                {"name": "Fuel surcharge", "amount": 3.21, "currency": "CAD", "id": None},
+                {"name": "SMB Savings", "amount": -4.55, "currency": "CAD", "id": None},
+                {"name": "Duty and taxes", "amount": 4.3, "currency": "CAD", "id": None},
+                {"name": "Discount", "amount": 11.17, "currency": "CAD", "id": None},
+            ],
+            "meta": {
+                "ext": "canadapost",
+                "carrier": "canadapost",
+                "rate_provider": "canadapost",
+                "service_name": "CANADAPOST XPRESSPOST",
+                "carrier_connection_id": ANY,
+            },
+            "test_mode": True,
+        },
+        {
+            "id": ANY,
+            "object_type": "rate",
+            "carrier_name": "canadapost",
+            "carrier_id": "canadapost",
+            "currency": "CAD",
+            "estimated_delivery": ANY,
+            "service": "canadapost_priority",
+            "total_charge": 116.21,
+            "transit_days": 2,
+            "extra_charges": [
+                {"name": "Base charge", "amount": 101.83, "currency": "CAD", "id": None},
+                {"name": "Fuel surcharge", "amount": 4.27, "currency": "CAD", "id": None},
+                {"name": "SMB Savings", "amount": -7.03, "currency": "CAD", "id": None},
+                {"name": "Duties and taxes", "amount": 14.86, "currency": "CAD", "id": None},
+                {"name": "Discount", "amount": -2.76, "currency": "CAD", "id": None},
+                {"name": "brokerage", "amount": 2.28, "currency": "CAD", "id": ANY},
+            ],
+            "meta": {
+                "ext": "canadapost",
+                "carrier": "canadapost",
+                "carrier_connection_id": ANY,
+                "rate_provider": "canadapost",
+                "service_name": "CANADAPOST PRIORITY",
+            },
+            "test_mode": True,
+        },
+    ],
+}

karrio/server/pricing/views.py

@@ -0,0 +1,3 @@
+from django.shortcuts import render
+
+# Create your views here.

karrio_server_pricing-2025.5.dist-info/METADATA

@@ -0,0 +1,27 @@
+Metadata-Version: 2.4
+Name: karrio_server_pricing
+Version: 2025.5
+Summary: Multi-carrier shipping API Pricing panel
+Author-email: karrio <hello@karrio.io>
+License-Expression: LGPL-3.0
+Project-URL: Homepage, https://github.com/karrioapi/karrio
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: karrio_server_core
+
+# karrio.server.pricing
+
+This package is a module of the [karrio](https://pypi.org/project/karrio.server) universal shipping API.
+
+## Requirements
+
+`Python 3.11+`
+
+## Installation
+
+```bash
+pip install karrio.server.pricing
+```
+
+Check the [karrio docs](https://docs.karrio.io) to get started.