README

PHP client for Shipping API

For more information, please visit https://github.com/dinasjp.

Installation & Usage

Requirements

PHP 8.1 and later.

Install

composer require dinas/shipping-sdk-php

Your project is free to choose the http client of your choice Please require packages that will provide http client functionality:
https://packagist.org/providers/psr/http-client-implementation
https://packagist.org/providers/php-http/async-client-implementation
https://packagist.org/providers/psr/http-factory-implementation

As an example:

composer require guzzlehttp/guzzle php-http/guzzle7-adapter http-interop/http-factory-guzzle

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/ShippingSdk/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure Bearer (Token) authorization: bearerAuth
$config = Dinas\ShippingSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Dinas\ShippingSdk\Api\CarsApi(
    // If you want use custom http client, pass your client which implements `Psr\Http\Client\ClientInterface`.
    // This is optional, `Psr18ClientDiscovery` will be used to find http client. For instance `GuzzleHttp\Client` implements that interface
    new GuzzleHttp\Client(),
    $config
);
$status = 'status_example'; // string | Filter by car status
$chassis = 'chassis_example'; // string | Filter by chassis number (multiple values separated by spaces)
$search = 'search_example'; // string | Search by partial chassis, make, model
$voyage = 'voyage_example'; // string | Filter by voyage
$photos = True; // bool | Filter by photos presence
$on_yard = True; // bool | Filter by yard presence
$sort = 'sort_example'; // string | Sort field. Prefix with - for descending. **default: -id**
$per_page = 56; // int | Number of items per page. **default: 100**
$page = 56; // int | Page number. **default: 1**

try {
    $result = $apiInstance->getCarPhotos($status, $chassis, $search, $voyage, $photos, $on_yard, $sort, $per_page, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CarsApi->getCarPhotos: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://shipping.dinas.jp

Models

• ActionResponse
• Album
• AlbumFiles
• AlbumInfo
• AlbumType
• AlbumUrls
• AlbumsPaginated
• CarAlbums
• CarBase
• CarData
• CarDocuments
• CarError
• CarModel
• CarPrices
• CarUpdateResponse
• CarYardEta
• CarsPaginated
• Dealer
• DocumentFile
• DocumentInfo
• DocumentType
• DocumentUrl
• ExportMethod
• ExportType
• FuelType
• GrantCarsRequest
• HoldCarsRequest
• InnerCargo
• PaginationLinks
• PaginationMeta
• PriceTerms
• ReleaseCarsRequest
• SetYardEtaRequest
• ShipDateLimit
• SimpleResource
• StockStatus
• VehicleType
• Voyage
• VoyageInfo
• VoyageStatus
• VoyagesPaginated
• Webhook
• WithholdCarsRequest
• Yard

Authorization

bearerAuth

• Type: Bearer authentication (Token)

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

info@dinas.jp

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: 1.1.0
  • Generator version: 7.17.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.PhpClientCodegen