karrio-server-manager 2025.5rc36__py3-none-any.whl → 2025.5.1__py3-none-any.whl

karrio/server/manager/serializers/shipment.py

@@ -48,6 +48,7 @@ from karrio.server.manager.serializers.customs import CustomsSerializer
 from karrio.server.manager.serializers.parcel import ParcelSerializer
 from karrio.server.manager.serializers.rate import RateSerializer
 import karrio.server.manager.models as models
+
 DEFAULT_CARRIER_FILTER: typing.Any = dict(active=True, capability="shipping")
 
 
@@ -288,7 +289,16 @@ class ShipmentSerializer(ShipmentData):
 
 
 class ShipmentPurchaseData(Serializer):
-    selected_rate_id = CharField(required=True, help_text="The shipment selected rate.")
+    selected_rate_id = CharField(
+        required=False,
+        allow_null=True,
+        help_text="The shipment selected rate.",
+    )
+    service = CharField(
+        required=False,
+        allow_null=True,
+        help_text="The carrier service to use for the shipment (alternative to selected_rate_id).",
+    )
     label_type = ChoiceField(
         required=False,
         choices=LABEL_TYPES,
@@ -306,6 +316,15 @@ class ShipmentPurchaseData(Serializer):
         required=False, help_text="User metadata for the shipment"
     )
 
+    def validate(self, data):
+        if not data.get("selected_rate_id") and not data.get("service"):
+            raise exceptions.APIException(
+                "Either 'selected_rate_id' or 'service' must be provided.",
+                code="validation_error",
+                status_code=status.HTTP_400_BAD_REQUEST,
+            )
+        return data
+
 
 class ShipmentUpdateData(validators.OptionDefaultSerializer):
     label_type = ChoiceField(
@@ -792,9 +811,15 @@ def create_shipment_tracker(shipment: typing.Optional[models.Shipment], context)
             )
             tracker.save()
             link_org(tracker, context)
-            logger.info("Successfully added a tracker to the shipment", shipment_id=shipment.id)
+            logger.info(
+                "Successfully added a tracker to the shipment", shipment_id=shipment.id
+            )
         except Exception as e:
-            logger.exception("Failed to create new label tracker", error=str(e), shipment_id=shipment.id)
+            logger.exception(
+                "Failed to create new label tracker",
+                error=str(e),
+                shipment_id=shipment.id,
+            )
 
         # Update shipment tracking url if different from the current one
         try:
@@ -815,7 +840,12 @@ def create_shipment_tracker(shipment: typing.Optional[models.Shipment], context)
                 shipment.tracking_url = tracking_url
                 shipment.save(update_fields=["tracking_url"])
         except Exception as e:
-            logger.exception("Failed to update shipment tracking url", error=str(e), shipment_id=shipment.id, tracking_number=shipment.tracking_number)
+            logger.exception(
+                "Failed to update shipment tracking url",
+                error=str(e),
+                shipment_id=shipment.id,
+                tracking_number=shipment.tracking_number,
+            )
 
 
 def generate_custom_invoice(template: str, shipment: models.Shipment, **kwargs):
@@ -843,7 +873,11 @@ def generate_custom_invoice(template: str, shipment: models.Shipment, **kwargs):
         shipment.invoice = document["doc_file"]
         shipment.save(update_fields=["invoice"])
 
-    logger.info("Custom document successfully generated", shipment_id=shipment.id, template=template)
+    logger.info(
+        "Custom document successfully generated",
+        shipment_id=shipment.id,
+        template=template,
+    )
 
     return document
 

karrio/server/manager/tests/test_errors.py

