yogarine / boxture-v2-sdk-php
SDK for the Boxture API v2
0.1.0
2019-06-04 13:13 UTC
Requires
- php: >=7.1
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^6.2
Requires (Dev)
- friendsofphp/php-cs-fixer: ~2.12
- squizlabs/php_codesniffer: ~2.6
This package is auto-updated.
Last update: 2024-11-05 01:54:04 UTC
README
Detailed documentation and test tool for the Boxture API v2
This PHP package is automatically generated by the OpenAPI Generator project:
- API version: 0.0.1
- Package version: 0.1.0
- Build package: org.openapitools.codegen.languages.PhpClientCodegen
Requirements
PHP 5.5 and later
Installation & Usage
Composer
To install the bindings via Composer, add the following to composer.json
:
{ "repositories": [ { "type": "vcs", "url": "https://github.com/yogarine/boxture-v2-sdk-php.git" } ], "require": { "yogarine/boxture-v2-sdk-php": "*@dev" } }
Then run composer install
Manual Installation
Download the files and include autoload.php
:
require_once('/path/to/boxture-v2-sdk-php/vendor/autoload.php');
Tests
To run the unit tests:
composer install ./vendor/bin/phpunit
Getting Started
Please follow the installation procedure and then run the following:
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api_key $config = Boxture\V2\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Boxture\V2\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer'); $apiInstance = new Boxture\V2\Api\HandlingUnitsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $search = 'search_example'; // string | $orderField = 'orderField_example'; // string | Exact field name you want to sort the output by $orderDirection = 'asc'; // string | Sort direction $page = 1; // int | Page number $pageSize = 25; // int | Max number of results per page try { $result = $apiInstance->getHandlingUnits($search, $orderField, $orderDirection, $page, $pageSize); print_r($result); } catch (Exception $e) { echo 'Exception when calling HandlingUnitsApi->getHandlingUnits: ', $e->getMessage(), PHP_EOL; } ?>
Documentation for API Endpoints
All URIs are relative to http://staging.localexpress.nl/api/v2
Documentation For Models
- CompanyResponseMinimal
- ErrorResponse
- HandlingUnitResponse
- LocationRequest
- LocationResponse
- PatchShipments
- PostShipments
- PostShipmentsIdAccept
- PostShipmentsIdAssign
- PostShipmentsIdCancel
- PostShipmentsIdDropoff
- PostShipmentsIdPickup
- PostShipmentsIdPurchase
- PostShipmentsIdReplan
- RetailerResponseMinimal
- ServiceTypeDropoffOfferResponse
- ServiceTypeResponse
- ShipmentAcceptRequest
- ShipmentAssignRequest
- ShipmentCancelRequest
- ShipmentDropoffLineRequest
- ShipmentDropoffRequest
- ShipmentLineRequest
- ShipmentLineResponse
- ShipmentPickupLineRequest
- ShipmentPickupRequest
- ShipmentPurchaseRequest
- ShipmentQuoteRequest
- ShipmentReplanRequest
- ShipmentResponse
- ShipmentResponseServiceTypes
- ShipmentStateTransitionResponse
- ShipmentUpdateLineRequest
- ShipmentUpdateRequest
- TimeWindowRequest
- TimeWindowResponse
- UserResponseMinimal
Documentation For Authorization
api_key
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header