karrio-server-manager 2025.5.2__py3-none-any.whl → 2025.5.4__py3-none-any.whl

karrio/server/manager/migrations/0067_rename_customs_commodities_table.py

@@ -0,0 +1,56 @@
+# Generated migration to fix ManyToMany junction table names
+# The RenameField in migration 0010 didn't properly rename the ManyToMany junction tables
+# This is a long-standing bug that's now being fixed
+
+from django.db import migrations
+
+
+# Mapping of old table names to new table names
+TABLE_RENAMES = [
+    ('customs_shipment_commodities', 'customs_commodities'),
+    ('shipment_shipment_parcels', 'shipment_parcels'),
+]
+
+
+def rename_junction_tables(_apps, schema_editor):
+    """
+    Rename ManyToMany junction tables from old names to new names.
+    Uses Django's introspection API for database-agnostic table detection.
+    """
+    connection = schema_editor.connection
+    existing_tables = connection.introspection.table_names()
+
+    for old_table, new_table in TABLE_RENAMES:
+        if old_table in existing_tables and new_table not in existing_tables:
+            schema_editor.execute(
+                schema_editor.sql_rename_table % {
+                    "old_table": schema_editor.quote_name(old_table),
+                    "new_table": schema_editor.quote_name(new_table),
+                }
+            )
+
+
+def reverse_rename(_apps, schema_editor):
+    """Reverse the table renames."""
+    connection = schema_editor.connection
+    existing_tables = connection.introspection.table_names()
+
+    for old_table, new_table in TABLE_RENAMES:
+        if new_table in existing_tables and old_table not in existing_tables:
+            schema_editor.execute(
+                schema_editor.sql_rename_table % {
+                    "old_table": schema_editor.quote_name(new_table),
+                    "new_table": schema_editor.quote_name(old_table),
+                }
+            )
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('manager', '0066_commodity_image_url_commodity_product_id_and_more'),
+    ]
+
+    operations = [
+        migrations.RunPython(rename_junction_tables, reverse_rename),
+    ]

karrio/server/manager/serializers/__init__.py

