PHPackages                             djthossi/shipcloud-sdk - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. djthossi/shipcloud-sdk

ActiveLibrary[API Development](/categories/api)

djthossi/shipcloud-sdk
======================

This project is an SDK for shipcloud's API. Thanks to comyo-media/shipcloud-php for providing the PHP 5.4+ version which works pretty similar and inspired me to build this php 8.1+ version

5.0.0(1mo ago)11.5k↓100%MITPHPPHP ^8.1.0

Since Aug 27Pushed 1mo ago1 watchersCompare

[ Source](https://github.com/DjThossi/shipcloud-sdk)[ Packagist](https://packagist.org/packages/djthossi/shipcloud-sdk)[ RSS](/packages/djthossi-shipcloud-sdk/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (3)Versions (10)Used By (0)

shipcloud Sdk
=============

[](#shipcloud-sdk)

[![Code Climate](https://camo.githubusercontent.com/83189506c6124cff55e4d20d31169d71a844f0a92d539e8c91a0c7bb84e36936/68747470733a2f2f6170692e636f6465636c696d6174652e636f6d2f76312f6261646765732f63643066656436366632383935326535333033392f6d61696e7461696e6162696c697479)](https://codeclimate.com/github/DjThossi/shipcloud-sdk/maintainability)

This is a PHP library for interacting with shipclouds API.

This library is supporting the following entities in shipcloud's version v1

- Addresses
- Carriers
- Default return address
- Default shipping address
- Invoice address
- Me
- Pickup request
- Shipment quote
- Shipments
- Trackers
- Webhooks

The Endpoint `Rates` is not part of this library as it is deprecated and will be removed in later versions. Use `Shipment Quuotes` instead.

This library is made for PHP projects featuring PHP version 8.1+. If you are looking for a library for PHP version between 5.4 and 7.4 try

How to install
--------------

[](#how-to-install)

This lib can be installed via composer

```
composer require djthossi/shipcloud-sdk
```

Examples
--------

[](#examples)

You'll find examples for all API endpoints in the `~/examples` folder. Have fun with it.

Usage in Symfony
----------------

[](#usage-in-symfony)

You want to use this library inside a symfony project including auto-wiring? After installing simply add this code to your `config/services.yaml`

Add this to the parameter section of your `services.yaml`

```
parameters:
  # shipcloud parameters
  app.SHIPCLOUD_API_KEY: "%env(SHIPCLOUD_API_KEY)%"
```

Add this to the services section of your `services.yaml`

```
services:
  # shipcloud services
    DjThossi\ShipcloudSdk\Http\:
        resource: '../vendor/djthossi/shipcloud-sdk/src/Http'
        bind:
            $apiKey: '%app.SHIPCLOUD_API_KEY%'

    DjThossi\ShipcloudSdk\Api\:
        resource: '../vendor/djthossi/shipcloud-sdk/src/Api'
        arguments:
            $client: '@DjThossi\ShipcloudSdk\Http\Client'
```

Afterwards add the `SHIPCLOUD_API_KEY` including your personal API key to your `.env.local` file like this.

```
#shipcloud parameters
SHIPCLOUD_API_KEY=PUT_YOUR_KEY_HERE
```

Now you can use each API directly inside your business logic. Symfony will take care of the auto-wiring for you.

```