@@ -0,0 +1,88 @@
+import json
+from django.urls import reverse
+from rest_framework import status
+from karrio.server.core.tests import APITestCase
+
+
+class TestNotFoundErrors(APITestCase):
+    def test_address_not_found_returns_resource_name(self):
+        url = reverse(
+            "karrio.server.manager:address-details",
+            kwargs=dict(pk="nonexistent_id"),
+        )
+        response = self.client.get(url)
+        response_data = json.loads(response.content)
+
+        self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
+        self.assertDictEqual(
+            response_data,
+            {"errors": [{"code": "not_found", "message": "Address not found"}]},
+        )
+
+    def test_parcel_not_found_returns_resource_name(self):
+        url = reverse(
+            "karrio.server.manager:parcel-details",
+            kwargs=dict(pk="nonexistent_id"),
+        )
+        response = self.client.get(url)
+        response_data = json.loads(response.content)
+
+        self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
+        self.assertDictEqual(
+            response_data,
+            {"errors": [{"code": "not_found", "message": "Parcel not found"}]},
+        )
+
+    def test_shipment_not_found_returns_resource_name(self):
+        url = reverse(
+            "karrio.server.manager:shipment-details",
+            kwargs=dict(pk="nonexistent_id"),
+        )
+        response = self.client.get(url)
+        response_data = json.loads(response.content)
+
+        self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
+        self.assertDictEqual(
+            response_data,
+            {"errors": [{"code": "not_found", "message": "Shipment not found"}]},
+        )
+
+    def test_customs_not_found_returns_resource_name(self):
+        url = reverse(
+            "karrio.server.manager:customs-details",
+            kwargs=dict(pk="nonexistent_id"),
+        )
+        response = self.client.get(url)
+        response_data = json.loads(response.content)
+
+        self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
+        self.assertDictEqual(
+            response_data,
+            {"errors": [{"code": "not_found", "message": "Customs not found"}]},
+        )
+
+
+class TestValidationErrors(APITestCase):
+    def test_shipment_validation_error_format(self):
+        url = reverse("karrio.server.manager:shipment-list")
+        data = {
+            "shipper": {},
+            "recipient": {},
+            "parcels": [],
+        }
+        response = self.client.post(url, data, format="json")
+        response_data = json.loads(response.content)
+
+        self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
+        self.assertIn("errors", response_data)
+        self.assertTrue(len(response_data["errors"]) > 0)
+
+    def test_address_validation_error_format(self):
+        url = reverse("karrio.server.manager:address-list")
+        data = {"country_code": "INVALID"}
+        response = self.client.post(url, data, format="json")
+        response_data = json.loads(response.content)
+
+        self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
+        self.assertIn("errors", response_data)
+        self.assertTrue(len(response_data["errors"]) > 0)

karrio/server/manager/tests/test_shipments.py

@@ -831,3 +831,195 @@ CANCEL_PURCHASED_RESPONSE = {
     "label_url": None,
     "invoice_url": None,
 }
