karrio-eshipper 2025.5.6__py3-none-any.whl → 2026.1__py3-none-any.whl

karrio/mappers/eshipper/proxy.py

@@ -1,14 +1,74 @@
 """Karrio eShipper client proxy."""
 
+import datetime
 import karrio.lib as lib
 import karrio.api.proxy as proxy
+import karrio.core.errors as errors
+import karrio.core.models as models
+import karrio.providers.eshipper.error as provider_error
 import karrio.mappers.eshipper.settings as provider_settings
 
 
 class Proxy(proxy.Proxy):
     settings: provider_settings.Settings
 
+    def authenticate(self, _=None) -> lib.Deserializable[str]:
+        """Retrieve the token using the principal|credential pair
+        or collect it from the cache if an unexpired token exist.
+        """
+        cache_key = f"{self.settings.carrier_name}|{self.settings.principal}|{self.settings.credential}"
+
+        def get_token():
+            result = lib.request(
+                url=f"{self.settings.server_url}/api/v2/authenticate",
+                trace=self.settings.trace_as("json"),
+                method="POST",
+                headers={"content-Type": "application/json"},
+                data=lib.to_json(
+                    {
+                        "principal": self.settings.principal,
+                        "credential": self.settings.credential,
+                    }
+                ),
+                max_retries=2,
+            )
+
+            response = lib.to_dict(result)
+            messages = provider_error.parse_error_response(response, self.settings)
+
+            if any(messages):
+                raise errors.ParsedMessagesError(messages=messages)
+
+            # Validate that token is present in the response
+            if "token" not in response:
+                raise errors.ParsedMessagesError(
+                    messages=[
+                        models.Message(
+                            carrier_name=self.settings.carrier_name,
+                            carrier_id=self.settings.carrier_id,
+                            message="Authentication failed: No token received",
+                            code="AUTH_ERROR",
+                        )
+                    ]
+                )
+
+            expiry = datetime.datetime.now() + datetime.timedelta(
+                seconds=float(response.get("expires_in", 0))
+            )
+
+            return {**response, "expiry": lib.fdatetime(expiry)}
+
+        token = self.settings.connection_cache.thread_safe(
+            refresh_func=get_token,
+            cache_key=cache_key,
+            buffer_minutes=30,
+            token_field="token",
+        )
+
+        return lib.Deserializable(token.get_state())
+
     def get_rates(self, request: lib.Serializable) -> lib.Deserializable[str]:
+        access_token = self.authenticate().deserialize()
         response = lib.request(
             url=f"{self.settings.server_url}/api/v2/quote",
             data=lib.to_json(request.serialize()),
@@ -16,13 +76,14 @@ class Proxy(proxy.Proxy):
             method="POST",
             headers={
                 "content-Type": "application/json",
-                "Authorization": f"Bearer {self.settings.access_token}",
+                "Authorization": f"Bearer {access_token}",
             },
         )
 
         return lib.Deserializable(response, lib.to_dict)
 
     def create_shipment(self, request: lib.Serializable) -> lib.Deserializable[str]:
+        access_token = self.authenticate().deserialize()
         response = lib.request(
             url=f"{self.settings.server_url}/api/v2/ship",
             data=lib.to_json(request.serialize()),
@@ -30,13 +91,14 @@ class Proxy(proxy.Proxy):
             method="PUT",
             headers={
                 "content-Type": "application/json",
-                "Authorization": f"Bearer {self.settings.access_token}",
+                "Authorization": f"Bearer {access_token}",
             },
         )
 
         return lib.Deserializable(response, lib.to_dict)
 
     def cancel_shipment(self, request: lib.Serializable) -> lib.Deserializable[str]:
+        access_token = self.authenticate().deserialize()
         response = lib.request(
             url=f"{self.settings.server_url}/api/v2/ship/cancel",
             data=lib.to_json(request.serialize()),
@@ -44,13 +106,14 @@ class Proxy(proxy.Proxy):
             method="DELETE",
             headers={
                 "content-Type": "application/json",
-                "Authorization": f"Bearer {self.settings.access_token}",
+                "Authorization": f"Bearer {access_token}",
             },
         )
 
         return lib.Deserializable(response, lib.to_dict)
 
     def get_tracking(self, request: lib.Serializable) -> lib.Deserializable[str]:
+        access_token = self.authenticate().deserialize()
         query = lib.to_query_string(request.serialize())
         response = lib.request(
             url=f"{self.settings.server_url}/api/v2/track/events?{query}",
@@ -58,7 +121,7 @@ class Proxy(proxy.Proxy):
             method="GET",
             headers={
                 "content-Type": "application/json",
-                "Authorization": f"Bearer {self.settings.access_token}",
+                "Authorization": f"Bearer {access_token}",
             },
         )
 

karrio/providers/eshipper/rate.py

@@ -30,18 +30,21 @@ def _extract_details(
         rate.serviceName,
         service_id=rate.serviceId,
         test_mode=settings.test_mode,
+        carrier_name=rate.carrierName,
     )
     carrier_id = provider_units.ShippingService.carrier_id(
         rate.carrierName,
         test_mode=settings.test_mode,
         service_search=service.name_or_key,
         service_id=rate.serviceId,
+        carrier_name=rate.carrierName,
     )
     rate_provider = provider_units.RateProvider.find(
         rate.carrierName,
         test_mode=settings.test_mode,
         service_search=service.name_or_key,
         service_id=rate.serviceId,
+        carrier_name=rate.carrierName,
     )
 
     charges = [

karrio/providers/eshipper/shipment/create.py

@@ -34,10 +34,12 @@ def _extract_details(
     service = provider_units.ShippingService.find(
         shipment.carrier.serviceName,
         test_mode=settings.test_mode,
+        carrier_name=shipment.carrier.carrierName,
     )
     rate_provider = provider_units.RateProvider.find(
         shipment.carrier.carrierName,
         test_mode=settings.test_mode,
+        carrier_name=shipment.carrier.carrierName,
     )
 
     return models.ShipmentDetails(
@@ -89,11 +91,24 @@ def shipment_request(
         initializer=provider_units.shipping_options_initializer,
     )
     service = provider_units.ShippingService.map(payload.service)
+
+    # Extract carrier from service code if available
+    carrier_name_from_service = None
+    if "_" in service.name_or_key:
+        parts = service.name_or_key.split("_")
+        # Carrier is always at index 1 after "eshipper" prefix
+        if len(parts) >= 2 and parts[0] == "eshipper":
+            potential_carrier = parts[1]  # e.g., "canadapost" from "eshipper_canadapost_expedited"
+            # Validate it's a known carrier
+            if provider_units.RateProvider.map(potential_carrier).name:
+                carrier_name_from_service = potential_carrier
+
     service_id = lib.identity(
         options.eshipper_service_id.state
         or provider_units.ShippingService.service_id(
             service.name_or_key,
             test_mode=settings.test_mode,
+            carrier_name=carrier_name_from_service,
         )
     )
     carrier_id = lib.identity(
@@ -103,6 +118,7 @@ def shipment_request(
             service_id=service_id,
             test_mode=settings.test_mode,
             service_search=service.name_or_key,
+            carrier_name=carrier_name_from_service,
         )
     )
 

karrio/providers/eshipper/tracking.py

@@ -51,6 +51,23 @@ def _extract_details(
                 description=event.description,
                 date=lib.fdate(event.originalEvent.eventDate, "%Y-%m-%d %H:%M:%S"),
                 time=lib.flocaltime(event.originalEvent.eventDate, "%Y-%m-%d %H:%M:%S"),
+                timestamp=lib.fiso_timestamp(event.originalEvent.eventDate, current_format="%Y-%m-%d %H:%M:%S"),
+                status=next(
+                    (
+                        s.name
+                        for s in list(provider_units.TrackingStatus)
+                        if event.originalEvent.name in s.value
+                    ),
+                    None,
+                ),
+                reason=next(
+                    (
+                        r.name
+                        for r in list(provider_units.TrackingIncidentReason)
+                        if event.originalEvent.name in r.value
+                    ),
+                    None,
+                ),
             )
             for event in details.event
         ],

karrio/providers/eshipper/units.py

@@ -102,6 +102,14 @@ class TrackingStatus(lib.Enum):
     ready_for_pickup = ["ready_for_pickup"]
 
 
+class TrackingIncidentReason(lib.Enum):
+    """Maps eShipper exception codes to normalized TrackingIncidentReason."""
+    carrier_damaged_parcel = []
+    consignee_refused = []
+    consignee_not_home = []
+    unknown = []
+
+
 def to_carrier_code(carrierDTO: typing.Dict[str, str]) -> str:
     _code = lib.to_snake_case((carrierDTO or {}).get("name") or "eshipper")
 
@@ -132,7 +140,12 @@ def to_service_code(service: typing.Dict[str, str]) -> str:
     return output
 
 
-def get_service(search: str, test_mode: bool = False, service_id: str = None):
+def get_service(
+    search: str,
+    test_mode: bool = False,
+    service_id: str = None,
+    carrier_name: str = None,
+):
     prod_metadata = METADATA_JSON["PROD_SERVICES"]
     test_metadata = METADATA_JSON["DEV_SERVICES"]
     metadata = lib.identity(
@@ -144,27 +157,53 @@ def get_service(search: str, test_mode: bool = False, service_id: str = None):
             service
             for service in metadata
             if to_service_code(service) == search
-            or service.get("name") == search
             or str(service.get("id")) == search
             or (service_id and service_id == str(service.get("id")))
+            or (
+                service.get("name") == search
+                and (
+                    not carrier_name
+                    or service.get("carrierDTO", {}).get("name") == carrier_name
+                )
+            )
         ),
         {},
     )
 
 
-def get_service_id(search: str, test_mode: bool = False, service_id: str = None):
+def get_service_id(
+    search: str,
+    test_mode: bool = False,
+    service_id: str = None,
+    carrier_name: str = None,
+):
     return (
-        get_service(search, test_mode=test_mode, service_id=service_id).get("id")
+        get_service(
+            search,
+            test_mode=test_mode,
+            service_id=service_id,
+            carrier_name=carrier_name,
+        ).get("id")
         or service_id
     )
 
 
-def find_service(search: str, test_mode: bool = False, service_id: str = None):
+def find_service(
+    search: str,
+    test_mode: bool = False,
+    service_id: str = None,
+    carrier_name: str = None,
+):
 
     if ShippingService.map(search).name:
         return ShippingService.map(search)
 
-    service = get_service(search, test_mode=test_mode, service_id=service_id)
+    service = get_service(
+        search,
+        test_mode=test_mode,
+        service_id=service_id,
+        carrier_name=carrier_name,
+    )
 
     if service:
         return ShippingService.map(to_service_code(service))
@@ -177,10 +216,16 @@ def get_carrier(
     test_mode: bool = False,
     service_search: str = None,
     service_id: str = None,
+    carrier_name: str = None,
 ):
     id_key = "test_id" if test_mode else "prod_id"
     alternate_key = "prod_id" if not test_mode else "test_id"
-    service = get_service(service_search, test_mode=test_mode, service_id=service_id)
+    service = get_service(
+        service_search,
+        test_mode=test_mode,
+        service_id=service_id,
+        carrier_name=carrier_name or search,
+    )
 
     return service.get("carrierDTO") or next(
         (
@@ -204,12 +249,14 @@ def get_carrier_id(
     test_mode: bool = False,
     service_search: str = None,
     service_id: str = None,
+    carrier_name: str = None,
 ):
     return get_carrier(
         search,
         test_mode=test_mode,
         service_search=service_search,
         service_id=service_id,
+        carrier_name=carrier_name,
     ).get("id")
 
 
@@ -218,6 +265,7 @@ def find_rate_provider(
     test_mode: bool = False,
     service_search: str = None,
     service_id: str = None,
+    carrier_name: str = None,
 ):
 
     if RateProvider.map(lib.to_snake_case(search)).name:
@@ -228,6 +276,7 @@ def find_rate_provider(
         test_mode=test_mode,
         service_search=service_search,
         service_id=service_id,
+        carrier_name=carrier_name,
     )
 
     if carrier and RateProvider.map(to_carrier_code(carrier)).name:
@@ -273,7 +322,7 @@ ESHIPPER_CARRIER_METADATA = {
 }
 
 ESHIPPER_SERVICE_METADATA = {
-    lib.to_snake_case(service.get("esServicename") or service.get("name")): {
+    to_service_code(service): {
         **service,
         "ids": list(
             set(
@@ -281,8 +330,7 @@ ESHIPPER_SERVICE_METADATA = {
                     s["id"]
                     for s in METADATA_JSON["PROD_SERVICES"]
                     + METADATA_JSON["DEV_SERVICES"]
-                    if lib.to_snake_case(s["name"])
-                    == lib.to_snake_case(service["name"])
+                    if to_service_code(s) == to_service_code(service)
                 ]
             )
         ),
@@ -290,7 +338,7 @@ ESHIPPER_SERVICE_METADATA = {
             (
                 s["id"]
                 for s in METADATA_JSON["PROD_SERVICES"]
-                if s["name"] == service["name"]
+                if to_service_code(s) == to_service_code(service)
             ),
             None,
         ),
@@ -298,15 +346,15 @@ ESHIPPER_SERVICE_METADATA = {
             (
                 s["id"]
                 for s in METADATA_JSON["DEV_SERVICES"]
-                if s["name"] == service["name"]
+                if to_service_code(s) == to_service_code(service)
             ),
             None,
         ),
         "carrier": lib.to_snake_case(service["carrierDTO"]["name"]),
     }
     for service in {
-        s["name"]: s
-        for s in METADATA_JSON["PROD_SERVICES"] + METADATA_JSON["DEV_SERVICES"]
+        to_service_code(s): s
+        for s in METADATA_JSON["DEV_SERVICES"] + METADATA_JSON["PROD_SERVICES"]
     }.values()
 }
 
@@ -314,7 +362,7 @@ ESHIPPER_SERVICE_METADATA = {
 ShippingService = lib.StrEnum(
     "ShippingService",
     {
-        to_service_code(service): service["name"]
+        to_service_code(service): to_service_code(service)
         for service in ESHIPPER_SERVICE_METADATA.values()
     },
 )

karrio/providers/eshipper/utils.py

@@ -1,8 +1,6 @@
-import datetime
-import karrio.lib as lib
+"""eShipper connection settings."""
+
 import karrio.core as core
-import karrio.core.errors as errors
-import karrio.core.models as models
 
 
 class Settings(core.Settings):
@@ -20,65 +18,3 @@ class Settings(core.Settings):
         return (
             "https://uu2.eshipper.com" if self.test_mode else "https://ww2.eshipper.com"
         )
-
-    @property
-    def access_token(self):
-        """Retrieve the "token" using the principal|credential pair
-        or collect it from the cache if an unexpired "token" exist.
-        """
-        cache_key = f"{self.carrier_name}|{self.principal}|{self.credential}"
-
-        return self.connection_cache.thread_safe(
-            refresh_func=lambda: login(self),
-            cache_key=cache_key,
-            buffer_minutes=30,
-            token_field="token",
-        ).get_state()
-
-
-def login(settings: Settings):
-    """Sign in response
-    {
-      "token": "string",
-      "expires_in": "string",
-      "token_type": "string",
-      "refresh_token": "string",
-      "refresh_expires_in": "string"
-    }
-    """
-    import karrio.providers.eshipper.error as error
-
-    result = lib.request(
-        url=f"{settings.server_url}/api/v2/authenticate",
-        data=lib.to_json(
-            {
-                "principal": settings.principal,
-                "credential": settings.credential,
-            }
-        ),
-        method="POST",
-        headers={"content-Type": "application/json"},
-    )
-    response = lib.to_dict(result)
-    messages = error.parse_error_response(response, settings)
-
-    if any(messages):
-        raise errors.ParsedMessagesError(messages=messages)
-
-    # Validate that token is present in the response
-    if "token" not in response:
-        raise errors.ParsedMessagesError(
-            messages=[
-                models.Message(
-                    carrier_name=settings.carrier_name,
-                    carrier_id=settings.carrier_id,
-                    message="Authentication failed: No token received",
-                    code="AUTH_ERROR",
-                )
-            ]
-        )
-
-    expiry = datetime.datetime.now() + datetime.timedelta(
-        seconds=float(response.get("expires_in", 0))
-    )
-    return {**response, "expiry": lib.fdatetime(expiry)}

{karrio_eshipper-2025.5.6.dist-info → karrio_eshipper-2026.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: karrio_eshipper
-Version: 2025.5.6
+Version: 2026.1
 Summary: Karrio - eShipper Shipping Extension
 Author-email: karrio <hello@karrio.io>
 License-Expression: LGPL-3.0

{karrio_eshipper-2025.5.6.dist-info → karrio_eshipper-2026.1.dist-info}/RECORD

@@ -1,18 +1,18 @@
 karrio/mappers/eshipper/__init__.py,sha256=klSnHWetpSpOBsj7OgncePwLbSK1etgRQN_PZSK2pUo,152
 karrio/mappers/eshipper/mapper.py,sha256=oFs6tqFI9vbm13sh8hHoZVxA2VrnqdaixOxeB9nnJeY,1969
-karrio/mappers/eshipper/proxy.py,sha256=ZLOXHxgGPSVkitCqHJRFeRWpqjcFY01xVEuL2yz4dd8,2350
+karrio/mappers/eshipper/proxy.py,sha256=2U683Jl_Prr1Rov8fbtuUyhJHWGA-cxkJPHLVMvYIk8,4770
 karrio/mappers/eshipper/settings.py,sha256=ZN7DTMBMTC_JtOgUFQ2UNCyU5j-VUfv2us_F90fL1jw,491
 karrio/plugins/eshipper/__init__.py,sha256=v5cNriCwL5R2QR5x6Iki23CcBGPmGmH8zEL5j02u9Ko,448
 karrio/providers/eshipper/__init__.py,sha256=Y9vKPYScbmFvM17L-x52m_yLLiG6WsX9j6o4NIERBMU,400
 karrio/providers/eshipper/error.py,sha256=uroZ2dW7OHEIrhi3HKnsd8EntmXaLpZisSDyJ2HLKOY,2038
 karrio/providers/eshipper/metadata.json,sha256=KBae69ntmCIkZ0dKrAX0vjkm1CyE9UwvIstt7mLrq4M,369526
-karrio/providers/eshipper/rate.py,sha256=r0OTKeXFXmaWdi7XcNDNQ0wL5R1idQAnNhMtXTRfpPM,7184
-karrio/providers/eshipper/tracking.py,sha256=46DVFj8iMLWSsi0f5irTzFpH0uArZtya4eyYh5LkdFQ,2452
-karrio/providers/eshipper/units.py,sha256=CTi0NbWEpVc-GwPEKrtGVR7VEEV9Ij0odaQTUacwgyc,9658
-karrio/providers/eshipper/utils.py,sha256=0Ok4BNFe4KoNNtCNjp6FLUfR8iwfuaMSh_jZRsPK4KE,2381
+karrio/providers/eshipper/rate.py,sha256=sShKjW25Av07gPE3dIHEe4X2-Vw6bwtbmpIQzlLZJsE,7301
+karrio/providers/eshipper/tracking.py,sha256=wIYItHY_aQ1Cnth6c9Wqdjfr4fn9fALTBiWSB-FhjLs,3137
+karrio/providers/eshipper/units.py,sha256=rY8zN9DewnwcyFGcI_zsxdtq40MyIc9vBGM-mRSIzac,10563
+karrio/providers/eshipper/utils.py,sha256=LOHTEHMgoLpYIPMuCRxcyGwVp3UsMC7DZ3h36YtXwvQ,403
 karrio/providers/eshipper/shipment/__init__.py,sha256=oPCX3bykNDVeczan1tbmSpuOtFYTtd6h8J9otYVDQqQ,233
 karrio/providers/eshipper/shipment/cancel.py,sha256=vdxMmK7AmI-xOn62NlaMzCCKQ8CBql8QBVPft0VQWn0,1317
-karrio/providers/eshipper/shipment/create.py,sha256=jL4RWdtYOmpofcGVYn-7l2rstMvXK-DKoIAe_TjCBkY,11632
+karrio/providers/eshipper/shipment/create.py,sha256=4Y_t011XNIaFXqEsuEahAp2kQviCVMYUgfI2ccn9BmM,12408
 karrio/schemas/eshipper/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 karrio/schemas/eshipper/cancel_request.py,sha256=mGMmVxCEwUhWyw-XkK4wsHZ4OQ34e6Dnc0JxBU1CixQ,334
 karrio/schemas/eshipper/cancel_response.py,sha256=yLJe8qk71gy6GVGZ07ylBIomYFLUChZx9GDyJ3XzEsA,346
@@ -26,8 +26,8 @@ karrio/schemas/eshipper/shipping_request.py,sha256=OrqSutwyzTj-iau3LDPJUEGBRzzV9
 karrio/schemas/eshipper/shipping_response.py,sha256=RdMXh9goyTrH2qdU_5KMDIAWAEDzMchy_e5f45k-zxs,3892
 karrio/schemas/eshipper/tracking_request.py,sha256=EAE7PJFp2rTYCXMQJ6Kg-hMs3vL-GSTFjhHvzSmMzPg,252
 karrio/schemas/eshipper/tracking_response.py,sha256=2m9doy3y5f6zdA-gbNfsw8rp0oqs3eYrgw8Por_1fjE,2219
-karrio_eshipper-2025.5.6.dist-info/METADATA,sha256=rIE9q93gzGfM1WEZ9bNdXN8nr0KA8WuzC45wSqwJjYM,997
-karrio_eshipper-2025.5.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-karrio_eshipper-2025.5.6.dist-info/entry_points.txt,sha256=u9RQVmPE2uC3-aL85DnlIHdsHAWYkOnwTAfJvi2--DY,61
-karrio_eshipper-2025.5.6.dist-info/top_level.txt,sha256=FZCY8Nwft8oEGHdl--xku8P3TrnOxu5dETEU_fWpRSM,20
-karrio_eshipper-2025.5.6.dist-info/RECORD,,
+karrio_eshipper-2026.1.dist-info/METADATA,sha256=gehsHjeLm7Fc7qE_7GZfYleIeaeMPydoIM8_eYeLllU,995
+karrio_eshipper-2026.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+karrio_eshipper-2026.1.dist-info/entry_points.txt,sha256=u9RQVmPE2uC3-aL85DnlIHdsHAWYkOnwTAfJvi2--DY,61
+karrio_eshipper-2026.1.dist-info/top_level.txt,sha256=FZCY8Nwft8oEGHdl--xku8P3TrnOxu5dETEU_fWpRSM,20
+karrio_eshipper-2026.1.dist-info/RECORD,,