Skip to content

Commit 68a1700

Browse files
committed
Updated README with list of available methods
1 parent b3c7229 commit 68a1700

1 file changed

Lines changed: 48 additions & 1 deletion

File tree

README.md

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
<img src="https://i.imgur.com/kEZU7HH.png" />
44

55
[![Build Status](https://travis-ci.org/imbue/sendcloud-api-php.svg?branch=master)](https://travis-ci.org/imbue/sendcloud-api-php)
6+
[![Downloads](https://img.shields.io/packagist/dt/imbue/sendcloud-api-php.svg)](https://https://packagist.org/packages/imbue/sendcloud-api-php)
67

78
> Note that this library does not yet implement the complete functionality of the SendCloud API. Feel free to open a merge request with the additional implementation.
89
@@ -75,19 +76,65 @@ $shipment = $sendCloud->integrationShipments->upsert(1346, [
7576
]);
7677
```
7778

79+
Retrieve a list of integrations
80+
81+
```php
82+
$sendCloud->integrations->list();
83+
```
84+
85+
Retrieve a single parcel
86+
```php
87+
$sendCloud->parcels->get($id);
88+
```
89+
7890
##### Partner ID
7991

80-
Set the Partner ID
92+
If you are a partner of SendCloud, you can set the `partner id`. The library will ensure it will be added as header to the request.
8193

8294
```php
8395
$sendCloud->setPartnerId('3dd88a04-26e4-4959-af11-f5674491573e')
8496
```
8597

98+
99+
## List of available methods
100+
101+
### Integrations
102+
- List
103+
104+
### Integration Shipments
105+
- List
106+
- Upsert (Update or create)
107+
108+
### Invoices
109+
- List
110+
- Find
111+
112+
### Parcels
113+
- Get
114+
- List
115+
- Create
116+
117+
### Parcel statuses
118+
- List
119+
120+
### Sender addresses
121+
- Get
122+
- List
123+
124+
### Shipping methods
125+
- Get
126+
- List
127+
128+
### User
129+
- Get
130+
131+
86132
## Roadmap
87133

88134
- Implement all possible endpoints [ ]
89135
- Add PHPUnit tests [ ]
90136

137+
91138
## Want to help improving the library?
92139

93140
I will happily accept new [pull requests](https://github.com/imbue/sendcloud-api-php/pulls).

0 commit comments

Comments
 (0)