Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2026 Alexis POUPELIN

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
71 changes: 64 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,69 @@
# Sendcloud
# Sendcloud v3 ☁️

This library only supports Sendcloud API v3.
For v3, checkout https://github.com/Webador/sendcloud
![Packagist Version](https://img.shields.io/packagist/v/alexispplin/sendcloud-v3?link=https%3A%2F%2Fpackagist.org%2Fpackages%2Falexispplin%2Fsendcloud-v3)
![License](https://img.shields.io/github/license/AlexisPPLIN/sendcloud-v3)

## Installation
## 📦 About

TODO
Implementation of [Sendcloud v3 API](https://sendcloud.dev/api/v3) for PHP

## Supported Endpoints
> [!NOTE]
> For v2 users, use [Webador/sendcloud](https://github.com/Webador/sendcloud)
> (which this library is heavily inspired by)

- Orders
## ⚙️ Requirements

- PHP 8.2+
- PSR7 & PSR17 implementation

## 🛠️ Installation

```bash
composer require alexispplin/sendcloud-v3
```

> [!NOTE]
> This library uses [HTTPlug](https://docs.php-http.org/en/latest/httplug/users.html)

For this lib to work, you will need to install a PSR7 & PSR17 implementation.
Check the full documentation here : https://docs.php-http.org/en/latest/httplug/users.html

For example :
```bash
composer require symfony/http-client nyholm/psr7
```

## 🌐 Supported Endpoints

- [Orders](https://sendcloud.dev/api/v3/orders)

## 💡 Quick start

```php
<?php
use AlexisPPLIN\SendcloudV3\Endpoints\Orders;

// Create client

$orders = new Orders(
publicKey: /* YOUR PUBLIC KEY */,
secretKey: /* YOUR SECRET KEY */,
partnerId: /* (optional) YOUR PARTNER ID */
);

// Retrieve an order

$order = $orders->getOrder(id: 1);
```

## 🤝 Contributing

Contributions are welcome! Please follow these steps:
1. Fork the repository
2. Create a branch for your feature
3. Commit your changes
5. Create a Pull Request to the main branch

## 📄 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.