picqer / sendcloud-php-client
A PHP Client for the SendCloud API
Installs: 297 534
Dependents: 2
Suggesters: 0
Security: 0
Stars: 41
Watchers: 10
Forks: 42
Open Issues: 1
Requires
- php: >=7.4.0
- ext-json: *
- guzzlehttp/guzzle: ~6.0|~7.0
- dev-master
- dev-main
- v2.8.1
- v2.8.0
- v2.7.2
- v2.7.1
- v2.7.0
- v2.6.0
- v2.5.1
- v2.5.0
- v2.4.2
- v2.4.1
- v2.4.0
- v2.3.11
- v2.3.10
- v2.3.9
- v2.3.8
- v2.3.7
- v2.3.6
- v2.3.5
- v2.3.4
- v2.3.3
- v2.3.2
- v2.3.1
- v2.3.0
- v2.2.2
- v2.2.1
- v2.2.0
- v2.1.3
- v2.1.2
- v2.1.1
- v2.1.0
- v2.0.3
- v2.0.2
- v2.0.1
- v2.0.0
- v1.1.0
- v1.0.0
- dev-readd-sender-address
- dev-add-label-attribute-to-parcel
This package is auto-updated.
Last update: 2024-10-08 10:35:43 UTC
README
An unofficial client for the Sendcloud API. More info about Sendcloud on https://www.sendcloud.nl/ Below are some examples on the usage of this client.
Full docs of the Sendcloud API can be found on https://docs.sendcloud.sc/api/v2/index.html
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 API secret. (Optionally you can send your Partner id as 3rd param.)
$connection = new \Picqer\Carriers\SendCloud\Connection('apikey', 'apisecret'); $sendcloudClient = new \Picqer\Carriers\SendCloud\SendCloud($connection);
Get all parcels
Returns an array of Parcel objects
$parcels = $sendcloudClient->parcels()->all();
Get a single parcel
Returns a Parcel object
$parcel = $sendcloudClient->parcels()->find(2342);
Create a new parcel
$parcel = $sendcloudClient->parcels(); $parcel->shipment = 10; // Shipping method, get possibilities from $sendCloud->shippingMethods()->all() $parcel->name = 'John Smith'; $parcel->company_name = 'ACME'; $parcel->address = 'Wellingtonstreet 25'; $parcel->city = 'Wellington'; $parcel->postal_code = '3423 DD'; $parcel->country = 'NL'; $parcel->order_number = 'ORDER2014-52321'; $parcel->requestShipment = true; // Specifically needed to create a shipment after adding the parcel $parcel->save();
Getting label from parcel
$labelUrl = $parcel->getPrimaryLabelUrl(); $documentDownloader = new \Picqer\Carriers\SendCloud\DocumentDownloader($connection); $labelContents = $documentDownloader->getDocument($labelUrl, 'pdf');
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()); }
Create an international parcel
$parcel = $sendcloudClient->parcels(); $parcel->shipment = 9; // Shipping method, get possibilities from $sendCloud->shippingMethods()->all() $parcel->name = 'John Smith'; $parcel->company_name = 'ACME'; $parcel->address = 'Wellingtonstreet 25'; $parcel->city = 'Wellington'; $parcel->postal_code = '3423 DD'; $parcel->country = 'CH'; $parcel->order_number = 'ORDER2014-52321'; $parcel->weight = 20.4; // For international shipments $parcel->customs_invoice_nr = 'ORD9923882'; $parcel->customs_shipment_type = 2; // Commercial goods $parcel->parcel_items = [ [ 'description' => 'Cork', 'quantity' => 2, 'weight' => 10.2, 'value' => 12.93, 'hs_code' => '992783', 'origin_country' => 'CN', ] ]; $parcel->requestShipment = true; // Specifically needed to create a shipment after adding the parcel $parcel->save();