mehr-it/otto-shipments-api-client

PHP client for Otto shipments API generated using Swagger

1.0.1 2020-12-14 10:40 UTC

Requires

• php: >=5.5
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^6.2|^7.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ~1.12
• phpunit/phpunit: ^4.8
• squizlabs/php_codesniffer: ~2.6

MIT

• mehr.IT GmbH
• Swagger and contributors

• php
• api
• sdk
• shipments
• swagger
• otto

README

This interface describes all endpoints regarding the shipment domain.

This PHP package is automatically generated by the Swagger Codegen project:

• API version: 1.1.0
• Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/mehr-it/otto-shipments-api-client.git"
    }
  ],
  "require": {
    "mehr-it/otto-shipments-api-client": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/./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');

$apiInstance = new MehrIt\OttoShipmentsApiClient\Api\ShipmentsApi(
    // 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()
);
$body = array(new \MehrIt\OttoShipmentsApiClient\Model\PositionItem()); // \MehrIt\OttoShipmentsApiClient\Model\PositionItem[] | The position items included in shipment.
$carrier = "carrier_example"; // string | The carrier of the shipment.
$tracking_number = "tracking_number_example"; // string | The tracking number of the shipment assigned by the carrier.

try {
    $apiInstance->appendPositionItemsByCarrierAndTrackingNumberUsingPOST($body, $carrier, $tracking_number);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentsApi->appendPositionItemsByCarrierAndTrackingNumberUsingPOST: ', $e->getMessage(), PHP_EOL;
}

$apiInstance = new MehrIt\OttoShipmentsApiClient\Api\ShipmentsApi(
    // 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()
);
$body = array(new \MehrIt\OttoShipmentsApiClient\Model\PositionItem()); // \MehrIt\OttoShipmentsApiClient\Model\PositionItem[] | positionItems
$shipment_id = "shipment_id_example"; // string | Internal shipment identifier assigned by OTTO Market.

try {
    $apiInstance->appendPositionItemsUsingPOST($body, $shipment_id);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentsApi->appendPositionItemsUsingPOST: ', $e->getMessage(), PHP_EOL;
}

$apiInstance = new MehrIt\OttoShipmentsApiClient\Api\ShipmentsApi(
    // 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()
);
$body = new \MehrIt\OttoShipmentsApiClient\Model\CreateShipmentRequest(); // \MehrIt\OttoShipmentsApiClient\Model\CreateShipmentRequest | request

try {
    $result = $apiInstance->createdAndSentShipmentUsingPOST($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentsApi->createdAndSentShipmentUsingPOST: ', $e->getMessage(), PHP_EOL;
}

$apiInstance = new MehrIt\OttoShipmentsApiClient\Api\ShipmentsApi(
    // 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()
);
$datefrom = "datefrom_example"; // string | Shipments created from this date onwards for the given authorized partner will be returned. The date is considered as UTC.
$limit = 25; // int | The maximum number of shipments to be returned in each response.
$next = "next_example"; // string | The cursor which points to the next shipment that should be queried. It is used to paginate the results.

try {
    $result = $apiInstance->listShipmentsUsingGET($datefrom, $limit, $next);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentsApi->listShipmentsUsingGET: ', $e->getMessage(), PHP_EOL;
}

$apiInstance = new MehrIt\OttoShipmentsApiClient\Api\ShipmentsApi(
    // 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()
);
$carrier = "carrier_example"; // string | The carrier of the shipment.
$tracking_number = "tracking_number_example"; // string | The tracking number of the shipment assigned by the carrier.

try {
    $result = $apiInstance->shipmentByCarrierAndTrackingNumberUsingGET($carrier, $tracking_number);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentsApi->shipmentByCarrierAndTrackingNumberUsingGET: ', $e->getMessage(), PHP_EOL;
}

$apiInstance = new MehrIt\OttoShipmentsApiClient\Api\ShipmentsApi(
    // 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()
);
$shipment_id = "shipment_id_example"; // string | Internal shipment identifier assigned by OTTO Market.

try {
    $result = $apiInstance->shipmentUsingGET($shipment_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentsApi->shipmentUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>

Documentation for API Endpoints

All URIs are relative to https://live.api.otto.market/v1

Documentation For Models

• Address
• BadRequest
• BadRequestAddPositionItemByShipmentId
• BadRequestAddPositionItemByTrackingNumber
• Conflict
• ConflictAddPositionItemByShipmentId
• ConflictAddPositionItemByTrackingNumber
• CreateShipmentRequest
• CreateShipmentResponse
• ErrorDescription
• ForbiddenGetShipmentByShipmentId
• ForbiddenGetShipmentByTrackingNumber
• InternalServerError
• InternalServerErrorAddPositionItemByShipmentId
• InternalServerErrorAddPositionItemByTrackingNumber
• InternalServerErrorGetShipmentByShipmentId
• InternalServerErrorGetShipmentByTrackingNumber
• InternalServerErrorGetShipmentList
• Link
• NotFoundAddPositionItemByShipmentId
• NotFoundAddPositionItemByTrackingNumber
• NotFoundGetShipmentByShipmentId
• NotFoundGetShipmentByTrackingNumber
• PositionItem
• ReturnTrackingKey
• Shipment
• ShipmentList
• ShipmentWithMinimumDetails
• TrackingKey
• Unauthenticated

Documentation For Authorization

All endpoints do not require authorization.

Author