schoppax/nexcargo-php-sdk

PHP SDK for the NexCargo (Camel Cloud API) carrier integration

dev-main 2026-08-07 12:49 UTC

Requires

• php: ^8.2
• guzzlehttp/guzzle: ^7.4

Requires (Dev)

• phpstan/phpstan: ^2.0
• phpunit/phpunit: ^11.0

MIT

• schoppax

Published on Packagist.org on 2026-08-07 12:50 UTC

README

A PHP 8.2+ SDK for the Camel Cloud API / NexCargo carrier integration using Guzzle.

Installation

Install the package from Packagist:

composer require schoppax/nexcargo-php-sdk

API overview

The SDK targets the following endpoints from the original API documentation:

• POST /api/v1/shipments for creating a shipment
• POST /api/v1/shipments/quote for requesting a quote
• GET /api/v1/shipments/{id}/label for retrieving a label
• GET /api/v1/shipments/{id}/tracking for tracking information
• DELETE /api/v1/shipments/{id} for cancelling a shipment

Usage

You can build requests either with serialized model objects or with plain payload arrays. Both styles are accepted by the client methods.

<?php

use NexCargo\Client;
use NexCargo\Models\Address;
use NexCargo\Models\Dimensions;
use NexCargo\Models\Parcel;
use NexCargo\Models\ShipmentRequest;
use NexCargo\Models\QuoteRequest;

$client = new Client('your-api-key', 'https://api.example.com');

Shipment creation

The shipment endpoint expects a payload with the core booking fields and nested pickup, delivery and package data.

$pickup = new Address([
    'name' => 'Musterfirma GmbH',
    'street' => 'Musterstraße',
    'house_number' => '123',
    'zipcode' => '50667',
    'city' => 'Köln',
    'country' => 'DE',
]);

$delivery = new Address([
    'name' => 'Empfänger GmbH',
    'street' => 'Beispielweg',
    'house_number' => '456',
    'zipcode' => '10115',
    'city' => 'Berlin',
    'country' => 'DE',
]);

$package = new Parcel([
    'weight' => 15.5,
    'dimensions' => new Dimensions([
        'length' => 60,
        'width' => 40,
        'height' => 30,
    ]),
]);

$shipment = new ShipmentRequest([
    'carrier' => 'auto',
    'pickup_date' => '2026-01-15',
    'pickup_time_from' => '09:00',
    'pickup_time_to' => '12:00',
    'delivery_date' => '2026-01-16',
    'delivery_time_from' => '08:00',
    'delivery_time_to' => '18:00',
    'pickup' => $pickup,
    'delivery' => $delivery,
    'packages' => [$package],
]);

$response = $client->createShipment($shipment);

Quote request

The quote endpoint uses the same request shape as shipment creation, but the carrier field is optional.

$quote = new QuoteRequest([
    'pickup_date' => '2026-01-15',
    'pickup_time_from' => '09:00',
    'pickup_time_to' => '12:00',
    'delivery_date' => '2026-01-16',
    'delivery_time_from' => '08:00',
    'delivery_time_to' => '18:00',
    'pickup' => $pickup,
    'delivery' => $delivery,
    'packages' => [$package],
]);

$response = $client->quoteShipment($quote);

Other endpoints

$label = $client->getShipmentLabel('shipment-id');
$tracking = $client->getShipmentTracking('shipment-id');
$cancelled = $client->cancelShipment('shipment-id');