+
+
+class TestShipmentPurchaseWithAlternativeServices(TestShipmentFixture):
+    def setUp(self) -> None:
+        super().setUp()
+        carrier = providers.Carrier.objects.get(carrier_id="canadapost")
+        # Rates have "canadapost_regular_parcel" but we'll request "canadapost_priority"
+        self.shipment.rates = [
+            {
+                "id": "rat_alt_service_test",
+                "carrier_id": "canadapost",
+                "carrier_name": "canadapost",
+                "currency": "CAD",
+                "estimated_delivery": None,
+                "extra_charges": [
+                    {"amount": 50.00, "currency": "CAD", "name": "Base charge"},
+                ],
+                "service": "canadapost_regular_parcel",
+                "total_charge": 50.00,
+                "transit_days": 5,
+                "test_mode": True,
+                "meta": {
+                    "rate_provider": "canadapost",
+                    "service_name": "CANADAPOST REGULAR PARCEL",
+                    "carrier_connection_id": carrier.pk,
+                },
+            }
+        ]
+        self.shipment.options = {"has_alternative_services": True}
+        self.shipment.save()
+
+    def test_purchase_with_alternative_service(self):
+        """
+        Test that when canadapost_priority is requested but only canadapost_regular_parcel
+        is in rates, the purchase proceeds with has_alternative_services=True,
+        delegating service resolution to the carrier.
+        """
+        url = reverse(
+            "karrio.server.manager:shipment-purchase",
+            kwargs=dict(pk=self.shipment.pk),
+        )
+        data = {"service": "canadapost_priority"}
+
+        with patch("karrio.server.core.gateway.utils.identity") as mock:
+            mock.return_value = CREATED_SHIPMENT_RESPONSE
+            response = self.client.post(url, data)
+            response_data = json.loads(response.content)
+
+            self.assertEqual(response.status_code, status.HTTP_200_OK)
+            self.assertDictEqual(response_data, ALTERNATIVE_SERVICE_PURCHASED_SHIPMENT)
+
+
+ALTERNATIVE_SERVICE_PURCHASED_SHIPMENT = {
+    "id": ANY,
+    "object_type": "shipment",
+    "tracking_url": "/v1/trackers/canadapost/123456789012",
+    "shipper": {
+        "id": ANY,
+        "postal_code": "E1C4Z8",
+        "city": "Moncton",
+        "federal_tax_id": None,
+        "state_tax_id": None,
+        "person_name": "John Poop",
+        "company_name": "A corp.",
+        "country_code": "CA",
+        "email": None,
+        "phone_number": "514 000 0000",
+        "state_code": "NB",
+        "street_number": None,
+        "residential": False,
+        "address_line1": "125 Church St",
+        "address_line2": None,
+        "validate_location": False,
+        "object_type": "address",
+        "validation": None,
+    },
+    "recipient": {
+        "id": ANY,
+        "postal_code": "V6M2V9",
+        "city": "Vancouver",
+        "federal_tax_id": None,
+        "state_tax_id": None,
+        "person_name": "Jane Doe",
+        "company_name": "B corp.",
+        "country_code": "CA",
+        "email": None,
+        "phone_number": "514 000 9999",
+        "state_code": "BC",
+        "street_number": None,
+        "residential": False,
+        "address_line1": "5840 Oak St",
+        "address_line2": None,
+        "validate_location": False,
+        "object_type": "address",
+        "validation": None,
+    },
+    "parcels": [
+        {
+            "id": ANY,
+            "weight": 1.0,
+            "width": None,
+            "height": None,
+            "length": None,
+            "packaging_type": None,
+            "package_preset": "canadapost_corrugated_small_box",
+            "description": None,
+            "content": None,
+            "is_document": False,
+            "weight_unit": "KG",
+            "dimension_unit": None,
+            "items": [],
+            "freight_class": None,
+            "reference_number": ANY,
+            "object_type": "parcel",
+            "options": {},
+        }
+    ],
+    "services": [],
+    "options": {"has_alternative_services": True, "shipping_date": ANY, "shipment_date": ANY},
+    "payment": {"paid_by": "sender", "currency": "CAD", "account_number": None},
+    "return_address": None,
+    "billing_address": None,
+    "customs": None,
+    "rates": [
+        {
+            "id": ANY,
+            "object_type": "rate",
+            "carrier_name": "canadapost",
+            "carrier_id": "canadapost",
+            "currency": "CAD",
+            "estimated_delivery": ANY,
+            "service": "canadapost_regular_parcel",
+            "total_charge": 50.00,
+            "transit_days": 5,
+            "extra_charges": [
+                {"name": "Base charge", "amount": 50.00, "currency": "CAD", "id": None},
+            ],
+            "meta": {
+                "service_name": "CANADAPOST REGULAR PARCEL",
+                "rate_provider": "canadapost",
+                "carrier_connection_id": ANY,
+            },
+            "test_mode": True,
+        }
+    ],
+    "reference": None,
+    "label_type": "PDF",
+    "carrier_ids": [],
+    "tracker_id": ANY,
+    "created_at": ANY,
+    "metadata": {},
+    "messages": [],
+    "status": "purchased",
+    "carrier_name": "canadapost",
+    "carrier_id": "canadapost",
+    "tracking_number": "123456789012",
+    "shipment_identifier": "123456789012",
+    "selected_rate": {
+        "id": ANY,
+        "object_type": "rate",
+        "carrier_name": "canadapost",
+        "carrier_id": "canadapost",
+        "currency": "CAD",
+        "estimated_delivery": ANY,
+        "service": "canadapost_priority",
+        "total_charge": 50.00,
+        "transit_days": 5,
+        "extra_charges": [
+            {"name": "Base charge", "amount": 50.00, "currency": "CAD", "id": None},
+        ],
+        "meta": {
+            "ext": "canadapost",
+            "carrier": "canadapost",
+            "service_name": "CANADAPOST REGULAR PARCEL",
+            "rate_provider": "canadapost",
+            "carrier_connection_id": ANY,
+            "has_alternative_services": True,
+        },
+        "test_mode": True,
+    },
+    "meta": {
+        "ext": "canadapost",
+        "carrier": "canadapost",
+        "rate_provider": "canadapost",
+        "service_name": "CANADAPOST PRIORITY",
+    },
+    "service": "canadapost_priority",
+    "selected_rate_id": ANY,
+    "test_mode": True,
+    "label_url": ANY,
+    "invoice_url": None,
+}

karrio/server/manager/views/manifests.py

@@ -10,7 +10,7 @@ import rest_framework.pagination as pagination
 import rest_framework.throttling as throttling
 import django_filters.rest_framework as django_filters
 
-from karrio.server.core.logging import logger
+from karrio.server.core.utils import validate_resource_token
 import karrio.server.openapi as openapi
 import karrio.server.core.views.api as api
 import karrio.server.core.filters as filters
