Merge pull request #918 from karrioapi/patch-2025.5.4

[patch] 2025.5.4

Author: danh91

CHANGELOG.md

@@ -4,6 +4,31 @@
 
 ### Feat
 
+- feat(WIP): introduce karrio studio to enhance dev experience and assist integration and development
+- feat: introduce shipping_documents field on shipment object that returns a more structured list of shipping documents details and include base64 documents version from purchasing APIs
+- feat: add audit log Model settings required by django-auditlog==3.4.0
+- feat: introduce `reason` field to karrio unified tracking event data
+
+### Fix
+
+- fix: idempotent API response for shipment cancellation when called twice on a shipment that was successfully cancelled return HTTP code 304
+
+### Docs
+
+- docs: karrio Shipping integration quick start with key APIs
+
+### Chore
+
+- chore: remove poorly implemented permissions layer
+
+---
+
+# Karrio 2025.5.3
+
+## Changes
+
+### Feat
+
 - feat: make shipment cancellation idempotent
 - feat: Implement POST requests for shipping documents downloads
 - feat: map error/message levels in carrier integrations and karrio server

apps/api/karrio/server/VERSION

@@ -1 +1 @@
-2025.5.3
+2025.5.4

apps/web/public/carrier-integrations.json

@@ -35,6 +35,10 @@ export default {
     title: 'API Development',
     type: 'page'
   },
+  "shipping-integration": {
+    title: 'Shipping Integration',
+    type: 'page'
+  },
   "dashboard-guide": {
     title: 'Dashboard Guide',
     type: 'page'

apps/web/src/app/docs/developing/_meta.ts

@@ -305,11 +305,25 @@ curl -X POST $KARRIO_API_URL/v1/shipments \
   "carrier_name": "generic",
   "service": "standard_service",
   "tracking_number": "TEST123456789",
-  "label_url": "/v1/shipments/ship_xxxxx/label",
+  "label_url": "/v1/shipments/ship_xxxxx/label.pdf",
+  "invoice_url": null,
+  "shipping_documents": [
+    {
+      "category": "label",
+      "format": "PDF",
+      "url": "/v1/shipments/ship_xxxxx/label.pdf",
+      "base64": "JVBERi0xLjQKJeLjz9..."
+    }
+  ],
   ...
 }
 ```
 
+> [!TIP]
+> **Immediate Label Access**
+>
+> When creating a shipment with a service (single-call purchase) or purchasing a label, the `shipping_documents` array includes the `base64` encoded document content. This allows you to immediately render or print the label without making a second API call. For subsequent retrievals (list, get operations), `base64` will be `null` and you should use the `url` field to download the document.
+
 **Save the shipment details:**
 
 ```bash filename="Terminal"