logistics-x/shipments-sdk

API client generated from OpenAPI definition from Logistics-X.com

Maintainers

Details

bitbucket.org/bricre/lx-shipments-sdk

Homepage

Source

Installs: 254

Dependents: 0

Suggesters: 0

Security: 0

dev-master 2023-04-14 08:51 UTC

Requires

Requires (Dev)

Apache-2.0 139cf9cf6035f927f775c3f46683ab3a667f539a

  • Allan Sun <allan.sun.woop@bricre.com>

This package is auto-updated.

Last update: 2024-12-14 12:52:11 UTC

README

Code generated from Logistics-X.com's OpenAPI file using allansun/openapi-code-generator.

Generated code is well self-documented with proper PHPDoc annotations.

Please refer to Logistics-X.com's documentation for detailed API behaviour explanation.

Installation

composer require logistics-x/shipments-sdk

You will also need a PSR-18 compatible client see https://docs.php-http.org/en/latest/clients.html

So either use Guzzle (or any other PSR-18 compatible clients)

composer require php-http/guzzle7-adapter

Versioning

This project matches Logistics-X's API versioning.

Should you found a matching version not being available. Please contact the author to generate against correct version.

Usage

First you need to create a PSR-18 Then in your business logic you can call API operations directly

<?php
use LogisticsX\Users\Api\User;
$httpClient = new \GuzzleHttp\Client([
    'base_uri' => 'https://www.logistics-x.com/',
    'headers'=>[
        'Authorization'=> 'Bearer <accessToken>'
    ]
]);
$api = new User($httpClient);

$users = $api->getUserCollection();

Author