koemeet / sendcloud-php-client

PHP Client for SendCloud API

SendCloud PHP API Client

An unofficial client for the SendCloud API. More info about SendCloud on http://sendcloud.nl. Below are some examples on the usage of this client.

Installation

This project can easily be installed through Composer.

composer require picqer/sendcloud-php-client

Set-up connection

Prepare the client for connecting to SendCloud with your API key and secret

$connection = new \Picqer\Carriers\SendCloud\Connection('apikey', 'apisecret');
$sendCloud = new \Picqer\Carriers\SendCloud\SendCloud($connection);

Get all parcels

Returns an array of Parcel objects

$parcels = $sendCloud->parcels()->all();

Get a single parcel

Returns a Parcel object

$parcel = $sendCloud->parcels()->find(2342);

Create a new parcel

$parcel = $sendCloud->parcels();

$parcel->name = 'John Smith';
$parcel->company_name = 'ACME';
$parcel->address = 'Wellingtonstreet 25';
$parcel->city = 'Wellington';
$parcel->postal_code = '3423 DD';
$parcel->country = 'NL';
$parcel->requestShipment = true;
$parcel->shipment = 10; // Shipping method ($sendCloud->shippingMethods()->all())
$parcel->order_number = 'ORDER2014-52321';

$parcel->save();

Exceptions

Actions to the API may cause an Exception to be thrown in case something went wrong

try
{
    $parcel->save();
} catch (SendCloudApiException $e)
{
    throw new Exception($e->getMessage());
}