Ebay Bundle Laravel Package

Getting Started

Minimal Setup

1. Installation

   composer require d4m/ebay-bundle
   

   Register the bundle in config/bundles.php (Symfony 4.4+):

   return [
       // ...
       D4m\EbayBundle\D4mEbayBundle::class => ['all' => true],
   ];
   

2. Configuration Publish the default config:

   php bin/console d4m:ebay:install
   

   Update config/packages/d4m_ebay.yaml with your API credentials (App ID, Dev ID, Cert ID, Token).

3. First Use Case Fetch active listings via CLI:

   php bin/console d4m:ebay:listings:active
   

   Or programmatically:

   use D4m\EbayBundle\Service\EbayService;
   
   $ebay = $this->get('d4m_ebay.ebay_service');
   $listings = $ebay->getActiveListings();
   

Implementation Patterns

Core Workflows

1. API Integration

   • Use EbayService for core operations (e.g., getActiveListings(), createListing()).
   • Pass parameters as associative arrays (e.g., ['Item.Specifics'] => [...]).
   • Example:

     $ebay->createListing([
         'Item' => [
             'Title' => 'Test Product',
             'CategoryID' => '12345',
             'StartPrice' => '19.99',
         ],
     ]);
     

2. Event-Driven Extensions

   • Subscribe to events (e.g., ebay.listing.created) via Symfony’s event dispatcher:

     $dispatcher->addListener('ebay.listing.created', function ($event) {
         // Log or process the new listing
     });
     

3. Command-Line Automation

   • Schedule CLI commands (e.g., d4m:ebay:listings:sync) via Laravel’s task scheduler:

     $schedule->command('d4m:ebay:listings:sync')->daily();
     

4. Response Handling

   • Parse API responses with EbayResponse:

     $response = $ebay->getOrderDetails(['OrderID' => '123']);
     if ($response->isSuccess()) {
         $data = $response->getData();
     }
     

Integration Tips

• Laravel-Specific: Bind EbayService to Laravel’s container in AppServiceProvider:

  $this->app->bind('d4m_ebay.ebay_service', function ($app) {
      return new EbayService($app['d4m_ebay.config']);
  });
  

• Testing: Mock EbayService in unit tests:

  $mock = $this->createMock(EbayService::class);
  $mock->method('getActiveListings')->willReturn([...]);
  $this->app->instance('d4m_ebay.ebay_service', $mock);
  

Gotchas and Tips

Pitfalls

1. Authentication Failures

   • Issue: Invalid credentials or expired tokens cause silent failures.
   • Fix: Enable debug mode in d4m_ebay.yaml:

     debug: true
     

     Check logs for EbayException details.

2. Rate Limits

   • Issue: EBay’s API throttles requests (e.g., 5 calls/second).
   • Fix: Implement retries with exponential backoff:

     try {
         $ebay->getActiveListings();
     } catch (RateLimitException $e) {
         sleep($e->getRetryAfter());
         retry();
     }
     

3. Deprecated Methods

   • Issue: The bundle may lag behind EBay’s API updates (e.g., getItem → findItemsAdvanced).
   • Fix: Check EBay’s API docs and extend the service:

     class CustomEbayService extends EbayService {
         public function findItemsAdvanced(array $params) {
             return $this->callApi('findItemsAdvanced', $params);
         }
     }
     

4. XML vs. JSON

   • Issue: The bundle defaults to XML responses, which may require parsing.
   • Fix: Force JSON in config:

     response_format: json
     

Debugging Tips

• Enable Verbose Logging:

  logging: true
  

  Logs appear in var/log/d4m_ebay.log.

• Validate XML: Use php bin/console d4m:ebay:validate-xml to check request payloads.

Extension Points

1. Custom API Calls Extend EbayService to add unsupported endpoints:

   public function getMyeBaySelling($callName, array $params) {
       return $this->callApi('GetMyeBaySelling', $params, 'MyeBaySelling');
   }
   

2. Response Transformers Override EbayResponse to customize data structures:

   class CustomEbayResponse extends EbayResponse {
       public function transform() {
           return collect($this->data)->map(fn ($item) => [
               'title' => $item->Title,
               'price' => $item->CurrentPrice,
           ]);
       }
   }
   

3. Event Listeners Add listeners for real-time processing (e.g., webhooks):

   // config/packages/d4m_ebay.yaml
   listeners:
       ebay.listing.updated: App\Listener\EbayListingUpdatedListener