Packing slip PDFs in PHP

Why packing slips become PDFs

A packing slip is printed and physically placed in a box. It exists to be paper. That is the difference between a document and a view of a database, and it is why warehouse and fulfilment teams keep asking for this.

What a packing slip has to carry

Before any of the code below matters, the template has to produce a document that is actually a packing slip. These are the fields that make it one, and the ones a reader or an auditor will look for first.

• the order reference, which the picker checks against the pick list
• each line with SKU, description and quantity shipped
• backordered lines shown explicitly rather than omitted
• the ship-to address as it will appear on the carton
• the carrier reference or tracking number where it exists

The PHP implementation

cURL ships with the runtime, so this adds no dependency. The render happens in a controller action that echoes the body with a PDF Content-Type, and you write the body with readfile and the right Content-Type header.

<?php
function packing_slipPdf(string $id): void {
    $html = renderPackingSlip($id);

    $ch = curl_init('https://api.pdfpipe.xyz/v1/pdf');
    curl_setopt_array($ch, [
        CURLOPT_POST           => true,
        CURLOPT_RETURNTRANSFER => true,  // without this the body goes to stdout
        CURLOPT_HTTPHEADER     => [
            'Authorization: Bearer ' . getenv('PDFPIPE_KEY'),
            'Content-Type: application/json',
        ],
        CURLOPT_POSTFIELDS => json_encode([
            'html'    => $html,
            'options' => ['format' => 'A4', 'printBackground' => true],
        ]),
    ]);

    $pdf = curl_exec($ch);
    if ($pdf === false) {
        throw new RuntimeException('render failed: ' . curl_error($ch));
    }
    curl_close($ch);

    header('Content-Type: application/pdf');
    header('Content-Disposition: inline; filename="' . $id . '.pdf"');
    echo $pdf;
}

The CSS that makes a packing slip page correctly

The layout problem specific to this document is that it must print correctly on the label and A5 stock warehouses actually use, not just on A4. These rules handle it.

/* Warehouses print on A5 and label stock, not A4. */
@page {
  size: A5;
  margin: 8mm;
}

.signature {
  break-inside: avoid;
  margin-top: auto;
}

What goes wrong in PHP

allow_url_fopen is off on plenty of shared hosts, so file_get_contents silently fails while cURL keeps working. Set CURLOPT_RETURNTRANSFER or the body goes to stdout and corrupts the response.

What people try first

Most PHP projects reach for dompdf, which is pure PHP and therefore installs cleanly, but implements its own layout engine and does not support modern CSS. That works until it is running on more than one machine, at which point the browser becomes the thing you operate rather than the thing you use.

Where the packing slip lives afterwards

Rendering is the short part. The packing slip is thrown away when the box is opened. It has essentially no retention requirement, which is unusual on this list and worth knowing: the document does not need to be stored, only printed correctly the first time.

Getting the document right

• Check the order reference and quantities, which a picker checks against the physical goods.
• Generation is triggered by an order moving to fulfilment, so size the timeout for that path rather than for a health check.
• Volume arrives in bursts, so queue the render rather than doing it inside the request that triggered it.
• Backgrounds are painted by default here, so a design that uses colour needs nothing set. Only an explicit print_background of false turns them off.

Frequently asked

Related

Other PHP documents, and the same packing slip in other stacks.