PHP client for Shipping API
For more information, please visit https://github.com/dinasjp.
PHP 8.1 and later.
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
Download the files and include autoload.php:
<?php
require_once('/path/to/ShippingSdk/vendor/autoload.php');
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;
}
All URIs are relative to https://shipping.dinas.jp
| Class | Method | HTTP request | Description |
|---|---|---|---|
| CarDocumentsApi | storeCarDocumentFiles | POST /api/cars/docs/file | Store car document files |
| CarDocumentsApi | storeCarDocumentUrls | POST /api/cars/docs/url | Store car document URLs |
| CarPhotosApi | getCarPhotos | GET /api/cars/photos | Get car photos |
| CarPhotosApi | storeCarPhotoFiles | POST /api/cars/photos/file | Store car photos from files |
| CarPhotosApi | storeCarPhotoUrls | POST /api/cars/photos/url | Store car photos from URLs |
| CarsApi | getCars | GET /api/cars | Get paginated list of cars |
| CarsApi | grantCars | POST /api/cars/grant | Clear withhold status |
| CarsApi | holdCars | POST /api/cars/hold | Hold cars from shipping |
| CarsApi | releaseCars | POST /api/cars/release | Allow us to ship cars |
| CarsApi | setYardEta | POST /api/cars/yard/eta | Set yard ETA for cars |
| CarsApi | syncCars | POST /api/cars | Create or update cars |
| CarsApi | withholdCars | POST /api/cars/withhold | Withhold cars upon arrival |
| VoyagesApi | getBlEd | GET /api/voyages/{voyage}/bl-ed | Download Bill of Lading and Export Declaration for a specific voyage |
| VoyagesApi | getVoyage | GET /api/voyages/{voyage} | Retrieve detailed information about a specific voyage |
| VoyagesApi | getVoyages | GET /api/voyages | Retrieve a paginated list of voyages with optional filtering and sorting |
| WebhooksApi | deleteWebhook | DELETE /api/webhooks/{name} | Delete a webhook |
| WebhooksApi | getWebhook | GET /api/webhooks/{name} | Retrieve a specific webhook by name |
| WebhooksApi | getWebhooks | GET /api/webhooks | Retrieve a list of webhooks |
| WebhooksApi | storeWebhook | POST /api/webhooks | Create a new webhook |
| WebhooksApi | testWebhook | POST /api/webhooks/{name}/test | Send a test payload to the webhook to verify it's working |
| WebhooksApi | toggleWebhook | PATCH /api/webhooks/{name}/toggle | Toggle the active status of a webhook |
| WebhooksApi | updateWebhook | PUT /api/webhooks/{name} | Update an existing webhook |
To run the tests, use:
composer install
vendor/bin/phpunit
This PHP package is automatically generated by the OpenAPI Generator project:
1.1.0
7.17.0-SNAPSHOTorg.openapitools.codegen.languages.PhpClientCodegenHow can I help you explore Laravel packages today?