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/nogrod/ebay-sell-feed-php-sdk.git"
    }
  ],
  "require": {
    "nogrod/ebay-sell-feed-php-sdk": "*@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 = eBay\Sell\Feed\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new eBay\Sell\Feed\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. For example, <code>en_US</code> for English or <code>de_DE</code> for German.
$content_type = 'content_type_example'; // string | This header indicates the format of the request body provided by the client. It's value should be set to <b>application/json</b>. <br><br> For more information, refer to <a href=\"/api-docs/static/rest-request-components.html#HTTP\" target=\"_blank \">HTTP request headers</a>.
$create_service_metrics_task_request = new \eBay\Sell\Feed\Model\CreateServiceMetricsTaskRequest(); // \eBay\Sell\Feed\Model\CreateServiceMetricsTaskRequest | Request payload containing version, feedType, and optional filterCriteria.

try {
    $apiInstance->createCustomerServiceMetricTask($accept_language, $content_type, $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

Class	Method	HTTP request
CustomerServiceMetricTaskApi	createCustomerServiceMetricTask	POST /customer_service_metric_task
CustomerServiceMetricTaskApi	getCustomerServiceMetricTask	GET /customer_service_metric_task/{task_id}
CustomerServiceMetricTaskApi	getCustomerServiceMetricTasks	GET /customer_service_metric_task
InventoryTaskApi	createInventoryTask	POST /inventory_task
InventoryTaskApi	getInventoryTask	GET /inventory_task/{task_id}
InventoryTaskApi	getInventoryTasks	GET /inventory_task
OrderTaskApi	createOrderTask	POST /order_task
OrderTaskApi	getOrderTask	GET /order_task/{task_id}
OrderTaskApi	getOrderTasks	GET /order_task
ScheduleApi	createSchedule	POST /schedule
ScheduleApi	deleteSchedule	DELETE /schedule/{schedule_id}
ScheduleApi	getLatestResultFile	GET /schedule/{schedule_id}/download_result_file
ScheduleApi	getSchedule	GET /schedule/{schedule_id}
ScheduleApi	getScheduleTemplate	GET /schedule_template/{schedule_template_id}
ScheduleApi	getScheduleTemplates	GET /schedule_template
ScheduleApi	getSchedules	GET /schedule
ScheduleApi	updateSchedule	PUT /schedule/{schedule_id}
TaskApi	createTask	POST /task
TaskApi	getInputFile	GET /task/{task_id}/download_input_file
TaskApi	getResultFile	GET /task/{task_id}/download_result_file
TaskApi	getTask	GET /task/{task_id}
TaskApi	getTasks	GET /task
TaskApi	uploadFile	POST /task/{task_id}/upload_file

Models

Authorization

Authentication schemes defined for the API:

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
- Package version: 0.0.1
Build package: org.openapitools.codegen.languages.PhpClientCodegen

nogrod / ebay-sell-feed-php-sdk

Maintainers

Details