eBay Utility

A TypeScript utility library for eBay API operations including inventory management and listings

Installation

pnpm install @isoftdata/ebay-utility

Features

• eBay API Integration: Complete TypeScript interfaces for eBay's Inventory API
• Inventory Management: Push and sync inventory items to eBay
• Policy Management: Handle fulfillment, payment, and return policies
• Offer Management: Create and manage eBay offers
• Location Management: Manage and reconcile inventory locations
• Type Safety: Full TypeScript support with comprehensive type definitions

Quick Start

import { EbayAdapter, TokenManager, syncInventoryToEbay } from '@isoftdata/ebay-utility'

// Initialize the eBay adapter
const tokenManager = new TokenManager(/* your config */)
const ebayAdapter = new EbayAdapter(tokenManager)

// Sync inventory to eBay
const result = await syncInventoryToEbay({
	ebayAdapter,
	inventoryItem: {
		// your inventory item data
	},
	sku: 'your-sku',
})

Main Exports

Adapters

• EbayAdapter - Main adapter for eBay API operations
• WebEbayAdapter - Web-friendly eBay adapter
• ItrackAdapter - Adapter for iTrack integration

Core Functions

• syncInventoryToEbay - Sync inventory items to eBay
• syncEbayInventoryAndOffer - Sync inventory and offer together
• syncImageToEbay - Sync images to eBay
• syncInventoryLocationToEbay - Sync a single inventory location to eBay
• syncInventoryLocationsToEbay - Sync multiple inventory locations to eBay
• syncFulfillmentPolicies - Sync fulfillment policies from eBay
• syncPaymentPolicies - Sync payment policies from eBay
• syncReturnPolicies - Sync return policies from eBay

Types and Interfaces

• InventoryItem - eBay inventory item interface
• Offer - eBay offer interface
• FulfillmentPolicy, PaymentPolicy, ReturnPolicy - Policy interfaces
• InventoryLocation, InventoryLocationFull, EbayInventoryLocationDTO - Location types
• MarketplaceEnum, ConditionEnum, ListingDurationEnum - Enums for eBay values

Infrastructure

• TokenManager - Handles eBay API authentication
• MysqlDatastore - MySQL datastore implementation
• EbayOAuthManager - Manages eBay OAuth tokens

Requirements

• Node.js 22+
• TypeScript 5+

Dependencies

This package includes the following key dependencies:

• mysql2 - Database connectivity
• validator - Data validation
• yup & zod - Schema validation
• xml2js - XML parsing for eBay responses

Testing

npm test

Tests run directly from TypeScript source via tsx — no build step required.

License

ISC

Contributing

Please ensure all TypeScript code follows the project's coding standards and includes appropriate type definitions.