{"id":19325209,"url":"https://github.com/sapientpro/ebay-account-sdk-php","last_synced_at":"2025-10-06T02:59:34.947Z","repository":{"id":176823003,"uuid":"635757713","full_name":"sapientpro/ebay-account-sdk-php","owner":"sapientpro","description":"PHP SDK for Ebay Account API","archived":false,"fork":false,"pushed_at":"2023-06-28T08:10:51.000Z","size":461,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-09-25T13:35:46.939Z","etag":null,"topics":["ebay-api","ebay-sdk","php","php8"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sapientpro.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-03T11:52:04.000Z","updated_at":"2023-06-28T10:21:14.000Z","dependencies_parsed_at":"2023-06-28T12:00:47.670Z","dependency_job_id":null,"html_url":"https://github.com/sapientpro/ebay-account-sdk-php","commit_stats":null,"previous_names":["sapientpro/ebay-account-sdk-php"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/sapientpro/ebay-account-sdk-php","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sapientpro%2Febay-account-sdk-php","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sapientpro%2Febay-account-sdk-php/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sapientpro%2Febay-account-sdk-php/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sapientpro%2Febay-account-sdk-php/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sapientpro","download_url":"https://codeload.github.com/sapientpro/ebay-account-sdk-php/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sapientpro%2Febay-account-sdk-php/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278551509,"owners_count":26005389,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-06T02:00:05.630Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ebay-api","ebay-sdk","php","php8"],"created_at":"2024-11-10T02:09:15.821Z","updated_at":"2025-10-06T02:59:34.927Z","avatar_url":"https://github.com/sapientpro.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ebay Account API SDK for PHP\nThe \u003cb\u003eAccount API\u003c/b\u003e gives sellers the ability to configure their eBay seller accounts, including the seller's policies (eBay business policies and seller-defined custom policies), opt in and out of eBay seller programs, configure sales tax tables, and get account information.  \u003cbr/\u003e\u003cbr/\u003eFor details on the availability of the methods in this API, see \u003ca href=\\\"/api-docs/sell/account/overview.html#requirements\\\"\u003eAccount API requirements and restrictions\u003c/a\u003e.\n\nThis PHP package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:\n\n- API version: v1.9.0\n- Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen\n\n## Requirements\n\n- PHP 8.1 or later\n- ext-json and ext-curl extensions enabled\n\n## Installation \u0026 Usage\n\nInstall the package using composer:\n\n```sh\ncomposer require sapientpro/ebay-account-sdk-php\n```\n\n## Example usage\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```php\n\u003c?php\nuse SapientPro\\EbayAccountSDK\\Configuration;\nuse SapientPro\\EbayAccountSDK\\Api\\CustomPolicyApi;\nuse SapientPro\\EbayAccountSDK\\Models\\CustomPolicyCreateRequest;\nuse SapientPro\\EbayAccountSDK\\Enums\\MarketplaceIdEnum;\nuse SapientPro\\EbayAccountSDK\\Enums\\CustomPolicyTypeEnum;\n\n// Configure OAuth2 access token for authorization: api_auth\n$config = Configuration::getDefaultConfiguration()-\u003esetAccessToken('YOUR_ACCESS_TOKEN');\n\n$apiInstance = new CustomPolicyApi(\n    // If you want use custom http client, pass your client which implements `GuzzleHttp\\ClientInterface`.\n    // This is optional, `GuzzleHttp\\Client` will be used as default.\n    ebayClient:  GuzzleHttp\\Client(),\n    config: $config\n);\n\n// you can create and fill a Model class that implements EbayModelInterface using fromArray() method\n// exception will be thrown if a property does not exist in the model class\n$body = CustomPolicyCreateRequest::fromArray([\n'description' =\u003e 'description_example',\n'name' =\u003e 'name_example',\n'label' =\u003e 'label_example',\n'custom_policy_type_enum' =\u003e CustomPolicyTypeEnum::PRODUCT_COMPLIANCE,\n]);\n\ntry {\n    $result = $apiInstance-\u003ecreateCustomPolicy($body, MarketplaceIdEnum::EBAY_US);\n    print_r($result);\n// there is also a custom ApiException for non 2xx responses\n} catch (Exception $e) {\n    echo 'Exception when calling CustomPolicyApi-\u003ecreateCustomPolicy: ', $e-\u003egetMessage(), PHP_EOL;\n}\n```\n\n## Creating Models\n\nSome SDK methods require `$body` variable as a parameter. It refers to a Model class that implements EbayModelInterface.\nThere are several ways to create a Model class:\n\n### fromArray()\nYou can create a Model class using fromArray() method.\nIt will throw an exception if a property does not exist in the model class.\n\nIf the model has a property of type that implements EbayModelInterface, you must create an instance of that class using fromArray() method.\nIn this example, the property `price` is of type `ConvertedAmount` that also implements EbayModelInterface.\n\n```php\nItem::fromArray([\n    'price' =\u003e ConvertedAmount::fromArray([\n        'value' =\u003e '6.90',\n        'currency' =\u003e CurrencyCodeEnum::USD\n    )]\n])\n```\n### fromPlainArray()\n\nIt is also possible to create a Model from plain associative array.\nThe previous example can be rewritten as follows:\n\n```php\nItem::fromPlainArray([\n    'price' =\u003e [\n        'value' =\u003e '6.90',\n        'currency' =\u003e CurrencyCodeEnum::USD\n    ]\n])\n```\n\n### fromJson()\n\nIt is also possible to create a Model from JSON string.\n\n```php\nItem::fromJson('{\"price\": {\"value\": \"6.90\", \"currency\": \"USD\"}}')\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.ebay.com/sell/account/v1*\n\n| Class                  | Method                                                                                        | HTTP request                                                                  | Description |\n|------------------------|-----------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|-------------|\n| *CustomPolicyApi*      | [**createCustomPolicy**](docs/Api/CustomPolicyApi.md#createcustompolicy)                      | **POST** /custom_policy/                                                      |             |\n| *CustomPolicyApi*      | [**getCustomPolicies**](docs/Api/CustomPolicyApi.md#getcustompolicies)                        | **GET** /custom_policy/                                                       |             |\n| *CustomPolicyApi*      | [**getCustomPolicy**](docs/Api/CustomPolicyApi.md#getcustompolicy)                            | **GET** /custom_policy/{custom_policy_id}                                     |             |\n| *CustomPolicyApi*      | [**updateCustomPolicy**](docs/Api/CustomPolicyApi.md#updatecustompolicy)                      | **PUT** /custom_policy/{custom_policy_id}                                     |             |\n| *FulfillmentPolicyApi* | [**createFulfillmentPolicy**](docs/Api/FulfillmentPolicyApi.md#createfulfillmentpolicy)       | **POST** /fulfillment_policy/                                                 |             |\n| *FulfillmentPolicyApi* | [**deleteFulfillmentPolicy**](docs/Api/FulfillmentPolicyApi.md#deletefulfillmentpolicy)       | **DELETE** /fulfillment_policy/{fulfillmentPolicyId}                          |             |\n| *FulfillmentPolicyApi* | [**getFulfillmentPolicies**](docs/Api/FulfillmentPolicyApi.md#getfulfillmentpolicies)         | **GET** /fulfillment_policy                                                   |             |\n| *FulfillmentPolicyApi* | [**getFulfillmentPolicy**](docs/Api/FulfillmentPolicyApi.md#getfulfillmentpolicy)             | **GET** /fulfillment_policy/{fulfillmentPolicyId}                             |             |\n| *FulfillmentPolicyApi* | [**getFulfillmentPolicyByName**](docs/Api/FulfillmentPolicyApi.md#getfulfillmentpolicybyname) | **GET** /fulfillment_policy/get_by_policy_name                                |             |\n| *FulfillmentPolicyApi* | [**updateFulfillmentPolicy**](docs/Api/FulfillmentPolicyApi.md#updatefulfillmentpolicy)       | **PUT** /fulfillment_policy/{fulfillmentPolicyId}                             |             |\n| *KycApi*               | [**getKYC**](docs/Api/KycApi.md#getkyc)                                                       | **GET** /kyc                                                                  |             |\n| *OnboardingApi*        | [**getPaymentsProgramOnboarding**](docs/Api/OnboardingApi.md#getpaymentsprogramonboarding)    | **GET** /payments_program/{marketplace_id}/{payments_program_type}/onboarding |             |\n| *PaymentPolicyApi*     | [**createPaymentPolicy**](docs/Api/PaymentPolicyApi.md#createpaymentpolicy)                   | **POST** /payment_policy                                                      |             |\n| *PaymentPolicyApi*     | [**deletePaymentPolicy**](docs/Api/PaymentPolicyApi.md#deletepaymentpolicy)                   | **DELETE** /payment_policy/{payment_policy_id}                                |             |\n| *PaymentPolicyApi*     | [**getPaymentPolicies**](docs/Api/PaymentPolicyApi.md#getpaymentpolicies)                     | **GET** /payment_policy                                                       |             |\n| *PaymentPolicyApi*     | [**getPaymentPolicy**](docs/Api/PaymentPolicyApi.md#getpaymentpolicy)                         | **GET** /payment_policy/{payment_policy_id}                                   |             |\n| *PaymentPolicyApi*     | [**getPaymentPolicyByName**](docs/Api/PaymentPolicyApi.md#getpaymentpolicybyname)             | **GET** /payment_policy/get_by_policy_name                                    |             |\n| *PaymentPolicyApi*     | [**updatePaymentPolicy**](docs/Api/PaymentPolicyApi.md#updatepaymentpolicy)                   | **PUT** /payment_policy/{payment_policy_id}                                   |             |\n| *PaymentsProgramApi*   | [**getPaymentsProgram**](docs/Api/PaymentsProgramApi.md#getpaymentsprogram)                   | **GET** /payments_program/{marketplace_id}/{payments_program_type}            |             |\n| *PrivilegeApi*         | [**getPrivileges**](docs/Api/PrivilegeApi.md#getprivileges)                                   | **GET** /privilege                                                            |             |\n| *ProgramApi*           | [**getOptedInPrograms**](docs/Api/ProgramApi.md#getoptedinprograms)                           | **GET** /program/get_opted_in_programs                                        |             |\n| *ProgramApi*           | [**optInToProgram**](docs/Api/ProgramApi.md#optintoprogram)                                   | **POST** /program/opt_in                                                      |             |\n| *ProgramApi*           | [**optOutOfProgram**](docs/Api/ProgramApi.md#optoutofprogram)                                 | **POST** /program/opt_out                                                     |             |\n| *RateTableApi*         | [**getRateTables**](docs/Api/RateTableApi.md#getratetables)                                   | **GET** /rate_table                                                           |             |\n| *ReturnPolicyApi*      | [**createReturnPolicy**](docs/Api/ReturnPolicyApi.md#createreturnpolicy)                      | **POST** /return_policy                                                       |             |\n| *ReturnPolicyApi*      | [**deleteReturnPolicy**](docs/Api/ReturnPolicyApi.md#deletereturnpolicy)                      | **DELETE** /return_policy/{return_policy_id}                                  |             |\n| *ReturnPolicyApi*      | [**getReturnPolicies**](docs/Api/ReturnPolicyApi.md#getreturnpolicies)                        | **GET** /return_policy                                                        |             |\n| *ReturnPolicyApi*      | [**getReturnPolicy**](docs/Api/ReturnPolicyApi.md#getreturnpolicy)                            | **GET** /return_policy/{return_policy_id}                                     |             |\n| *ReturnPolicyApi*      | [**getReturnPolicyByName**](docs/Api/ReturnPolicyApi.md#getreturnpolicybyname)                | **GET** /return_policy/get_by_policy_name                                     |             |\n| *ReturnPolicyApi*      | [**updateReturnPolicy**](docs/Api/ReturnPolicyApi.md#updatereturnpolicy)                      | **PUT** /return_policy/{return_policy_id}                                     |             |\n| *SalesTaxApi*          | [**createOrReplaceSalesTax**](docs/Api/SalesTaxApi.md#createorreplacesalestax)                | **PUT** /sales_tax/{countryCode}/{jurisdictionId}                             |             |\n| *SalesTaxApi*          | [**deleteSalesTax**](docs/Api/SalesTaxApi.md#deletesalestax)                                  | **DELETE** /sales_tax/{countryCode}/{jurisdictionId}                          |             |\n| *SalesTaxApi*          | [**getSalesTax**](docs/Api/SalesTaxApi.md#getsalestax)                                        | **GET** /sales_tax/{countryCode}/{jurisdictionId}                             |             |\n| *SalesTaxApi*          | [**getSalesTaxes**](docs/Api/SalesTaxApi.md#getsalestaxes)                                    | **GET** /sales_tax                                                            |             |\n\n## Documentation For Models\n\n - [Amount](docs/Model/Amount.md)\n - [CategoryType](docs/Model/CategoryType.md)\n - [CompactCustomPolicyResponse](docs/Model/CompactCustomPolicyResponse.md)\n - [CustomPolicy](docs/Model/CustomPolicy.md)\n - [CustomPolicyCreateRequest](docs/Model/CustomPolicyCreateRequest.md)\n - [CustomPolicyRequest](docs/Model/CustomPolicyRequest.md)\n - [CustomPolicyResponse](docs/Model/CustomPolicyResponse.md)\n - [Deposit](docs/Model/Deposit.md)\n - [Error](docs/Model/Error.md)\n - [ErrorParameter](docs/Model/ErrorParameter.md)\n - [FulfillmentPolicy](docs/Model/FulfillmentPolicy.md)\n - [FulfillmentPolicyRequest](docs/Model/FulfillmentPolicyRequest.md)\n - [FulfillmentPolicyResponse](docs/Model/FulfillmentPolicyResponse.md)\n - [InternationalReturnOverrideType](docs/Model/InternationalReturnOverrideType.md)\n - [KycCheck](docs/Model/KycCheck.md)\n - [KycResponse](docs/Model/KycResponse.md)\n - [PaymentMethod](docs/Model/PaymentMethod.md)\n - [PaymentPolicy](docs/Model/PaymentPolicy.md)\n - [PaymentPolicyRequest](docs/Model/PaymentPolicyRequest.md)\n - [PaymentPolicyResponse](docs/Model/PaymentPolicyResponse.md)\n - [PaymentsProgramOnboardingResponse](docs/Model/PaymentsProgramOnboardingResponse.md)\n - [PaymentsProgramOnboardingSteps](docs/Model/PaymentsProgramOnboardingSteps.md)\n - [PaymentsProgramResponse](docs/Model/PaymentsProgramResponse.md)\n - [Program](docs/Model/Program.md)\n - [Programs](docs/Model/Programs.md)\n - [RateTable](docs/Model/RateTable.md)\n - [RateTableResponse](docs/Model/RateTableResponse.md)\n - [RecipientAccountReference](docs/Model/RecipientAccountReference.md)\n - [Region](docs/Model/Region.md)\n - [RegionSet](docs/Model/RegionSet.md)\n - [ReturnPolicy](docs/Model/ReturnPolicy.md)\n - [ReturnPolicyRequest](docs/Model/ReturnPolicyRequest.md)\n - [ReturnPolicyResponse](docs/Model/ReturnPolicyResponse.md)\n - [SalesTax](docs/Model/SalesTax.md)\n - [SalesTaxBase](docs/Model/SalesTaxBase.md)\n - [SalesTaxes](docs/Model/SalesTaxes.md)\n - [SellingLimit](docs/Model/SellingLimit.md)\n - [SellingPrivileges](docs/Model/SellingPrivileges.md)\n - [SetFulfillmentPolicyResponse](docs/Model/SetFulfillmentPolicyResponse.md)\n - [SetPaymentPolicyResponse](docs/Model/SetPaymentPolicyResponse.md)\n - [SetReturnPolicyResponse](docs/Model/SetReturnPolicyResponse.md)\n - [ShippingOption](docs/Model/ShippingOption.md)\n - [ShippingService](docs/Model/ShippingService.md)\n - [TimeDuration](docs/Model/TimeDuration.md)\n\n## Documentation For Authorization\n\n\n## api_auth\n\n- **Type**: OAuth\n- **Flow**: accessCode\n- **Authorization URL**: https://auth.ebay.com/oauth2/authorize\n- **Scopes**: \n - **https://api.ebay.com/oauth/api_scope/sell.account.readonly**: View your account settings\n - **https://api.ebay.com/oauth/api_scope/sell.account**: View and manage your account settings\n\n\n## Author\n\n[Swagger Codegen team](https://github.com/swagger-api/swagger-codegen)\nand [SapientPro](https://sapient.pro/)\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsapientpro%2Febay-account-sdk-php","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsapientpro%2Febay-account-sdk-php","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsapientpro%2Febay-account-sdk-php/lists"}