silvershop-suite / shipping-labels

1.1.1 2026-10-19 18:06 UTC

Requires

• php: ^8.3
• dompdf/dompdf: ^3.0
• silvershop/core: ^6
• silverstripe/framework: ^6.0
• silverstripe/reports: ^6.0
• silverstripe/siteconfig: ^6.0

Requires (Dev)

• phpunit/phpunit: ^11.0
• silverstripe/sqlite3: ^4
• squizlabs/php_codesniffer: ^3.7

Suggests

• silvershop-suite/store-profile: Central shop identity + sender address, shared with invoicing and other modules.

BSD-3-Clause

• Remy Vaartjes
• SilverShop-Suite Contributors

• ecommerce
• silverstripe
• shipping
• label
• carrier
• silvershop
• fulfilment

Published on Packagist.org on 2026-10-19 19:27 UTC

README

Carrier-connected shipping label generation for SilverShop, with a pluggable provider layer so multiple shipping services can be connected.

SilverShop can calculate shipping cost (silvershop/shipping) but has no way to create the label you stick on the parcel. This module adds that: a ShippingLabel record per order (carrier, tracking, status, and the label PDF), a provider interface that carriers/aggregators implement, and CMS actions to create and print labels.

What it adds

• A ShippingLabelProvider interface + a config-driven ProviderRegistry, so providers plug in without code changes and are selectable per order.
• A Manual provider (built in): record a tracking number / upload a label PDF for a shipment created out-of-band.
• A ShippingLabel model (immutable; stores the PDF as a File) — Order has_many ShippingLabels.
• Settings → Shop → Shipping labels: the default provider + the shop's sender / return address.
• CMS actions to create and print a label (single label per order; bulk/batch printing is planned).

Carrier adapters ship as separate packages, e.g. silvershop-suite/shipping-myparcel (MyParcel → PostNL/DHL). Add more by implementing ShippingLabelProvider and registering it:

SilverShop\ShippingLabels\Provider\ProviderRegistry:
  providers:
    myparcel: 'SilverShop\ShippingMyParcel\MyParcelProvider'

Installation

composer require silvershop-suite/shipping-labels

Then run dev/build?flush=all. Provider API keys come from the environment (.env), never from config/SiteConfig.

Usage

// Create a label for an order with the default provider (or pass a provider name).
$label = $order->createShippingLabel();                     // default provider
$label = $order->createShippingLabel('manual', ['TrackingNumber' => '3STBJG...']);

$order->getTrackingNumber();      // '' or the primary label's tracking number
$order->ShippingLabels();         // all labels for the order

Licence

BSD-3-Clause.

Credits

Built and maintained by Remy Vaartjes ([e-mail]) — part of the SilverShop-Suite.