cdma-numiscorner / ebay-sell-feed-api
<p>The <strong>Feed API</strong> lets sellers upload input files, download reports and files including their status, filter reports using URI parameters, and retrieve customer service metrics task details.</p>
Requires
- php: ^7.4 || ^8.0
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: >=6.2
- guzzlehttp/psr7: ^1.7 || ^2.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.5
- phpunit/phpunit: ^8.0 || ^9.0
This package is auto-updated.
Last update: 2024-10-27 21:01:03 UTC
README
The Feed API lets sellers upload input files, download reports and files including their status, filter reports using URI parameters, and retrieve customer service metrics task details.
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/GIT_USER_ID/GIT_REPO_ID.git" } ], "require": { "GIT_USER_ID/GIT_REPO_ID": "*@dev" } }
Then run composer install
Manual Installation
Download the files and include autoload.php
:
<?php require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');
Getting Started
Please follow the installation procedure and then run the following:
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure OAuth2 access token for authorization: api_auth $config = OpenAPI\EbaySellFeedApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); $apiInstance = new OpenAPI\EbaySellFeedApi\Api\CustomerServiceMetricTaskApi( // 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 ); $accept_language = 'accept_language_example'; // string | Use this header to specify the natural language in which the authenticated user desires the response. $create_service_metrics_task_request = new \OpenAPI\EbaySellFeedApi\Model\CreateServiceMetricsTaskRequest(); // \OpenAPI\EbaySellFeedApi\Model\CreateServiceMetricsTaskRequest | Request payload containing version, feedType, and optional filterCriteria. try { $apiInstance->createCustomerServiceMetricTask($accept_language, $create_service_metrics_task_request); } catch (Exception $e) { echo 'Exception when calling CustomerServiceMetricTaskApi->createCustomerServiceMetricTask: ', $e->getMessage(), PHP_EOL; }
API Endpoints
All URIs are relative to https://api.ebay.com/sell/feed/v1
Models
- CreateInventoryTaskRequest
- CreateOrderTaskRequest
- CreateServiceMetricsTaskRequest
- CreateTaskRequest
- CreateUserScheduleRequest
- CustomerServiceMetricTaskCollection
- CustomerServiceMetricsFilterCriteria
- DateRange
- Error
- ErrorParameter
- InventoryFilterCriteria
- InventoryTask
- InventoryTaskCollection
- OrderFilterCriteria
- OrderTask
- OrderTaskCollection
- ScheduleTemplateCollection
- ScheduleTemplateResponse
- ServiceMetricsTask
- SupportedConfiguration
- Task
- TaskCollection
- UpdateUserScheduleRequest
- UploadSummary
- UserScheduleCollection
- UserScheduleResponse
Authorization
api_auth
- Type:
OAuth
- Flow:
accessCode
- Authorization URL:
https://auth.ebay.com/oauth2/authorize
- Scopes:
- https://api.ebay.com/oauth/api_scope/sell.fulfillment: View and manage your order fulfillments
- https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly: This scope would allow signed in user to read catalog data.
- https://api.ebay.com/oauth/api_scope/sell.inventory: View and manage your inventory and offers
- https://api.ebay.com/oauth/api_scope/sell.marketing: View and manage your eBay marketing activities, such as ad campaigns and listing promotions
- https://api.ebay.com/oauth/api_scope/sell.analytics.readonly: View your selling analytics data, such as performance reports
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:
v1.3.1
- Build package:
org.openapitools.codegen.languages.PhpClientCodegen