shippii-tech/php-sdk

SDK For shippii.com

Maintainers

Details

github.com/Shippii-Tech/php-sdk

Source

Issues

Installs: 15

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 3

1.0.0 2023-01-19 12:24 UTC

Requires

Requires (Dev)

MIT df6200b5cf93b9d37f156f02823a92b2d32dfca8

  • Stoyan Todorov <s.todorov.woop@vconnect.dk>

This package is auto-updated.

Last update: 2024-04-19 14:58:14 UTC

README

Total Downloads Latest Stable Version License

Introduction

This package provides an expressive interface for interacting with Shippii API v4.

Official Documentation

Installation

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

composer require shippii-tech/php-sdk

Upgrading

When upgrading to a new major version of SHIPPII API v4 PHP SDK, it's important that you carefully review the upgrade guide.

Basic Usage

Initialize Shippii client:

    $shippii = new \Shippii\Shippii(
        apiKey: { Your API key }
    );

Send a request through the client:

    $shippii->getCountries();

    $shippii->getCarrier('car_2IGXIoELZX4Bga45tOxo52sbpJY');

Send a request with query parameters through the client:

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

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

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

API Reference


Shippii client

Carriers

Get All Carriers

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

Get Single Carrier

    $shippii->getCarrier(string $carrierId): Carrier

Create Carrier

    $shippii->createCarrier(array $payload): Carrier

Update Carrier

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

Delete Carrier

    $shippii->deleteCarrier(string $carrierId): Carrier

Carrier Accounts

Get All Carrier Accounts

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

Get Single Carrier Account

    $shippii->getCarrierAccount(string $carrierAccountId): CarrierAccount

Create Carrier Account

    $shippii->createCarrierAccount(array $payload): CarrierAccount

Update Carrier Account

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

Delete Carrier Account

    $shippii->deleteCarrierAccount(string $carrierAccountId): CarrierAccount

Get Carrier Account Fields

    $shippii->getCarrierAccountFields(string $carrierCode): CarrierAccountFields

Countries

Get All Countries

    $shippii->getCountries(): Country

Labels

Fetch or/and print shipment labels

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

Organisation Objects

Get All Organisation Objects

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

Get Single Organisation Object

    $shippii->getOrganisationObject(string $organisationObjectId): OrganisationObject

Create Organisation Object

    $shippii->createOrganisationObject(array $payload): OrganisationObject

Update Organisation Object

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

Delete Organisation Object

    $shippii->deleteOrganisationObject(string $organisationObjectId): OrganisationObject

Organisations

Get All Organisation

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

Get Single Organisation

    $shippii->getOrganisation(string $organisationId): Organisation

Create Organisation

    $shippii->createOrganisation(array $payload): Organisation

Update Organisation

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

Delete Organisation

    $shippii->deleteOrganisation($organisationId): Organisation

Shipments

Get All Shipments

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

Create Shipment

    $shippii->createShipment(array $payload): Shipment

Update Shipment

    $shippii->updateShipment(string $shipmentId, array $payload): Shipment

Update Shipment State

    $shippii->updateShipmentState(string shipmentId, string $shipmentState): Shipment

Archive Shipment

    $shippii->archiveShipment(string $shipmentId): Shipment

Users

Get All Users

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

Get Single User

    $shippii->getUser(string $userId): User

Consolidate Invoices

Create Consolidate Invoice

    $shippii->createConsolidateInvoice(array $payload): Invoice

Model properties


Carrier

    public string|null $id = null;
    public Owner|null $owner = null;
    public string|null $name = null;
    public CarrierAccount|null $account = null;
    public string|null $code = null;
    public CarrierSettings|null $settings = null;
    public int|null $status = null;
    public string|null $created_at = null;
    public string|null $updated_at = null;
    public string|null $carrier_identification = null;

CarrierAccount

    public string|null $id = null;
    public string|null $name = null;
    /** @var CarrierAccountFields[]|null */
    public array|null $fields = null;
    public string|null $carrier_code = null;
    public string|null $status = null;
    public string|null $purpose = null;
    /** @var Carrier[]|null */
    public array|null $carriers = null;
    public string|null $expires_at = null;
    public string|null $created_at = null;
    public string|null $updated_at = null;

Country

    public string|null $name = null;
    public string|null $official_state_name = null;
    public string|null $alpha_2_code = null;
    public string|null $alpha_3_code = null;
    public string|null $numeric_code = null;

Label

    public string|null $id = null;
    public string|null $shipmentId = null;
    public string|null $format = null;
    public string|null $metadata = null;
    public Owner|null $owner = null;
    public string|null $url = null;
    public string|null $createdAt = null;
    public string|null $type = null;
    public string|null $temporary_url = null;

Organization

    public string|null $id = null;
    public Owner|null $owner = null;
    public string|null $name = null;
    public string|null $vat_number = null;
    public string|null $company_number = null;
    public bool|null $vat_registered = null;
    public string|null $currency = null;
    public string|null $timezone = null;
    public OrganisationSettings|null $settings = null;
    public string|null $created_at = null;
    public string|null $updated_at = null;
    /** @var Address[]|null */
    public array|null $addresses = null;

OrganisationObject

    public string|null $id = null;
    public string|null $name = null;
    public Organisation|null $organisation = null;
    public string|null $currency = null;
    public string|null $timezone = null;
    public OrganisationObjectSettings|null $settings = null;
    public string|null $created_at = null;
    public string|null $updated_at = null;
    /** @var Address[]|null */
    public array|null $addresses = null;

Shipment

    public string|null $id = null;
    public string|null $rate_id = null;
    public int|null $type = null;
    public string|null $state = null;
    /** @var ShipmentMetadata[]|null  */
    public array|null $metadata = null;
    /** @var Tag[]|null  */
    public array|null $tags = null;
    public string|null $group = null;
    public string|null $creator_id = null;
    public string|null $creator_type = null;
    public string|null $sendable_id = null;
    public string|null $sendable_address_id = null;
    public string|null $receivable_id = null;
    public string|null $receivable_address_id = null;
    public string|null $sendable_reference = null;
    public string|null $system_reference = null;
    public Address|null $receivable_address = null;
    public User|null $receivable = null;
    public Address|null $sendable_address = null;
    public OrganisationObject|null $organisation_object = null;
    public string|null $carrier_identification = null;
    public Carrier|null $carrier = null;
    public User|null $creator = null;
    /** @var Line[]|null  */
    public array|null $items = null;
    /** @var ActivityLog[]|null  */
    public array|null $logs = null;
    public string|null $shipment_carrier_data = null;
    public string|null $created_at = null;
    public string|null $updated_at = null;
    public string|null $reference = null;
    public ShipmentSendable|null $sendable = null;
    public Label|null $label = null;
    /** @var Parcel[]|null */
    public array|null $parcels = null;

User

    public string|null $id = null;
    public string|null $first_name = null;
    public string|null $last_name = null;
    public string|null $email = null;
    public string|null $mobile_e164 = null;
    public string|null $mobile_national = null;
    public string|null $mobile_raw = null;
    public string|null $role = null;
    public string|null $timezone = null;
    public string|null $locale = null;
    public string|null $created_at = null;
    public string|null $update_at = null;
    /** @var Organisation[]|null  */
    public array|null $organisations = null;

Invoice

    public string|null $invoice_url = null;