PHPackages                             vshipdk/php-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. vshipdk/php-sdk

ActiveLibrary[API Development](/categories/api)

vshipdk/php-sdk
===============

SDK For vShip API

2.2.0(2mo ago)0418↓33.3%5MITPHPPHP ~8.1.0 | ~8.2.0 | ~8.3.0 | ~8.4.0

Since Nov 30Pushed 2mo ago1 watchersCompare

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

READMEChangelog (6)Dependencies (11)Versions (16)Used By (5)

vShip API PHP SDK (2.2.0)
=========================

[](#vship-api-php-sdk-220)

[![Total Downloads](https://camo.githubusercontent.com/32f7ae810c1f4f309b3dd831335b41c2b0b212dee8a05bd1b377ce203b7331cf/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f7673686970646b2f7068702d73646b)](https://packagist.org/packages/vshipdk/php-sdk)[![Latest Stable Version](https://camo.githubusercontent.com/5f25a9526c4ae0849f7c4611486ed035e1050fb7c761838bc1f136e42bac070b/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f7673686970646b2f7068702d73646b)](https://packagist.org/packages/vshipdk/php-sdk)[![License](https://camo.githubusercontent.com/43034a4f37dd75575bd730fd47f1f49b27c48dd87821bf057ee5b965393ec40b/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f7673686970646b2f7068702d73646b)](https://packagist.org/packages/vshipdk/php-sdk)

Introduction
------------

[](#introduction)

This package provides basic interface to interact with the vShip API.

Detailed list of changes can be found in the [CHANGELOG.md](CHANGELOG.md).

Documentation
-------------

[](#documentation)

### Installation

[](#installation)

To install the SDK in your project you need to require the package via composer:

```
composer require vshipdk/php-sdk
```

### Basic Usage

[](#basic-usage)

Initialize vShip client:

```
    $client = new \Vship\Client(
        apiKey: { Your API key }
    );
```

Send a request through the client:

```
    $client->getCountries();

    $client->getCarrier('car_2IGXIoELZX4Bga45tOxo52sbpJY');
```

Send a request with query parameters through the client:

```
    $client->getCarriers([
        'filter[name]' => 'Carrier name',
    ]);
```

Send a request with body to create API resource through the client:

```
    $response = $client->createOrganisation([
        'name' => 'test 5222ee5511232ff31rr33',
        'vat_number' => '123423rr4 ',
        'company_number' => 'bhifgrvbhief',
        'vat_registered' => false,
        'currency' => 'EUR',
        'timezone' => 'Europe/Copenhagen',
        'settings' => [],
    ]);
```

API Reference
-------------

[](#api-reference)

vShip client
------------

[](#vship-client)

Carriers
========

[](#carriers)

> [Get All Carriers](https://api-dev.vship.dev/docs.html#/paths/v1-carrier/get)

```
    $client->getCarriers(array queryParameters = []): Carrier[]
```

> [Get Single Carrier](https://api-dev.vship.dev/docs.html#/paths/v1-carrier-carrier/get)

```
    $client->getCarrier(string $carrierId): Carrier
```

> [Create Carrier](https://api-dev.vship.dev/docs.html#/paths/v1-carrier/post)

```
    $client->createCarrier(array $payload): Carrier
```

> [Update Carrier](https://api-dev.vship.dev/docs.html#/paths/v1-carrier-carrier/patch)

```
    $client->updateCarrier(string $carrierId, array $payload): Carrier
```

> [Delete Carrier](https://api-dev.vship.dev/docs.html#/paths/v1-carrier-carrier/delete)

```
    $client->deleteCarrier(string $carrierId): Carrier
```

Carrier Accounts
================

[](#carrier-accounts)

> [Get All Carrier Accounts](https://api-dev.vship.dev/docs.html#/paths/v1-carrier-account/get)

```
    $client->getCarrierAccounts(array $queryParameters = []): CarrierAccount[]
```

> [Get Single Carrier Account](https://api-dev.vship.dev/docs.html#/paths/v1-carrier-account-carrierAccount/get)

```
    $client->getCarrierAccount(string $carrierAccountId): CarrierAccount
```

> [Create Carrier Account](https://api-dev.vship.dev/docs.html#/paths/v1-carrier-account/post)

```
    $client->createCarrierAccount(array $payload): CarrierAccount
```

> [Update Carrier Account](https://api-dev.vship.dev/docs.html#/paths/v1-carrier-account-carrierAccount/patch)

```
    $client->updateCarrierAccount(string $carrierAccountId, array $payload): CarrierAccount
```

> [Delete Carrier Account](https://api-dev.vship.dev/docs.html#/paths/v1-carrier-account-carrierAccount/delete)

```
    $client->deleteCarrierAccount(string $carrierAccountId): CarrierAccount
```

> [Get Carrier Account Fields](https://api-dev.vship.dev/docs.html#/paths/v1-carrier-account-fields-carrierCode/get)

```
    $client->getCarrierAccountFields(string $carrierCode): CarrierAccountFields
```

Countries
=========

[](#countries)

> [Get All Countries](https://api-dev.vship.dev/docs.html#/paths/v1-country/get)

```
    $client->getCountries(): Country
```

Labels
======

[](#labels)

> [Fetch or/and print shipment labels](https://api-dev.vship.dev/docs.html#/paths/v1-label-shipment/get)

```
    $client->fetchPrintShipmentLabel(string $shipmentId, array $parameters): Label
```

Organisation Objects
====================

[](#organisation-objects)

> [Get All Organisation Objects](https://api-dev.vship.dev/docs.html#/paths/v1-organisation-object/get)

```
    $client->getOrganisationObjects(array $queryParameters = []): OrganisationObject[]
```

> [Get Single Organisation Object](https://api-dev.vship.dev/docs.html#/paths/v1-organisation-object-object/get)

```
    $client->getOrganisationObject(string $organisationObjectId): OrganisationObject
```

> [Create Organisation Object](https://api-dev.vship.dev/docs.html#/paths/v1-organisation-object/post)

```
    $client->createOrganisationObject(array $payload): OrganisationObject
```

> [Update Organisation Object](https://api-dev.vship.dev/docs.html#/paths/v1-organisation-object-object/patch)

```
    $client->updateOrganisationObject(string $organisationObjectId, array $payload): OrganisationObject
```

> [Delete Organisation Object](https://api-dev.vship.dev/docs.html#/paths/v1-organisation-object-object/delete)

```
    $client->deleteOrganisationObject(string $organisationObjectId): OrganisationObject
```

Organisations
=============

[](#organisations)

> [Get All Organisation](https://api-dev.vship.dev/docs.html#/paths/v1-organisation/get)

```
    $client->getOrganisations(array $queryParameters = []): Organisation[]
```

> [Get Single Organisation](https://api-dev.vship.dev/docs.html#/paths/v1-organisation-organisation/get)

```
    $client->getOrganisation(string $organisationId): Organisation
```

> [Create Organisation](https://api-dev.vship.dev/docs.html#/paths/v1-organisation/post)

```
    $client->createOrganisation(array $payload): Organisation
```

> [Update Organisation](https://api-dev.vship.dev/docs.html#/paths/v1-organisation-organisation/patch)

```
    $client->updateOrganisation(string $organisationId, array $payload): Organisation
```

> [Delete Organisation](https://api-dev.vship.dev/docs.html#/paths/v1-organisation-organisation/delete)

```
    $client->deleteOrganisation($organisationId): Organisation
```

Shipments
=========

[](#shipments)

> [Get All Shipments](https://api-dev.vship.dev/docs.html#/paths/v1-shipment/get)

```
    $client->getShipments(array $queryParameters = []): Shipment[]
```

> [Create Shipment](https://api-dev.vship.dev/docs.html#/paths/v1-shipment/post)

```
    $client->createShipment(array $payload): Shipment
```

> [Cancel Shipment](https://api-dev.vship.dev/docs.html#/paths/v1-shipment-shipment/delete)

```
    $client->cancelShipment(string $id): void
```

> [Archive Shipment](https://api-dev.vship.dev/docs.html#/paths/v1-shipment-archive-shipment/patch)

```
    $client->archiveShipment(string $shipmentId): Shipment
```

Users
=====

[](#users)

> [Get All Users](https://api-dev.vship.dev/docs.html#/paths/v1-user/get)

```
    $client->getUsers(array $queryParameters = []): User[]
```

> [Get Single User](https://api-dev.vship.dev/docs.html#/paths/v1-user-user/get)

```
    $client->getUser(string $userId): User
```

Consolidate Invoices
====================

[](#consolidate-invoices)

> [Create Consolidate Invoice](https://api-dev.vship.dev/docs.html#/paths/v1-invoices-consolidate/post)

```
    $client->createConsolidateInvoice(array $payload): Invoice
```

###  Health Score

50

—

FairBetter than 96% of packages

Maintenance85

Actively maintained with recent releases

Popularity16

Limited adoption so far

Community18

Small or concentrated contributor base

Maturity71

Established project with proven stability

 Bus Factor1

Top contributor holds 55% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~119 days

Recently: every ~102 days

Total

11

Last Release

75d ago

Major Versions

0.3.1 → 1.0.02024-10-02

1.0.2 → 2.0.02025-01-24

PHP version history (3 changes)0.1.0PHP ^8.0 || ^8.1

1.0.0PHP ~8.1.0 | ~8.2.0 | ~8.3.0

2.2.0PHP ~8.1.0 | ~8.2.0 | ~8.3.0 | ~8.4.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/deb4026236b1126e1a3c27530f6ac99ecec7945754d5af189327311c46819b01?d=identicon)[petyots](/maintainers/petyots)

---

Top Contributors

[![novikor](https://avatars.githubusercontent.com/u/26086561?v=4)](https://github.com/novikor "novikor (33 commits)")[![jdreboj](https://avatars.githubusercontent.com/u/73098137?v=4)](https://github.com/jdreboj "jdreboj (25 commits)")[![Copilot](https://avatars.githubusercontent.com/in/1143301?v=4)](https://github.com/Copilot "Copilot (1 commits)")[![stoyantodorovbg](https://avatars.githubusercontent.com/u/25154357?v=4)](https://github.com/stoyantodorovbg "stoyantodorovbg (1 commits)")

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan, Rector

Code StyleLaravel Pint

Type Coverage Yes

### Embed Badge

![Health badge](/badges/vshipdk-php-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/vshipdk-php-sdk/health.svg)](https://phpackages.com/packages/vshipdk-php-sdk)
```

###  Alternatives

[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[convertkit/convertkitapi

Kit PHP SDK for the Kit API

2167.1k1](/packages/convertkit-convertkitapi)[mapado/rest-client-sdk

Rest Client SDK for hydra API

1125.9k2](/packages/mapado-rest-client-sdk)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)