@@ -107,26 +107,24 @@ class ManifestDetails(api.APIView):
 
 class ManifestDoc(django_downloadview.VirtualDownloadView):
     @openapi.extend_schema(exclude=True)
-    def get(
-        self,
-        request: request.Request,
-        pk: str,
-        doc: str = "manifest",
-        format: str = "pdf",
-        **kwargs,
-    ):
+    def get(self, req: request.Request, pk: str, doc: str = "manifest", format: str = "pdf", **kwargs):
         """Retrieve a manifest file."""
+        error = validate_resource_token(req, "manifest", [pk], "manifest")
+        if error:
+            return error
+
+        query_params = req.GET.dict()
+
         self.manifest = models.Manifest.objects.get(pk=pk, manifest__isnull=False)
         self.document = getattr(self.manifest, doc, None)
         self.name = f"{doc}_{self.manifest.id}.{format}"
 
-        query_params = request.GET.dict()
         self.preview = "preview" in query_params
         self.attachment = "download" in query_params
 
-        response = super(ManifestDoc, self).get(request, pk, doc, format, **kwargs)
-        response["X-Frame-Options"] = "ALLOWALL"
-        return response
+        resp = super(ManifestDoc, self).get(req, pk, doc, format, **kwargs)
+        resp["X-Frame-Options"] = "ALLOWALL"
+        return resp
 
     def get_file(self):
         content = base64.b64decode(self.document or "")

karrio/server/manager/views/shipments.py

@@ -14,7 +14,6 @@ import karrio.lib as lib
 import karrio.server.openapi as openapi
 import karrio.server.core.filters as filters
 import karrio.server.manager.models as models
-from karrio.server.core.logging import logger
 from karrio.server.core.views.api import GenericAPIView, APIView
 from karrio.server.core.filters import ShipmentFilters
 from karrio.server.manager.router import router
@@ -267,12 +266,19 @@ class ShipmentDocs(VirtualDownloadView):
         format: str = "pdf",
         **kwargs,
     ):
-        """Retrieve a shipment label."""
+        """Retrieve a shipment label or invoice."""
+        from karrio.server.core.utils import validate_resource_token
+
+        error = validate_resource_token(request, "shipment", [pk], doc)
+        if error:
+            return error
+
+        query_params = request.GET.dict()
+
         self.shipment = models.Shipment.objects.get(pk=pk, label__isnull=False)
         self.document = getattr(self.shipment, doc, None)
         self.name = f"{doc}_{self.shipment.tracking_number}.{format}"
 
-        query_params = request.GET.dict()
         self.preview = "preview" in query_params
         self.attachment = "download" in query_params
 

{karrio_server_manager-2025.5rc36.dist-info → karrio_server_manager-2025.5.1.dist-info}/METADATA

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: karrio_server_manager
-Version: 2025.5rc36
+Version: 2025.5.1
 Summary: Multi-carrier shipping API Shipments manager module
 Author-email: karrio <hello@karrio.io>
-License-Expression: Apache-2.0
+License-Expression: LGPL-3.0
 Project-URL: Homepage, https://github.com/karrioapi/karrio
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.11

{karrio_server_manager-2025.5rc36.dist-info → karrio_server_manager-2025.5.1.dist-info}/RECORD

@@ -82,25 +82,26 @@ karrio/server/manager/serializers/manifest.py,sha256=mSneCk_7HMXpi64_7hggWvkR7Ma
 karrio/server/manager/serializers/parcel.py,sha256=733Bg26lVbEkoWtAVM5Qt2IRBS2QDuVxhG40Hiqh3bw,2621
 karrio/server/manager/serializers/pickup.py,sha256=sX0VmcQxGkXn3IEosMuFwdXh4HhdkPcuBOp79O8PoDQ,9233
 karrio/server/manager/serializers/rate.py,sha256=7vYK_v8iWEDnswqYHG2Lir16_UhHTOxW5rdC6lw3lzA,652
