Skip to main content

Post Delivery Adapter

The Post adapter provides standard postal/courier delivery functionality.

Included in Base Preset

This plugin is part of the base preset and loaded automatically. Using the base preset is strongly recommended, so explicit installation is usually not required.

Installation​

import '@unchainedshop/plugins/delivery/post';

Configuration​

Create a delivery provider using this adapter:

mutation CreatePostDelivery {
  createDeliveryProvider(deliveryProvider: {
    type: SHIPPING
    adapterKey: "shop.unchained.delivery.post"
  }) {
    _id
  }
}

Features​

  • Standard shipping delivery type
  • Configurable estimated delivery time
  • Auto-release support
  • No external API dependencies

Adapter Details​

PropertyValue
Keyshop.unchained.delivery.post
TypeSHIPPING
Auto-releaseConfigurable
Sourcedelivery/post.ts

Behavior​

isActive()​

Always returns true - no configuration required.

isAutoReleaseAllowed()​

Returns true by default, allowing orders to proceed automatically after payment.

send()​

Returns success without external API calls. For production integrations with actual carriers, create a custom adapter.

estimatedDeliveryThroughput()​

Returns a default delivery estimate. Override in configuration or extend the adapter for custom calculations.

Extending for Real Carriers​

For production use, extend or replace this adapter with carrier-specific integrations:

import { DeliveryDirector } from '@unchainedshop/core';

const SwissPostAdapter = {
  key: 'ch.post.delivery',
  label: 'Swiss Post',
  version: '1.0.0',

  typeSupported: (type) => type === 'SHIPPING',

  actions(config, context) {
    return {
      configurationError() { return null; },
      isActive() { return true; },
      isAutoReleaseAllowed() { return true; },

      async send() {
        const { order } = context;

        // Call Swiss Post API
        const response = await swissPostApi.createShipment({
          recipient: order.delivery.address,
          weight: calculateWeight(order.items),
        });

        return {
          trackingNumber: response.trackingNumber,
          trackingUrl: `https://www.post.ch/track?id=${response.trackingNumber}`,
        };
      },

      estimatedDeliveryThroughput(warehousingTime) {
        // Swiss Post typically delivers in 1-2 days
        return warehousingTime + (2 * 24 * 60 * 60 * 1000);
      },

      async pickUpLocations() { return []; },
      async pickUpLocationById() { return null; },
    };
  },
};

DeliveryDirector.registerAdapter(SwissPostAdapter);

Delivery Pricing​

Combine with delivery pricing adapters:

import '@unchainedshop/plugins/pricing/order-delivery';
import '@unchainedshop/plugins/pricing/free-delivery';

Set prices via configuration or custom pricing adapter.