README

Interface for the partner to get receipts information

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

API version: 1.0.0
Package version: v1.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/gisevevokoru/ezze-siftuz-receipts-v1.git"
    }
  ],
  "require": {
    "gisevevokoru/ezze-siftuz-receipts-v1": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-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: JWT
$config = EzzeSiftuz\ReceiptsV1\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = EzzeSiftuz\ReceiptsV1\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new EzzeSiftuz\ReceiptsV1\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(),
    $config
);
$receipt_number = "receipt_number_example"; // string | ReceiptNumber

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

// Configure API key authorization: JWT
$config = EzzeSiftuz\ReceiptsV1\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = EzzeSiftuz\ReceiptsV1\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new EzzeSiftuz\ReceiptsV1\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(),
    $config
);
$receipt_number = "receipt_number_example"; // string | ReceiptNumber

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

// Configure API key authorization: JWT
$config = EzzeSiftuz\ReceiptsV1\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = EzzeSiftuz\ReceiptsV1\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new EzzeSiftuz\ReceiptsV1\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(),
    $config
);
$customer_id = "customer_id_example"; // string | Search for receipts filtered by customer Id
$limit = 56; // int | Page size to limit the number of receipts returned in the response
$page = 56; // int | Page number to fetch. This parameter is required to fetch data for specific page number
$sales_order_id = "sales_order_id_example"; // string | Search for receipts filtered by sales order Id
$type = "type_example"; // string | Search for receipts filtered by receipt type

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

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
ReceiptsApi	getReceiptPdfUsingGET	GET /v1/receipts/{receiptNumber}/pdf	Get the PDF document of a specific receipt by receipt number. It's valid only for purchase receipts for now.
ReceiptsApi	getReceiptUsingGET	GET /v1/receipts/{receiptNumber}	Get a specific receipt for the given receipt number as JSON object
ReceiptsApi	getReceiptsUsingGET	GET /v1/receipts	Get all receipts as list of JSON objects

gisevevokoru / ezze-siftuz-receipts-v1

Maintainers

Details