macropage/sdk-ebay-rest-account

The <b>Account API</b> 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. <br><br>For details

dev-master 2019-03-04 00:27 UTC

This package is auto-updated.

Last update: 2024-03-23 01:59:33 UTC


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 restrictions and availability of the methods in this API, see <a href="/api-docs/sell/account/overview.html#acct-restrictions">API restrictions.

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

  • API version: v1.3.0
  • Package version: 2.3.2
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

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

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

Then run composer install

Manual Installation

Download the files and include autoload.php:

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

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

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 = macropage\SDKs\ebay\rest\account\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new macropage\SDKs\ebay\rest\account\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
);
$fulfillmentPolicyRequest = new \macropage\SDKs\ebay\rest\account\Model\FulfillmentPolicyRequest(); // \macropage\SDKs\ebay\rest\account\Model\FulfillmentPolicyRequest | Request to create a seller account fulfillment policy.

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

?>

Documentation for API Endpoints

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

Class Method HTTP request Description
FulfillmentPolicyApi createFulfillmentPolicy POST /fulfillment_policy/
FulfillmentPolicyApi deleteFulfillmentPolicy DELETE /fulfillment_policy/{fulfillmentPolicyId}
FulfillmentPolicyApi getFulfillmentPolicies GET /fulfillment_policy/
FulfillmentPolicyApi getFulfillmentPolicy GET /fulfillment_policy/{fulfillmentPolicyId}
FulfillmentPolicyApi getFulfillmentPolicyByName GET /fulfillment_policy/get_by_policy_name
FulfillmentPolicyApi updateFulfillmentPolicy PUT /fulfillment_policy/{fulfillmentPolicyId}
PaymentPolicyApi createPaymentPolicy POST /payment_policy/
PaymentPolicyApi deletePaymentPolicy DELETE /payment_policy/{payment_policy_id}
PaymentPolicyApi getPaymentPolicies GET /payment_policy/
PaymentPolicyApi getPaymentPolicy GET /payment_policy/{payment_policy_id}
PaymentPolicyApi getPaymentPolicyByName GET /payment_policy/get_by_policy_name
PaymentPolicyApi updatePaymentPolicy PUT /payment_policy/{payment_policy_id}
PaymentsProgramApi getPaymentsProgram GET /payments_program/{marketplace_id}/{payments_program_type}
PrivilegeApi getPrivileges GET /privilege/
ProgramApi getOptedInPrograms GET /program/get_opted_in_programs
ProgramApi optInToProgram POST /program/opt_in
ProgramApi optOutOfProgram POST /program/opt_out
RateTableApi getRateTables GET /rate_table/
ReturnPolicyApi createReturnPolicy POST /return_policy/
ReturnPolicyApi deleteReturnPolicy DELETE /return_policy/{return_policy_id}
ReturnPolicyApi getReturnPolicies GET /return_policy/
ReturnPolicyApi getReturnPolicy GET /return_policy/{return_policy_id}
ReturnPolicyApi getReturnPolicyByName GET /return_policy/get_by_policy_name
ReturnPolicyApi updateReturnPolicy PUT /return_policy/{return_policy_id}
SalesTaxApi createOrReplaceSalesTax PUT /sales_tax/{countryCode}/{jurisdictionId}
SalesTaxApi deleteSalesTax DELETE /sales_tax/{countryCode}/{jurisdictionId}
SalesTaxApi getSalesTax GET /sales_tax/{countryCode}/{jurisdictionId}
SalesTaxApi getSalesTaxes GET /sales_tax/

Documentation For Models

Documentation For Authorization

api_auth

Author