README

A framework-agnostic PHP package for serialising, validating, and transporting orders between Atlas Core and host applications (ePOS, E-commerce, etc.) according to the Order Bridge API Specification v1.4.2.

Core Concepts

The package owns two things exclusively:

Serialisation: Converting host application data into spec-compliant JSON payloads.
Validation: Enforcing all schema and arithmetic rules defined in the specification.

It is designed to be unopinionated about persistence. It does not include Eloquent models, migrations, or database logic. Instead, it defines a set of Interfaces that your application's models must implement.

Key Components

OrderSerialiser: Takes objects implementing OrderInterface and produces a fully validated payload array. It handles all complex arithmetic (VAT, line totals, grand totals) using bcmath internally.
PayloadValidator: Implements all rules from §5 of the spec, including arithmetic verification and idempotency checks.
HttpTransport: A thin PSR-18 compatible layer for sending payloads to Atlas Core.
InboundParser: The reverse direction—parses and validates JSON from Atlas Core into typed DTOs.
TransferIdManager: Utility for generating and managing transfer_id GUIDs to ensure idempotency.

Installation

composer require atlasflow/order-bridge

Note: Requires PHP 8.4+ and the bcmath extension.

Usage Instructions

1. Implement the Interfaces

The package never touches your models directly. You must create "Adapters" that wrap your models and implement the interfaces in Atlasflow\OrderBridge\Contracts.

use Atlasflow\OrderBridge\Contracts\OrderInterface;
use Atlasflow\OrderBridge\Contracts\LineItemInterface;
// ... and other contracts

class MyOrderAdapter implements OrderInterface
{
    public function __construct(private MyOrderModel $order) {}

    public function getOriginRef(): string { return $this->order->reference; }
    public function getStatus(): string { return 'pos'; }
    // ... implement remaining methods
}

2. Serialise and Send

The OrderSerialiser computes all totals for you. You only provide raw values (quantities, unit prices, discount percentages, and VAT rates).

use Atlasflow\OrderBridge\Serialiser\OrderSerialiser;
use Atlasflow\OrderBridge\Transport\HttpTransport;

// 1. Setup Serialiser
$serialiser = new OrderSerialiser([
    'site_id' => 'site_richmond',
    'site_name' => 'The Palm Centre',
    'source_type' => 'cassa',
]);

// 2. Serialise your order(s)
// $orders should be an iterable of OrderInterface
$payload = $serialiser->serialise($orders, trigger: 'realtime');

// 3. Send via HTTP (requires a PSR-18 client and PSR-17 factories)
$transport = new HttpTransport($httpClient, $requestFactory, $streamFactory, $endpointUrl);
$result = $transport->send($payload);

if ($result->isSuccess()) {
    // Mark order as synced in your DB
}

3. Validate a Payload

You can use the validator independently to dry-run a batch or validate inbound webhooks.

use Atlasflow\OrderBridge\Validator\PayloadValidator;

$validator = new PayloadValidator();
$result = $validator->validate($payloadArray);

if (!$result->isValid()) {
    foreach ($result->getViolations() as $violation) {
        echo "Error in {$violation->field}: {$violation->message}\n";
    }
}

4. Parse Inbound Payloads

When receiving an export from Atlas Core, use the InboundParser to get typed DTOs.

use Atlasflow\OrderBridge\Parser\InboundParser;

$parser = new InboundParser();
try {
    $envelope = $parser->parse($jsonString);
    
    foreach ($envelope->orders as $orderDto) {
        // Map DTO back to your application models
        echo $orderDto->originRef;
    }
} catch (ParseException $e) {
    // Handle malformed JSON or validation failure
}

Idempotency

The package automatically generates a transfer_id (UUID v4) during serialisation. Atlas Core uses this ID combined with your site_id to prevent duplicate order processing.

If you need to retry a failed transport attempt:

Identical Retries: Reuse the same payload (and thus the same transfer_id). Core will acknowledge the retry without creating duplicate records.
Modified Payloads: If the content changes, you must generate a new transfer_id by re-serialising the order.

Laravel Integration

The package ships with a first-class Laravel service provider that handles configuration publishing and wires everything up automatically.

Auto-discovery

Laravel 5.5+ will auto-discover the service provider. No manual registration is needed.

Publish the configuration file

php artisan vendor:publish --tag=order-bridge-config

This copies config/order-bridge.php into your application's config/ directory.

Configuration reference

Key	Default	Description
`tolerance`	`'0.0001'`	Arithmetic tolerance for §5.3 validation checks.
`monetary_scale`	`4`	Decimal places for all monetary output fields.
`discount_scale`	`6`	Decimal places for discount percentage strings.
`vat_rounding_scale`	`2`	Decimal places to which VAT amounts are rounded before output. Set to `4` to disable the extra rounding step.
`vat_rounding_mode`	`'ceil'`	Rounding direction for VAT amounts. `'ceil'` rounds toward positive infinity (always up for positive values); `'floor'` rounds toward negative infinity.

Manual registration (without auto-discovery)

Add the provider to config/app.php:

'providers' => [
    Atlasflow\OrderBridge\Laravel\OrderBridgeServiceProvider::class,
],

Framework-agnostic usage

Outside of Laravel the package works out of the box with sensible defaults. If you need to override the defaults at runtime, call SchemaVersion::configure() early in your bootstrap:

use Atlasflow\OrderBridge\SchemaVersion;

SchemaVersion::configure([
    'vat_rounding_mode' => 'floor',
    'vat_rounding_scale' => 2,
]);

License

The MIT License (MIT). Please see License File for more information.

atlasflow / order-bridge

Maintainers

Package info

Statistics

Security