Skip to main content

eBay OAuth2

The eBay OAuth2  plugin is used for all calls that are made to the new eBay APIs. These new APIs are based on the new authentication method OAuth2 instead of the old Auth-n-Auth method. Because the new authentication method is used for more and more essential tasks, you should install the eBay OAuth2 plugin while you set up eBay.

Download the eBay OAuth2 plugin

Download the following plugin:

You can download this and other plugins in the plentyMarketplace .

Installing the plugin eBay OAuth2

Installing plugins:

  1. Go to Plugins » Plugin set overview.

  2. Open () the plugin set you want to edit.
    → The plugin set opens.

  3. Click on Add new plugin.

  4. Select eBay OAuth2 from the plugin list.
    → Information about eBay OAuth2 is displayed.

  5. Select the version you want to install from the Select version drop-down list. The newest version is selected by default.

  6. To install the plugin, click on Install.
    → The plugin is installed.
    → After installation has finished, the plugin set opens.
    → Now you can configure the plugin. To do so, proceed as described below.

  7. Switch the plugin active ().

  8. Save () the plugin set.
    → If there’s a problem with saving the plugin set, click on View details to receive further information.

1. Activating and changing accounts

Go to Setup » Markets » eBay » OAuth2 to activate new accounts for eBay. You need your access data consisting of the user name and password. When changing your eBay access data, you have to update and synchronise your account in plentymarkets. plentymarkets allows you to manage several eBay accounts. Proceed as follows to add one or more accounts:

Activating an account:

  1. Go to Setup » Markets » eBay » OAuth2.

  2. Select Add sandbox account to activate an account for a test environment.
    or: Select Add production account if the new account is already productive.
    → You are forwarded to eBay and have to authenticate your data.
    Important: Pay attention to correctly copying upper and lower case spelling when you enter the account details.
    → The account is activated.
    → The account is shown in the Setup » Markets » eBay » OAuth2 menu.

When activating or updating an account, a token is generated. This token is valid for 18 months. There is no automatic warning when the validity of the token expires. The token also becomes invalid if you change your eBay account data.

Go to Setup » Markets » eBay » OAuth2 to rename, update or delete accounts. For example, you have to rename your account in plentymarkets when changing your eBay user name.

2. Assigning rights

Users with Backend access need rights for menu visibilities and REST-API to use the eBay OAuth2 plugin.

You can assign these rights in the Setup » Settings » User » Rights » User menu.

2.1. Assigning menu rights

You need to assign the following menu rights to users with Backend access:

  • Setup » Markets » eBay » OAuth2

Proceed as described below to assign these rights to users.

Assigning menu rights:

  1. Go to Setup » Settings » User » Rights » User.
    → A list of the user accounts is displayed.

  2. Click on the user that you want to give rights.
    Tip: Use the search function ().
    → The Rights view opens.

  3. In the column Menu visibility, expand the menu Setup » Markets » eBay.

  4. Activate the option OAuth2.

  5. Save () the settings.

2.2. Assigning REST rights

You need to assign the following REST rights to users with Backend access:

  • Markets » Credentials

    • Update

    • Display

    • Create

    • Delete

  • Markets » eBay » Marketplace

    • Display

Proceed as described below to assign these REST rights to users.

Assigning REST rights:

  1. Go to Setup » Settings » User » Rights » User.
    → A list of the user accounts is displayed.

  2. Click on the user that you want to give rights.
    Tip: Use the search function ().
    → The Rights view opens.

  3. In the column Authorisations, expand the menu item Markets.

  4. Activate the option Credentials.
    → All sub-rights are activated.

  5. In the same menu item Markets, expand the item eBay.

  6. Activate the option Marketplace.
    → The right Show is activated.

  7. Save () the settings.

3. License

This project is licensed under the GNU AFFERO GENERAL PUBLIC LICENSE. Find further information in the file LICENSE.md .

To top