-karrio/server/manager/serializers/shipment.py,sha256=G4vA51UFHvBVNNR9z3Vtac-Y7GexjGadPOCRxSUVqRE,30355
+karrio/server/manager/serializers/shipment.py,sha256=gkDFTDaKXA8Iz3yjS6fxRi46AzZPw40RhJEOlnBZy6o,31143
 karrio/server/manager/serializers/tracking.py,sha256=ixrAjIiZQsvSt4y0qtisGkt6TFOJ3ORNkJAQVt6YQrA,12483
 karrio/server/manager/tests/__init__.py,sha256=Y1UNteEE60vWdUAkjbldu_r_-h4u0He8-UoiBgTjKcU,391
 karrio/server/manager/tests/test_addresses.py,sha256=pNkZC_yJyb29ZlEOtOAs4blcEYiOarw0zhZIZC5uj1w,3111
 karrio/server/manager/tests/test_custom_infos.py,sha256=iv2cLdZVoVWFZK_mDUEnrZssncAnQcn87Rn2sAk8UQI,2731
+karrio/server/manager/tests/test_errors.py,sha256=QYsGLUtwMvrHeX1XSCpdteTKbug7-y1-Xgvbl96aN9g,3220
 karrio/server/manager/tests/test_parcels.py,sha256=lVLBOsHzXgXQvYjHIUy5oiPvrMfxYpueVvvhtuhstWk,2559
 karrio/server/manager/tests/test_pickups.py,sha256=8jxddwTnBvBM9FOyWxW9TtZ-GOVYUje7HQ2EZjsbtD8,10681
-karrio/server/manager/tests/test_shipments.py,sha256=9QlsvAZK0owvDwK8lVAdVVUYAtFOkr7cIKoU7W-wRls,26946
+karrio/server/manager/tests/test_shipments.py,sha256=N1eVH-n0BTANmzehKL0cp917goskU5X8l_ftXzcVSmw,33349
 karrio/server/manager/tests/test_trackers.py,sha256=KvmWkplokNDZ0dzB16mFl0WcMJ0OYp_ErZeWJPGW_NA,7151
 karrio/server/manager/views/__init__.py,sha256=kDFUaORRQ3Xh0ZPm-Jk88Ss8dgGYM57iUFXb9TPMzh0,401
 karrio/server/manager/views/addresses.py,sha256=7YCAs2ZYgd1icYwMcGGWfX7A7vZEL4BEAbU4eIxhiMY,4620
 karrio/server/manager/views/customs.py,sha256=-ZreiKyJ1xeLeNVG53nMfRQFeURduWr1QkDItdLPnE8,4875
 karrio/server/manager/views/documents.py,sha256=znW54qJ_k7WInIut5FBZFDT93CioozXTOYFKRSUTBhA,4005
-karrio/server/manager/views/manifests.py,sha256=4VyeiFaeKkWRvKmZZcfw7qjHynsR03t4M_fwwiZklZQ,5171
+karrio/server/manager/views/manifests.py,sha256=_Dd83YxVJOgWhAhD745Kr4tcLWnKaU1dxnT5xB8opvk,5227
 karrio/server/manager/views/parcels.py,sha256=hZY45rg6SrTWfQqyJ38MGKSor1yqgPUEVHtu16aG37g,4594
 karrio/server/manager/views/pickups.py,sha256=gmpxz9ot1OR-BP1qh-0MXU3kUJi1ht_74hfaLJzJ42w,5503
-karrio/server/manager/views/shipments.py,sha256=_5EJfgxEO6H2EdQQbaSwILgnim7slqxMKDkEk_97F9c,10267
+karrio/server/manager/views/shipments.py,sha256=TqLpBH5Jf-rI3enJwvNptRwGzfo7co9R1VSP_oqhB3o,10419
 karrio/server/manager/views/trackers.py,sha256=3oGn2qDpHgk8GZvuz-Cb93Fc0j_h_HbXQR692Zhfiok,12363
-karrio_server_manager-2025.5rc36.dist-info/METADATA,sha256=gqVdjXCp3F4TIfvQWnxEJ76Js6deZo0n6BRct9pJC9I,734
-karrio_server_manager-2025.5rc36.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-karrio_server_manager-2025.5rc36.dist-info/top_level.txt,sha256=D1D7x8R3cTfjF_15mfiO7wCQ5QMtuM4x8GaPr7z5i78,12
-karrio_server_manager-2025.5rc36.dist-info/RECORD,,
+karrio_server_manager-2025.5.1.dist-info/METADATA,sha256=7G3zIzLe_6ux6VkjCj1ub1xQc4b9Cz-uiyzwvBpSDDs,730
+karrio_server_manager-2025.5.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+karrio_server_manager-2025.5.1.dist-info/top_level.txt,sha256=D1D7x8R3cTfjF_15mfiO7wCQ5QMtuM4x8GaPr7z5i78,12
+karrio_server_manager-2025.5.1.dist-info/RECORD,,