README

Returns Interface

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

API version: 2.0.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-returns-api-client.git"
    }
  ],
  "require": {
    "mehr-it/otto-returns-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\OttoReturnsApiClient\Api\ReturnsStatusApi(
    // 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()
);
$status = "status_example"; // string | Return status for which items are being queried for
$limit = 10; // int | Page size to limit the number of items returned in the response. Maximum value for limit can 10
$page = 1; // int | Page number to fetch. This parameter is required to fetch data for specific page number

try {
    $result = $apiInstance->getPositionItemsForUsingGET($status, $limit, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReturnsStatusApi->getPositionItemsForUsingGET: ', $e->getMessage(), PHP_EOL;
}

$apiInstance = new MehrIt\OttoReturnsApiClient\Api\ReturnsStatusApi(
    // 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\OttoReturnsApiClient\Model\AcceptedPartnerReturnV2(); // \MehrIt\OttoReturnsApiClient\Model\AcceptedPartnerReturnV2 | acceptedPartnerReturn

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

$apiInstance = new MehrIt\OttoReturnsApiClient\Api\ReturnsStatusApi(
    // 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\OttoReturnsApiClient\Model\RejectedPartnerReturnV2(); // \MehrIt\OttoReturnsApiClient\Model\RejectedPartnerReturnV2 | rejectedPartnerReturn

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

Documentation for API Endpoints

All URIs are relative to https://partner-acl.develop.returns.platform.otto.de/

Class	Method	HTTP request	Description
ReturnsStatusApi	getPositionItemsForUsingGET	GET /v2/returns	Get all the items filtered on return status
ReturnsStatusApi	receiveAcceptedReturnsV2UsingPOST	POST /v2/returns/acceptance	Accept the return for a sent position item (up to 200 items per request)
ReturnsStatusApi	receiveRejectedReturnsV2UsingPOST	POST /v2/returns/rejection	Reject the return for a sent position item (up to 200 items per request)

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

mehr-it / otto-returns-api-client

Maintainers

Details