https://github.com/michabbb/sdk-ebay-rest-postorder
A PHP SDK for the eBay Post-Order API
https://github.com/michabbb/sdk-ebay-rest-postorder
api ebay php post-order rest
Last synced: 3 months ago
JSON representation
A PHP SDK for the eBay Post-Order API
- Host: GitHub
- URL: https://github.com/michabbb/sdk-ebay-rest-postorder
- Owner: michabbb
- Created: 2024-01-18T13:20:33.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-01-18T19:14:02.000Z (over 1 year ago)
- Last Synced: 2025-02-05T02:26:11.624Z (3 months ago)
- Topics: api, ebay, php, post-order, rest
- Language: PHP
- Homepage: https://developer.ebay.com/devzone/post-order/index.html
- Size: 51.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# sdk-ebay-rest-postorder
API for searching eBay order cancellations.
## Created with
```bash
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](https://getcomposer.org/), add the following to `composer.json`:
```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`
OR
`composer require macropage/sdk-ebay-rest-postorder`
### Manual Installation
Download the files and include `autoload.php`:
```php
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**](docs/Api/CancellationSearchApi.md#searchcancellations) | **GET** /cancellation/search | Search for order cancellations
## Models
- [Amount](docs/Model/Amount.md)
- [CancelSummary](docs/Model/CancelSummary.md)
- [DateTime](docs/Model/DateTime.md)
- [FindCancelResponse](docs/Model/FindCancelResponse.md)
- [LineItem](docs/Model/LineItem.md)
- [PaginationOutput](docs/Model/PaginationOutput.md)
- [PayoutRecoupInfo](docs/Model/PayoutRecoupInfo.md)
## 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:
```bash
composer install
vendor/bin/phpunit
```
## Author
## About this package
This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: `1.0.0`
- Package version: `1.9.0`
- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`