Carrier SDK Overview

Recommended: New projects should use ZymeupClient unified SDK with multi-role support.

Carrier SDK (ZymeupCarrierSDK) serves logistics providers and carriers with headless electronic proof of delivery, address book, tracking, document upload, customs compliance, and shipment management.

Quick Links

• EPOD — Delivery / failure reporting, evidence capture
• Address — Carrier address book CRUD
• Tracking — Shipment tracking queries
• Document — Label / invoice / packing slip upload
• Compliance — Customs declaration, compliance checks
• Shipment — Shipment management, labels, tracking
• Activation — Carrier onboarding and configuration
• Age Verification — Age verification event records

ZymeupClient Unified SDK

ZymeupClient merges Merchant and Carrier SDKs into a single entry point. Enable carrier mode with role: 'carrier':

import { ZymeupClient } from '@zymeup/sdk'

const sdk = new ZymeupClient({
  apiKey: 'carrier-api-key',
  baseUrl: 'https://api.zymeup.com',
  role: 'carrier',
  carrierCode: 'DHL'
})

// Carrier modules
const epod = await sdk.carrierEpod.list({ status: 'pending' })
const tracking = await sdk.tracking.list({ status: 'in_transit' })
const customs = await sdk.compliance.createCustoms({ shipment_id: 'ship-123', declarations: [] })