eBay

Description

This module allows interacting with eBay’s REST APIs to manage a seller’s operations. It covers the main APIs: Fulfillment API (orders, shipments, refunds), Inventory API (items, offers/listings, inventory CRUD), Browse API (public item search), Finances API (transactions, payouts), Notification API (event subscriptions and webhooks), and Account API (seller information and policies).

Authentication is performed via OAuth2 with access tokens managed by the credentials module. The module uses HTTP helper functions (ebayGet, ebayPost, ebayPut, ebayDelete) to build requests.

Configuration

Parameters

Parameter	Type	Required	Description
credentials_id	credentials	Yes	eBay credential (OAuth2)
operation	text	Yes	Operation: getOrders, getOrder, createShippingFulfillment, issueRefund, getInventoryItems, getInventoryItem, createOrUpdateInventoryItem, deleteInventoryItem, getOffers, browseSearch, browseGetItem, getTransactions, getPayouts, createDestination, createSubscription, getSubscriptions, getSellerInfo
order_id	text	Conditional	Order ID
sku	text	Conditional	Product SKU
limit	number	No	Result limit (varies by operation, max 200)
offset	number	No	Pagination offset
order_status	select	No	Order status: ACTIVE, COMPLETED, CANCELLED
query	text	Conditional	Search text (Browse API)
sort	select	No	Sorting: BEST_MATCH, PRICE, -PRICE, NEWLY_LISTED, ENDING_SOONEST
tracking_number	text	No	Shipment tracking number
shipping_carrier	select	No	Carrier: USPS, UPS, FEDEX, DHL, CORREOS, etc.
title	text	Conditional	Product title (for create/update item)
condition	select	No	Condition: NEW, LIKE_NEW, USED_EXCELLENT, USED_GOOD, etc.
price	text	Conditional	Product price
quantity	number	Conditional	Inventory quantity

Credentials

Service type: ebay. Stored in the servicecredentials table.

Configuration fields:

• clientId: eBay App ID
• clientSecret: eBay Cert ID
• refreshToken: OAuth2 refresh token
• marketplace_id: Marketplace ID (e.g.: EBAY_US, EBAY_ES)
• environment: sandbox or production

Output

{
  "nextModule": null,
  "data": [
    {
      "orderId": "12-12345-12345",
      "orderFulfillmentStatus": "NOT_STARTED",
      "pricingSummary": {
        "total": { "value": "49.99", "currency": "USD" }
      }
    }
  ],
  "_meta_": {
    "operation": "getOrders",
    "recordCount": 1,
    "executionTime": "320ms"
  }
}

Usage Example

Basic case - Get orders

{
  "credentials_id": 1,
  "operation": "getOrders",
  "limit": 50,
  "order_status": "ACTIVE"
}

API Used

• eBay Fulfillment API v1, Inventory API v1, Browse API v1
• eBay Finances API v1, Notification API v1, Account API v1
• Documentation: https://developer.ebay.com/docs

Notes

• The maximum result limit varies: 200 for orders/transactions, 100 for inventory
• The Browse API is public and does not require a user refresh token
• Creating/updating inventory items uses upsert by SKU (PUT operation)
• Refunds are processed through the Fulfillment API
• Notifications require first creating a destination endpoint and then the subscription
• The EBAY_US marketplace is the default value if not specified
• The request timeout is 30 seconds

Related Nodes

• Get Orders, Get Order, Mark Shipped, Issue Refund
• Get Inventory, Get Inventory Item, Create/Update Item, Delete Item
• Browse Items (Browse), Get Item (Browse), Active Listings
• Get Transactions, Get Payouts
• Create Notification Destination, Create Notification Subscription, Get Subscriptions
• Seller Info