README

A lightweight PHP SDK for integrating with the DeliveryMatch API.

Overview

The DeliveryMatch SDK provides a simple and efficient way to interact with the DeliveryMatch shipping and logistics platform. This SDK helps developers easily integrate shipping solutions, rate calculations, label generation, tracking, and other DeliveryMatch services into your PHP applications

Requirements

• PHP >= 8.1
• A PSR-17 implementation
• A PSR-18 implementation

Installation

Install the package using Composer:

composer require deliverymatch/sdk

Basic usage

$client = new \DeliveryMatch\Sdk\Client(
    apikey: getenv("DM_API_KEY"),
    clientId: getenv("DM_CLIENT_ID"),
    environment: \DeliveryMatch\Sdk\HttpClient\ApiEnvironment::PRODUCTION
);

// For endpoints that are currently mapped in the sdk
$response = $client->shipments()->insert(new \DeliveryMatch\Sdk\Api\Dto\Request\ShipmentRequest(
    client: new \DeliveryMatch\Sdk\Api\Dto\Request\Client(...),
    customer: new \DeliveryMatch\Sdk\Api\Dto\Request\Customer(...),
    shipment: new \DeliveryMatch\Sdk\Api\Dto\Request\Shipment(...),
    packages: [new \DeliveryMatch\Sdk\Api\Dto\Request\Package(...)],
    products: [new \DeliveryMatch\Sdk\Api\Dto\Request\Product(... )],
    priceIncl: 19.95,
    weight: 20.0  
));


// For endpoints that are not (yet) available in the sdk
$request = [
    "shipment" => [
        "id" => 123
    ]
];

$response = $client->post("/getStatus", body: $request);