Skip to content

Deliveries

Protokol Deliveries integration manages shipment and delivery lifecycle for customer orders. It connects delivery providers and emits order status change events for workflow automation.

Note

This integration is currently geolocked to Serbia (RS).

Overview

Key characteristics:

  • Order tracking — monitor delivery status changes from dispatch to completion
  • Workflow events — receive order change reports for automated processing
  • Provider connectivity — connects to delivery service providers for shipment management

Workflow Integration

Order Events

Event When
integration.deliveries.order.report Order delivery status changed (dispatched, in-transit, delivered, failed, etc.)

Use this event to trigger workflows that update internal order status, notify customers, or escalate delivery issues.

Using in Platform Functions

const { Workflow } = $sdk.version('0.10')
const workflow = new Workflow()

// Publish a delivery status event for a specific order
await workflow.publish("integration.deliveries.order.report", {
  order_id: $input.body.order_id,
  status: $input.body.delivery_status,
  tracking_number: $input.body.tracking_number,
  updated_at: new Date().toISOString(),
})

response.json({ success: true })

SDK Reference

The Deliveries integration does not currently have a dedicated SDK class. Delivery events are consumed through the Workflow SDK:

import { Workflow } from "@ptkl/sdk/beta"

const workflow = new Workflow()
// Listen for delivery events in workflow triggers
// Event: integration.deliveries.order.report

Info

As delivery provider adapters are expanded, a dedicated SDK class with methods for shipment creation, tracking lookups, and provider management will be documented here.