README

Interface for the partner to get receipts information

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-receipts-api-client.git"
    }
  ],
  "require": {
    "mehr-it/otto-receipts-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\OttoReceiptsApiClient\Api\ReceiptsApi(
    // 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()
);
$receipt_number = "receipt_number_example"; // string | ReceiptNumber

try {
    $apiInstance->getReceiptPdfUsingGET3($receipt_number);
} catch (Exception $e) {
    echo 'Exception when calling ReceiptsApi->getReceiptPdfUsingGET3: ', $e->getMessage(), PHP_EOL;
}

$apiInstance = new MehrIt\OttoReceiptsApiClient\Api\ReceiptsApi(
    // 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()
);
$receipt_number = "receipt_number_example"; // string | ReceiptNumber

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

$apiInstance = new MehrIt\OttoReceiptsApiClient\Api\ReceiptsApi(
    // 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()
);
$limit = 128; // int | Page size to limit the number of receipts returned in the response
$page = 1; // int | Page number to fetch. This parameter is required to fetch data for specific page number
$type = "type_example"; // string | Search for receipts filtered by receipt type
$sales_order_id = "sales_order_id_example"; // string | Search for receipts filtered by sales order Id

try {
    $result = $apiInstance->getReceiptsUsingGET5($limit, $page, $type, $sales_order_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReceiptsApi->getReceiptsUsingGET5: ', $e->getMessage(), PHP_EOL;
}
?>

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
ReceiptsApi	getReceiptPdfUsingGET3	GET /v2/receipts/{receiptNumber}.pdf	Get the PDF document of a specific receipt by receipt number.
ReceiptsApi	getReceiptUsingGET5	GET /v2/receipts/{receiptNumber}	Get a specific receipt for the given receipt number as JSON object
ReceiptsApi	getReceiptsUsingGET5	GET /v2/receipts	Get all receipts as list of JSON objects

mehr-it / otto-receipts-api-client

Maintainers

Details