@@ -26,6 +26,7 @@ from karrio.server.manager.serializers.tracking import (
 )
 from karrio.server.manager.serializers.shipment import (
     ShipmentRateData,
+    PurchasedShipment,
     ShipmentSerializer,
     ShipmentUpdateData,
     ShipmentPurchaseData,

karrio/server/manager/serializers/shipment.py

@@ -33,6 +33,7 @@ from karrio.server.core.serializers import (
     SHIPMENT_STATUS,
     LABEL_TYPES,
     ShipmentCancelRequest,
+    ShippingDocument,
     ShipmentDetails,
     ShipmentStatus,
     TrackerStatus,
@@ -131,11 +132,16 @@ class ShipmentSerializer(ShipmentData):
         self, validated_data: dict, context: Context, **kwargs
     ) -> models.Shipment:
         # fmt: off
+        # Apply shipping method if specified (HIGHEST PRIORITY - supersedes service)
+        apply_shipping_method_flag, validated_data = resolve_shipping_method(
+            validated_data, context
+        )
+        options = validated_data.get("options") or {}
+
         service = validated_data.get("service")
         carrier_ids = validated_data.get("carrier_ids") or []
         fetch_rates = validated_data.get("fetch_rates") is not False
         services = [service] if service is not None else validated_data.get("services")
-        options = validated_data.get("options") or {}
 
         # Check if we should skip rate fetching for has_alternative_services
         skip_rate_fetching, resolved_carrier_name, _ = (
@@ -244,8 +250,8 @@ class ShipmentSerializer(ShipmentData):
             context=context,
         )
 
-        # Buy label if preferred service is selected, shipping rules applied, or skip rate fetching
-        if (service and fetch_rates) or apply_shipping_rules or skip_rate_fetching:
+        # Buy label if preferred service is selected, shipping method applied, shipping rules applied, or skip rate fetching
+        if (service and fetch_rates) or apply_shipping_method_flag or apply_shipping_rules or skip_rate_fetching:
             return buy_shipment_label(
                 shipment,
                 context=context,
@@ -570,6 +576,16 @@ class ShipmentCancelSerializer(Shipment):
         return instance
 
 
+@validators.shipment_documents_accessor(include_base64=True)
+class PurchasedShipment(Shipment):
+    shipping_documents = ShippingDocument(
+        required=False,
+        many=True,
+        default=[],
+        help_text="The list of shipping documents",
+    )
+
+
 def fetch_shipment_rates(
     shipment: models.Shipment,
     context: typing.Any,
@@ -673,16 +689,27 @@ def buy_shipment_label(
         docs={**lib.to_dict(response.docs), **invoice},
     )
 
-    # Update shipment state
+    # Update shipment state - preserve original meta and merge with response meta
+    response_details = ShipmentDetails(response).data
+    merged_meta = {
+        **(shipment.meta or {}),
+        **(response_details.get("meta") or {}),
+        **(
+            {"rule_activity": kwargs.get("rule_activity")}
+            if kwargs.get("rule_activity")
+            else {}
+        ),
+    }
+
     purchased_shipment = lib.identity(
         ShipmentSerializer.map(
             shipment,
             context=context,
             data={
                 **payload,
-                **ShipmentDetails(response).data,
+                **response_details,
                 **extra,
-                # "meta": {**(response.meta or {}), "rule_activity": kwargs.get("rule_activity", None)},
+                "meta": merged_meta,
             },
         )
         .save()
@@ -998,3 +1025,43 @@ def resolve_alternative_service_carrier(
     ]
 
     return skip_rate_fetching, resolved_carrier_name, synthetic_rates
+
+
+def resolve_shipping_method(
+    validated_data: dict,
+    context: Context,
+) -> typing.Tuple[bool, dict]:
+    """
+    Resolve and apply shipping method configuration if specified.
+
+    When options.shipping_method is provided, this function:
+    1. Validates the SHIPPING_METHODS feature is enabled
+    2. Loads and applies the shipping method configuration
+
+    Returns:
+        Tuple of (apply_shipping_method_flag, modified_validated_data)
+    """
+    if not getattr(conf.settings, "SHIPPING_METHODS", False):
+        options = validated_data.get("options") or {}
+        shipping_method_id = options.get("shipping_method")
+
+        if shipping_method_id is not None:
+            raise exceptions.APIException(
+                "Shipping methods feature is not enabled.",
+                code="feature_disabled",
+                status_code=status.HTTP_400_BAD_REQUEST,
+            )
+
+        return False, validated_data
+
+    options = validated_data.get("options") or {}
+    shipping_method_id = options.get("shipping_method")
+
+    if shipping_method_id is None:
+        return False, validated_data
+
+    modified_data = utils.load_and_apply_shipping_method(
+        validated_data, shipping_method_id, context
+    )
+
+    return True, modified_data

karrio/server/manager/tests/test_errors.py

@@ -16,7 +16,7 @@ class TestNotFoundErrors(APITestCase):
         self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
         self.assertDictEqual(
             response_data,
-            {"errors": [{"code": "not_found", "message": "Address not found"}]},
+            {"errors": [{"code": "not_found", "message": "Address not found", "level": "warning"}]},
         )
 
     def test_parcel_not_found_returns_resource_name(self):
@@ -30,7 +30,7 @@ class TestNotFoundErrors(APITestCase):
         self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
         self.assertDictEqual(
             response_data,
-            {"errors": [{"code": "not_found", "message": "Parcel not found"}]},
+            {"errors": [{"code": "not_found", "message": "Parcel not found", "level": "warning"}]},
         )
 
     def test_shipment_not_found_returns_resource_name(self):
@@ -44,7 +44,7 @@ class TestNotFoundErrors(APITestCase):
         self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
         self.assertDictEqual(
             response_data,
-            {"errors": [{"code": "not_found", "message": "Shipment not found"}]},
+            {"errors": [{"code": "not_found", "message": "Shipment not found", "level": "warning"}]},
         )
 
     def test_customs_not_found_returns_resource_name(self):
@@ -58,7 +58,7 @@ class TestNotFoundErrors(APITestCase):
         self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
         self.assertDictEqual(
             response_data,
-            {"errors": [{"code": "not_found", "message": "Customs not found"}]},
+            {"errors": [{"code": "not_found", "message": "Customs not found", "level": "warning"}]},
         )
 
 
@@ -76,6 +76,9 @@ class TestValidationErrors(APITestCase):
         self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
         self.assertIn("errors", response_data)
         self.assertTrue(len(response_data["errors"]) > 0)
+        # Validation errors should have level="error"
+        for error in response_data["errors"]:
+            self.assertEqual(error.get("level"), "error")
 
     def test_address_validation_error_format(self):
         url = reverse("karrio.server.manager:address-list")
@@ -86,3 +89,6 @@ class TestValidationErrors(APITestCase):
         self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
         self.assertIn("errors", response_data)
         self.assertTrue(len(response_data["errors"]) > 0)
+        # Validation errors should have level="error"
+        for error in response_data["errors"]:
+            self.assertEqual(error.get("level"), "error")

karrio/server/manager/tests/test_manifests.py

@@ -0,0 +1,83 @@
+import json
+from unittest.mock import patch, ANY
+from django.urls import reverse
+from rest_framework import status
+from karrio.core.models import ManifestDetails as ManifestDetailsModel
+from karrio.server.manager.tests.test_shipments import (
+    TestShipmentFixture,
+    RETURNED_RATES_VALUE,
+    CREATED_SHIPMENT_RESPONSE,
+    SINGLE_CALL_LABEL_DATA,
+)
+
+
+class TestManifestDocumentDownload(TestShipmentFixture):
+    """Test manifest document download POST API."""
+
+    def create_manifest(self):
+        """Create a manifest via API with a purchased shipment."""
+        # First create and purchase a shipment
+        shipment_url = reverse("karrio.server.manager:shipment-list")
+
+        with patch("karrio.server.core.gateway.utils.identity") as mock:
+            mock.side_effect = [RETURNED_RATES_VALUE, CREATED_SHIPMENT_RESPONSE]
+            response = self.client.post(shipment_url, SINGLE_CALL_LABEL_DATA)
+            shipment = json.loads(response.content)
+
+        # Create manifest via API
+        manifest_url = reverse("karrio.server.manager:manifest-list")
+        manifest_data = {
+            "carrier_name": "canadapost",
+            "shipment_ids": [shipment["id"]],
+            "address": {
+                "address_line1": "125 Church St",
+                "city": "Moncton",
+                "country_code": "CA",
+                "postal_code": "E1C4Z8",
+                "state_code": "NB",
+            },
+        }
+
+        with patch("karrio.server.core.gateway.utils.identity") as mock:
+            mock.return_value = MANIFEST_RESPONSE
+            response = self.client.post(manifest_url, manifest_data)
+            return json.loads(response.content)
+
+    def test_download_manifest_document(self):
+        manifest = self.create_manifest()
+
+        url = reverse(
+            "karrio.server.manager:manifest-document-download",
+            kwargs=dict(pk=manifest["id"]),
+        )
+        response = self.client.post(url)
+        response_data = json.loads(response.content)
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertDictEqual(response_data, MANIFEST_DOCUMENT_RESPONSE)
+
+    def test_download_manifest_not_found(self):
+        url = reverse(
+            "karrio.server.manager:manifest-document-download",
+            kwargs=dict(pk="manf_non_existent_id"),
+        )
+        response = self.client.post(url)
+
+        self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
+
+
+MANIFEST_RESPONSE = (
+    ManifestDetailsModel(
+        carrier_id="canadapost",
+        carrier_name="canadapost",
+        doc=dict(manifest="JVBERi0xLjQK"),
+    ),
+    [],
+)
+
+MANIFEST_DOCUMENT_RESPONSE = {
+    "category": "manifest",
+    "format": "PDF",
+    "base64": "JVBERi0xLjQK",
+    "url": ANY,
+}

karrio/server/manager/tests/test_shipments.py

@@ -517,6 +517,7 @@ SHIPMENT_RESPONSE = {
     "created_at": ANY,
     "test_mode": True,
     "messages": [],
+    "shipping_documents": [],
 }
 
 SHIPMENT_OPTIONS = {
@@ -747,6 +748,14 @@ PURCHASED_SHIPMENT = {
     "test_mode": True,
     "label_url": ANY,
     "invoice_url": None,
+    "shipping_documents": [
+        {
+            "category": "label",
+            "format": "PDF",
+            "url": ANY,
+            "base64": "==apodifjoefr",
+        }
+    ],
 }
 
 CANCEL_RESPONSE = {
@@ -885,6 +894,7 @@ CANCEL_RESPONSE = {
     "test_mode": True,
     "label_url": None,
     "invoice_url": None,
+    "shipping_documents": [],
 }
 
 CANCEL_PURCHASED_RESPONSE = {
@@ -1023,6 +1033,7 @@ CANCEL_PURCHASED_RESPONSE = {
     "test_mode": True,
     "label_url": None,
     "invoice_url": None,
+    "shipping_documents": [],
 }
 
 SINGLE_CALL_LABEL_DATA = {
@@ -1096,3 +1107,104 @@ SINGLE_CALL_SKIP_RATES_DATA = {
     "service": "canadapost_priority",
     "options": {"has_alternative_services": True},
 }
+
+
+class TestShipmentDocumentDownload(APITestCase):
+    """Test shipment document download POST API."""
+
+    def create_purchased_shipment(self):
+        """Create and purchase a shipment via API."""
+        url = reverse("karrio.server.manager:shipment-list")
+
+        with patch("karrio.server.core.gateway.utils.identity") as mock:
+            mock.side_effect = [RETURNED_RATES_VALUE, CREATED_SHIPMENT_RESPONSE]
+            response = self.client.post(url, SINGLE_CALL_LABEL_DATA)
+            return json.loads(response.content)
+
+    def test_download_label_document(self):
+        shipment = self.create_purchased_shipment()
+
+        url = reverse(
+            "karrio.server.manager:shipment-document-download",
+            kwargs=dict(pk=shipment["id"], doc="label"),
+        )
+        response = self.client.post(url)
+        response_data = json.loads(response.content)
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertDictEqual(
+            response_data,
+            LABEL_DOCUMENT_RESPONSE,
+        )
+
+    def test_download_document_not_found(self):
+        # Create a draft shipment (no label)
+        url = reverse("karrio.server.manager:shipment-list")
+
+        with patch("karrio.server.core.gateway.utils.identity") as mock:
+            mock.return_value = RETURNED_RATES_VALUE
+            response = self.client.post(url, SHIPMENT_DATA)
+            shipment = json.loads(response.content)
+
+        url = reverse(
+            "karrio.server.manager:shipment-document-download",
+            kwargs=dict(pk=shipment["id"], doc="label"),
+        )
+        response = self.client.post(url)
+
+        self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
+
+    def test_download_invalid_document_type(self):
+        shipment = self.create_purchased_shipment()
+
+        url = reverse(
+            "karrio.server.manager:shipment-document-download",
+            kwargs=dict(pk=shipment["id"], doc="invalid"),
+        )
+        response = self.client.post(url)
+
+        self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
+
+    def test_download_shipment_not_found(self):
+        url = reverse(
+            "karrio.server.manager:shipment-document-download",
+            kwargs=dict(pk="shp_non_existent_id", doc="label"),
+        )
+        response = self.client.post(url)
+
+        self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
+
+
+class TestShipmentCancelIdempotent(APITestCase):
+    """Test shipment cancel idempotency."""
+
+    def test_cancel_already_cancelled_shipment_returns_202(self):
+        # Create a shipment via API
+        url = reverse("karrio.server.manager:shipment-list")
+
+        with patch("karrio.server.core.gateway.utils.identity") as mock:
+            mock.return_value = RETURNED_RATES_VALUE
+            response = self.client.post(url, SHIPMENT_DATA)
+            shipment = json.loads(response.content)
+
+        # Cancel the shipment first time
+        cancel_url = reverse(
+            "karrio.server.manager:shipment-cancel",
+            kwargs=dict(pk=shipment["id"]),
+        )
+        self.client.post(cancel_url)
+
+        # Cancel again - should return 202
+        response = self.client.post(cancel_url)
+        response_data = json.loads(response.content)
+
+        self.assertEqual(response.status_code, status.HTTP_202_ACCEPTED)
+        self.assertEqual(response_data["status"], "cancelled")
+
+
+LABEL_DOCUMENT_RESPONSE = {
+    "category": "label",
+    "format": "PDF",
+    "base64": "==apodifjoefr",
+    "url": ANY,
+}

karrio/server/manager/tests/test_trackers.py

@@ -129,6 +129,7 @@ TRACKING_RESPONSE = {
             "time": "10:39",
             "latitude": None,
             "longitude": None,
+            "reason": None,
         }
     ],
     "messages": [],
@@ -180,6 +181,7 @@ UPDATE_TRACKING_RESPONSE = {
             "location": "BONN",
             "longitude": None,
             "time": "20:34",
+            "reason": None,
         }
     ],
     "delivered": False,

karrio/server/manager/views/manifests.py

@@ -17,6 +17,7 @@ import karrio.server.core.filters as filters
 import karrio.server.manager.models as models
 import karrio.server.manager.router as router
 import karrio.server.manager.serializers as serializers
+from karrio.server.core.serializers import ShippingDocument
 
 ENDPOINT_ID = "$$$$&&"  # This endpoint id is used to make operation ids unique make sure not to duplicate
 Manifests = serializers.PaginatedResult("ManifestList", serializers.Manifest)
@@ -115,7 +116,14 @@ class ManifestDoc(django_downloadview.VirtualDownloadView):
 
         query_params = req.GET.dict()
 
-        self.manifest = models.Manifest.objects.get(pk=pk, manifest__isnull=False)
+        self.manifest = models.Manifest.objects.filter(pk=pk, manifest__isnull=False).first()
+
+        if self.manifest is None:
+            return response.Response(
+                {"errors": [{"message": f"Manifest '{pk}' not found or has no document"}]},
+                status=status.HTTP_404_NOT_FOUND,
+            )
+
         self.document = getattr(self.manifest, doc, None)
         self.name = f"{doc}_{self.manifest.id}.{format}"
 
@@ -134,6 +142,47 @@ class ManifestDoc(django_downloadview.VirtualDownloadView):
         return base.ContentFile(buffer.getvalue(), name=self.name)
 
 
+class ManifestDocumentDownload(api.APIView):
+
+    @openapi.extend_schema(
+        tags=["Manifests"],
+        operation_id=f"{ENDPOINT_ID}document",
+        extensions={"x-operationId": "retrieveManifestDocument"},
+        summary="Retrieve a manifest document",
+        request=None,
+        responses={
+            200: ShippingDocument(),
+            404: serializers.ErrorResponse(),
+            500: serializers.ErrorResponse(),
+        },
+    )
+    def post(self, req: request.Request, pk: str):
+        """
+        Retrieve a manifest document as base64 encoded content.
+        """
+        manifest = models.Manifest.access_by(req).filter(pk=pk, manifest__isnull=False).first()
+
+        if manifest is None:
+            return response.Response(
+                {"errors": [{"message": f"Manifest '{pk}' not found or has no document"}]},
+                status=status.HTTP_404_NOT_FOUND,
+            )
+
+        # Build the GET URL for the document
+        doc_url = f"/v1/manifests/{pk}/manifest.pdf"
+
+        return response.Response(
+            ShippingDocument(
+                {
+                    "category": "manifest",
+                    "format": "PDF",
+                    "base64": manifest.manifest,
+                    "url": doc_url,
+                }
+            ).data
+        )
+
+
 router.router.urls.append(
     urls.path(
         "manifests",
@@ -148,9 +197,16 @@ router.router.urls.append(
         name="manifest-details",
     )
 )
+router.router.urls.append(
+    urls.path(
+        "manifests/<str:pk>/document",
+        ManifestDocumentDownload.as_view(),
+        name="manifest-document-download",
+    )
+)
 router.router.urls.append(
     urls.re_path(
-        r"^manifests/(?P<pk>\w+)/(?P<doc>[a-z0-9]+).(?P<format>[a-z0-9]+)",
+        r"^manifests/(?P<pk>\w+)/(?P<doc>[a-z0-9]+)\.(?P<format>[a-z0-9]+)",
         ManifestDoc.as_view(),
         name="manifest-docs",
     )

karrio/server/manager/views/shipments.py

@@ -25,6 +25,7 @@ from karrio.server.manager.serializers import (
     ErrorMessages,
     Shipment,
     ShipmentData,
+    ShipmentStatus,
     buy_shipment_label,
     can_mutate_shipment,
     ShipmentSerializer,
@@ -32,6 +33,8 @@ from karrio.server.manager.serializers import (
     ShipmentUpdateData,
     ShipmentPurchaseData,
     ShipmentCancelSerializer,
+    ShippingDocument,
+    PurchasedShipment,
 )
 
 ENDPOINT_ID = "$$$$$"  # This endpoint id is used to make operation ids unique make sure not to duplicate
@@ -90,7 +93,9 @@ class ShipmentList(GenericAPIView):
             ShipmentSerializer.map(data=request.data, context=request).save().instance
         )
 
-        return Response(Shipment(shipment).data, status=status.HTTP_201_CREATED)
+        return Response(
+            PurchasedShipment(shipment).data, status=status.HTTP_201_CREATED
+        )
 
 
 class ShipmentDetails(APIView):
@@ -165,6 +170,7 @@ class ShipmentCancel(APIView):
         request=None,
         responses={
             200: Shipment(),
+            304: Shipment(),
             404: ErrorResponse(),
             400: ErrorResponse(),
             409: ErrorResponse(),
@@ -177,6 +183,11 @@ class ShipmentCancel(APIView):
         Void a shipment with the associated label.
         """
         shipment = models.Shipment.access_by(request).get(pk=pk)
+
+        # Return 202 if already cancelled (idempotent)
+        if shipment.status == ShipmentStatus.cancelled.value:
+            return Response(Shipment(shipment).data, status=status.HTTP_202_ACCEPTED)
+
         can_mutate_shipment(shipment, delete=True)
 
         update = ShipmentCancelSerializer.map(shipment, context=request).save().instance
@@ -253,7 +264,7 @@ class ShipmentPurchase(APIView):
             data=process_dictionaries_mutations(["metadata"], payload, shipment),
         )
 
-        return Response(Shipment(update).data)
+        return Response(PurchasedShipment(update).data)
 
 
 class ShipmentDocs(VirtualDownloadView):
@@ -275,7 +286,16 @@ class ShipmentDocs(VirtualDownloadView):
 
         query_params = request.GET.dict()
 
-        self.shipment = models.Shipment.objects.get(pk=pk, label__isnull=False)
+        self.shipment = models.Shipment.objects.filter(
+            pk=pk, label__isnull=False
+        ).first()
+
+        if self.shipment is None:
+            return Response(
+                {"errors": [{"message": f"Shipment '{pk}' not found or has no label"}]},
+                status=status.HTTP_404_NOT_FOUND,
+            )
+
         self.document = getattr(self.shipment, doc, None)
         self.name = f"{doc}_{self.shipment.tracking_number}.{format}"
 
@@ -314,6 +334,64 @@ class ShipmentDocs(VirtualDownloadView):
         return ContentFile(buffer.getvalue(), name=self.name)
 
 
+class ShipmentDocumentDownload(APIView):
+    throttle_scope = "carrier_request"
+
+    @openapi.extend_schema(
+        tags=["Shipments"],
+        operation_id=f"{ENDPOINT_ID}document",
+        extensions={"x-operationId": "retrieveShipmentDocument"},
+        summary="Retrieve a shipment document",
+        request=None,
+        responses={
+            200: ShippingDocument(),
+            404: ErrorResponse(),
+            500: ErrorResponse(),
+        },
+    )
+    def post(self, request: Request, pk: str, doc: str = "label"):
+        """
+        Retrieve a shipment document (label or invoice) as base64 encoded content.
+        """
+        if doc not in ["label", "invoice"]:
+            return Response(
+                {"errors": [{"message": f"Invalid document type: {doc}"}]},
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+
+        # Build filter based on document type
+        filter_kwargs = {"pk": pk, f"{doc}__isnull": False}
+        shipment = models.Shipment.access_by(request).filter(**filter_kwargs).first()
+
+        if shipment is None:
+            return Response(
+                {"errors": [{"message": f"Shipment '{pk}' not found or has no {doc}"}]},
+                status=status.HTTP_404_NOT_FOUND,
+            )
+
+        document = getattr(shipment, doc)
+
+        # Determine format based on label_type for label, always PDF for invoice
+        if doc == "label":
+            doc_format = shipment.label_type or "PDF"
+        else:
+            doc_format = "PDF"
+
+        # Build the GET URL for the document
+        doc_url = f"/v1/shipments/{pk}/{doc}.{doc_format.lower()}"
+
+        return Response(
+            ShippingDocument(
+                {
+                    "category": doc,
+                    "format": doc_format,
+                    "base64": document,
+                    "url": doc_url,
+                }
+            ).data
+        )
+
+
 router.urls.append(path("shipments", ShipmentList.as_view(), name="shipment-list"))
 router.urls.append(
     path("shipments/<str:pk>", ShipmentDetails.as_view(), name="shipment-details")
@@ -331,9 +409,16 @@ router.urls.append(
         name="shipment-purchase",
     )
 )
+router.urls.append(
+    path(
+        "shipments/<str:pk>/documents/<str:doc>",
+        ShipmentDocumentDownload.as_view(),
+        name="shipment-document-download",
+    )
+)
 router.urls.append(
     re_path(
-        r"^shipments/(?P<pk>\w+)/(?P<doc>[a-z0-9]+).(?P<format>[a-z0-9]+)",
+        r"^shipments/(?P<pk>\w+)/(?P<doc>[a-z0-9]+)\.(?P<format>[a-z0-9]+)",
         ShipmentDocs.as_view(),
         name="shipment-docs",
     )

{karrio_server_manager-2025.5.2.dist-info → karrio_server_manager-2025.5.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: karrio_server_manager
-Version: 2025.5.2
+Version: 2025.5.4
 Summary: Multi-carrier shipping API Shipments manager module
 Author-email: karrio <hello@karrio.io>
 License-Expression: LGPL-3.0

{karrio_server_manager-2025.5.2.dist-info → karrio_server_manager-2025.5.4.dist-info}/RECORD

@@ -72,8 +72,9 @@ karrio/server/manager/migrations/0063_alter_commodity_value_currency.py,sha256=8
 karrio/server/manager/migrations/0064_shipment_shipment_created_at_idx_and_more.py,sha256=EzCPxG54nk3PkT7hlS-W3oJxie6OlfMZu6Jh6tCJthQ,728
 karrio/server/manager/migrations/0065_alter_address_city_alter_address_company_name_and_more.py,sha256=m0KQSz8cnJzaXUlaAKdqU0duZ8wSQeTYQCIeam3Wivw,6279
 karrio/server/manager/migrations/0066_commodity_image_url_commodity_product_id_and_more.py,sha256=Jw7bEBmqzDSp6zw0xcAiKc9aDCsa3Wrw-oTM8r9Pqfc,997
+karrio/server/manager/migrations/0067_rename_customs_commodities_table.py,sha256=WPACK9Ab5QUdcX9yxBkV6_MXTAkB9F8vETDOlVqOrT4,1933
 karrio/server/manager/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-karrio/server/manager/serializers/__init__.py,sha256=YVwGfjpb-_PezzGc8N8oLTkORan0hZ2muGj2PYG3n0g,1431
+karrio/server/manager/serializers/__init__.py,sha256=FyL9pqzoV7umSJut5P2KzqPFxn1ZWu07Qx7I58H2AQc,1454
 karrio/server/manager/serializers/address.py,sha256=yGKvZiNukeI15LEDdbo1ycqqK8QW77ak_vyLMIKyglI,2779
 karrio/server/manager/serializers/commodity.py,sha256=PKrW-xAYkiNByk5RF8up_Bt1Z8mJV_BGW0mPWT9w4ME,1658
 karrio/server/manager/serializers/customs.py,sha256=gMGC4TJMykjgELBLFHL6v7kPQ5YQKe7cQcMnOGBLL84,2872
@@ -82,26 +83,27 @@ 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=N4mld4eIM1HQ6NdsQ7gDt73aDv4j0wHM4AAMfgChnMc,34919
+karrio/server/manager/serializers/shipment.py,sha256=ByVrnexMI_fgSGBWO95qOPQn65Xzcfb8Vna9nF3k7Bk,37004
 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_errors.py,sha256=x2-mSsXknHkE4V7TajEu8d3rpqV38T_xyAaYJU7xcGQ,3616
+karrio/server/manager/tests/test_manifests.py,sha256=X35ZTXTFEM4Gxdjz598yiNNkOOKZGpILjHWRC0oM5U4,2764
 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=LBblskbeJyUvWtJdy5hZPvumuOT2PE__ikIK3YlvcnY,35914
-karrio/server/manager/tests/test_trackers.py,sha256=KvmWkplokNDZ0dzB16mFl0WcMJ0OYp_ErZeWJPGW_NA,7151
+karrio/server/manager/tests/test_shipments.py,sha256=I9DIx4l7zrHZ_vEvAKgdrnIx_euZtreSj9W40fouqSU,39725
+karrio/server/manager/tests/test_trackers.py,sha256=VIGT8OVH51mf_6F2HEr5C-kYvsMnhUods_rpq543RbI,7207
 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=_Dd83YxVJOgWhAhD745Kr4tcLWnKaU1dxnT5xB8opvk,5227
+karrio/server/manager/views/manifests.py,sha256=bk-8XoGLVqgjDfpTZbTKjXW7r8DYNDp2ce2xGG73sbI,7012
 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=TqLpBH5Jf-rI3enJwvNptRwGzfo7co9R1VSP_oqhB3o,10419
+karrio/server/manager/views/shipments.py,sha256=YOFcZy-ymn3YfIKtcfNjFO4R_tPocrmEqMkQUXSSDCM,13083
 karrio/server/manager/views/trackers.py,sha256=3oGn2qDpHgk8GZvuz-Cb93Fc0j_h_HbXQR692Zhfiok,12363
-karrio_server_manager-2025.5.2.dist-info/METADATA,sha256=WZxA5Br3FwwK7PO0Au-FKvQPHFPUcXevyuoaK596rWQ,730
-karrio_server_manager-2025.5.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-karrio_server_manager-2025.5.2.dist-info/top_level.txt,sha256=D1D7x8R3cTfjF_15mfiO7wCQ5QMtuM4x8GaPr7z5i78,12
-karrio_server_manager-2025.5.2.dist-info/RECORD,,
+karrio_server_manager-2025.5.4.dist-info/METADATA,sha256=sITh9mqaLlAGP7QXz6JttpFr4SBLLW1k02wHiIw-Q5k,730
+karrio_server_manager-2025.5.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+karrio_server_manager-2025.5.4.dist-info/top_level.txt,sha256=D1D7x8R3cTfjF_15mfiO7wCQ5QMtuM4x8GaPr7z5i78,12
+karrio_server_manager-2025.5.4.dist-info/RECORD,,