Class: Ebay::Merchandising

Inherits:
Object
  • Object
show all
Includes:
Sandboxable
Defined in:
lib/ebay/merchandising.rb

Overview

Retrieves information about products or item listings on eBay to help you sell more merchandise to eBay buyers

See Also:

Constant Summary collapse

SANDBOX_ENDPOINT = 
'https://svcs.sandbox.ebay.com/MerchandisingService'
PRODUCTION_ENDPOINT = 
'https://svcs.ebay.com/MerchandisingService'

Instance Attribute Summary collapse

Attributes included from Sandboxable

#sandbox?

Instance Method Summary collapse

Methods included from Sandboxable

#sandbox

Constructor Details

#initialize(consumer_id: Config.app_id, global_id: nil, response_data_format: 'JSON', service_version: nil) ⇒ Merchandising

Returns a Finding API request instance

Parameters:

  • consumer_id (String) (defaults to: Config.app_id)
  • global_id (String) (defaults to: nil)
  • response_data_format (String) (defaults to: 'JSON')
  • service_version (String) (defaults to: nil) 


38
39
40
41
42
43
44
 
# File 'lib/ebay/merchandising.rb', line 38

def initialize(consumer_id: Config.app_id, global_id: nil,
               response_data_format: 'JSON', service_version: nil)
  @consumer_id = consumer_id
  @global_id = global_id
  @response_data_format = response_data_format
  @service_version = service_version
end

Instance Attribute Details

#consumer_id ⇒ String (readonly)

Returns:

  • (String) 


21
22
23
 
# File 'lib/ebay/merchandising.rb', line 21

def consumer_id
  @consumer_id
end

#global_id ⇒ String? (readonly)

Returns:

  • (String, nil) 


24
25
26
 
# File 'lib/ebay/merchandising.rb', line 24

def global_id
  @global_id
end

#response_data_format ⇒ String? (readonly)

Returns:

  • (String, nil) 


27
28
29
 
# File 'lib/ebay/merchandising.rb', line 27

def response_data_format
  @response_data_format
end

#service_version ⇒ String? (readonly)

Returns:

  • (String, nil) 


30
31
32
 
# File 'lib/ebay/merchandising.rb', line 30

def service_version
  @service_version
end

Instance Method Details

#get_most_watched_items(payload = {}) ⇒ HTTP::Response

Retrieves data for items with the highest watch count

Parameters:

  • payload (Hash) (defaults to: {})

Returns:

  • (HTTP::Response) 


50
51
52
 
# File 'lib/ebay/merchandising.rb', line 50

def get_most_watched_items(payload = {})
  request('getMostWatchedItems', payload)
end

#get_related_category_items(payload = {}) ⇒ HTTP::Response

Retrieves recommended items from categories related to a specified category or item

Parameters:

  • payload (Hash) (defaults to: {})

Returns:

  • (HTTP::Response) 


59
60
61
 
# File 'lib/ebay/merchandising.rb', line 59

def get_related_category_items(payload = {})
  request('getRelatedCategoryItems', payload)
end

#get_similar_items(item_id, payload = {}) ⇒ HTTP::Response

Retrieves items that are similar to the specified item

Parameters:

  • item_id (String)
  • payload (Hash) (defaults to: {})

Returns:

  • (HTTP::Response) 


68
69
70
71
 
# File 'lib/ebay/merchandising.rb', line 68

def get_similar_items(item_id, payload = {})
  payload.update('itemId' => item_id)
  request('getSimilarItems', payload)
end

#get_version ⇒ HTTP::Response

Returns the current service version

Returns:

  • (HTTP::Response) 


76
77
78
 
# File 'lib/ebay/merchandising.rb', line 76

def get_version
  request('getVersion')
end