README

API for searching eBay order cancellations.

Created with

docker run --rm -v ${PWD}:/app openapitools/openapi-generator-cli:v7.2.0 generate -i /app/ebay_post_order_api_openpai.json -g php -o /app  --config /app/openapi-config.php.ebay.postorder.json

Because eBay does not provide an OpenAPI Specification File, I created one for myself: ebay_post_order_api_openpai.json
So if you need more endpoints, feel free to provide an PR with an updated OpenAPI Specification File.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/macropage/sdk-ebay-rest-postorder.git"
    }
  ],
  "require": {
    "macropage/sdk-ebay-rest-postorder": "*@dev"
  }
}

Then run composer install

composer require macropage/sdk-ebay-rest-postorder

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/sdk-ebay-rest-postorder/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// @see https://developer.ebay.com/devzone/post-order/concepts/MakingACall.html
$config = new \macropage\SDKs\ebay\rest\postorder\Configuration();
$config->setAccessToken('TOKEN xxxxxxxxxxxxxx');
$config->setMarketplaceId('EBAY_DE');

$apiInstance = new macropage\SDKs\ebay\rest\postorder\Api\CancellationSearchApi(
    // 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
);
$cancelId = 'cancelId_example'; // string
$creationDateRangeFrom = 'creationDateRangeFrom_example'; // string
$creationDateRangeTo = 'creationDateRangeTo_example'; // string
$itemId = 'itemId_example'; // string
$legacyOrderId = 'legacyOrderId_example'; // string
$limit = 'limit_example'; // string
$offset = 'offset_example'; // string
$role = 'role_example'; // string
$sort = 'sort_example'; // string
$transactionId = 'transactionId_example'; // string

try {
    $result = $apiInstance->searchCancellations($cancelId, $creationDateRangeFrom, $creationDateRangeTo, $itemId, $legacyOrderId, $limit, $offset, $role, $sort, $transactionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CancellationSearchApi->searchCancellations: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.ebay.com/post-order/v2

Class	Method	HTTP request	Description
CancellationSearchApi	searchCancellations	GET /cancellation/search	Search for order cancellations

Models

Authorization

Authentication schemes defined for the API:

ApiKeyAuth

Type: API key
API key parameter name: Authorization
Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 1.0.0
- Package version: 1.9.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

macropage / sdk-ebay-rest-postorder

Maintainers

Details