README

The Account API gives sellers the ability to configure their eBay seller accounts, including the seller's policies (the Fulfillment Policy, Payment Policy, and Return Policy), opt in and out of eBay seller programs, configure sales tax tables, and get account information.

For details on the availability of the methods in this API, see <a href="/api-docs/sell/account/overview.html#requirements">Account API requirements and restrictions.

Installation & Usage

Requirements

PHP 7.2 and later.

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/cdma-numiscorner/EbayAccountApi.git"
    }
  ],
  "require": {
    "cdma-numiscorner/EbayAccountApi": "*@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\EbayAccountClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\EbayAccountClient\Api\FulfillmentPolicyApi(
    // 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
);
$fulfillment_policy_request = new \OpenAPI\EbayAccountClient\Model\FulfillmentPolicyRequest(); // \OpenAPI\EbayAccountClient\Model\FulfillmentPolicyRequest | Request to create a seller account fulfillment policy.

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

API Endpoints

All URIs are relative to https://api.ebay.com/sell/account/v1

Models

• Amount
• CategoryType
• Deposit
• Error
• ErrorParameter
• FulfillmentPolicy
• FulfillmentPolicyRequest
• FulfillmentPolicyResponse
• InternationalReturnOverrideType
• KycCheck
• KycResponse
• PaymentMethod
• PaymentPolicy
• PaymentPolicyRequest
• PaymentPolicyResponse
• PaymentsProgramOnboardingResponse
• PaymentsProgramOnboardingSteps
• PaymentsProgramResponse
• Program
• Programs
• RateTable
• RateTableResponse
• RecipientAccountReference
• Region
• RegionSet
• ReturnPolicy
• ReturnPolicyRequest
• ReturnPolicyResponse
• SalesTax
• SalesTaxBase
• SalesTaxes
• SellingLimit
• SellingPrivileges
• SetFulfillmentPolicyResponse
• SetPaymentPolicyResponse
• SetReturnPolicyResponse
• ShippingOption
• ShippingService
• TimeDuration

Authorization

api_auth

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://auth.ebay.com/oauth2/authorize
• Scopes:
  • https://api.ebay.com/oauth/api_scope/sell.account.readonly: View your account settings
  • https://api.ebay.com/oauth/api_scope/sell.account: View and manage your account settings

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