About the Ebay category

Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.

Extra information

Connector package documentation:
System documentation:

Setting up HTTP Client eBay

Steps

  1. In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select eBay HTTP Client as the prototype of the HTTP Client.
  2. Fill in the Base URI, Environment (either sandbox, or production), Authentication type, Client ID, Client Secret, and scopes (optional).
  3. Press “Grant Access to eBay Center”

Subscribing to Entities from eBay

Steps

  1. Go to Connections → Incoming, create a new incoming configuration, and select eBay Subscriber as the subscriber.
  2. Select the entity you want to subscribe from eBay.
  3. Add any request parameters needed to subscribe to the entity (optional).
  4. You can optionally add a transformer to transform the request parameters into something you need.

Select the Ebay HTTP Client to use. General Concept

We follow Ebay documentation on building this connector so you can easily use the connector based on Ebay API Reference.

Entity
It’s the entity you want to subscribe from Ebay. Please refer to the entities in Management APIs from Ebay API Reference page.

Request Parameters
These are the parameters you can provide to get the needed entity based on Ebay API Reference. Please look at the example below on how to fill Request Parameters field when subscribing Single Request entity.

That’s why we need to define custom_policy_id property inside path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field.

/custom_policy/1

Input Transformer

Any transformer’s set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity.

HTTP Client
It’s the HTTP Client configuration or prototype you will use to access Ebay.

Publishing Entity to Ebay

Steps

  1. Go to Connections → Outgoing, create a new outgoing configuration and select Ebay Publisher as the publisher.
  2. Select the action that you want the publisher to do with the data.
  3. Select the Ebay entity you want the data to be published to.
  4. Select the HTTP Client to use.

General Concept

Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration).

Action

Currently we support Create (HTTP POST method), Put (HTTP PUT method), and Delete (HTTP DELETE method).

Entity

We support publishing to most Ebay endpoints but not with publishing binary files at the moment. Please refer to the entities in Management APIs from Ebay API Reference page. Based on the documentation, some endpoints may need one or more path parameters.

For endpoints that require object as the request payload, please look at the example below. For example, we want to Create a Custom Policy. Please select “Create” as the action and “createCustomPolicy” as the entity of the publisher.

You can put the payload you want to send to Ebay into payload property in the data. Here is an example of the Possible Response after Creation.

Alumio will send an API request to Ebay with URL /custom_policy

HTTP Client

It’s the HTTP Client configuration or prototype you will use to access Ebay.