Class: Ebay::Shopping

Inherits:
Object
  • Object
show all
Includes:
Requestable
Defined in:
lib/ebay/shopping.rb

Overview

The eBay Shopping API makes it easy to search for things on eBay.

See Also:

Instance Attribute Summary collapse

Attributes included from Requestable

#endpoint, #http

Instance Method Summary collapse

Methods included from Requestable

#sandbox

Constructor Details

#initialize(app_id: Config.app_id, response_encoding: 'JSON', site_id: nil, version: '1119', version_handling: nil, tracking_id: nil, tracking_partner_code: nil, affiliate_user_id: nil) ⇒ Shopping

Returns a Finding API request instance

Parameters:

  • app_id (String) (defaults to: Config.app_id)
  • response_encoding (String) (defaults to: 'JSON')
  • site_id (String) (defaults to: nil)
  • version (String) (defaults to: '1119')
  • version_handling (String) (defaults to: nil)
  • tracking_id (String) (defaults to: nil)
  • tracking_partner_code (String) (defaults to: nil)
  • affiliate_user_id (String) (defaults to: nil) 


50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/ebay/shopping.rb', line 50

def initialize(app_id: Config.app_id, response_encoding: 'JSON',
               site_id: nil, version: '1119',
               version_handling: nil, tracking_id: nil,
               tracking_partner_code: nil, affiliate_user_id: nil)
  @app_id = app_id
  @response_encoding = response_encoding
  @site_id = site_id
  @version = version
  @version_handling = version_handling
  @tracking_id = tracking_id
  @tracking_partner_code = tracking_partner_code
  @affiliate_user_id = affiliate_user_id
end

Instance Attribute Details

#affiliate_user_id ⇒ String? (readonly)

Returns:

  • (String, nil) 


38
39
40
 
# File 'lib/ebay/shopping.rb', line 38

def affiliate_user_id
  @affiliate_user_id
end

#app_id ⇒ String (readonly)

Returns:

  • (String) 


17
18
19
 
# File 'lib/ebay/shopping.rb', line 17

def app_id
  @app_id
end

#response_encoding ⇒ String? (readonly)

Returns:

  • (String, nil) 


20
21
22
 
# File 'lib/ebay/shopping.rb', line 20

def response_encoding
  @response_encoding
end

#site_id ⇒ String? (readonly)

Returns:

  • (String, nil) 


23
24
25
 
# File 'lib/ebay/shopping.rb', line 23

def site_id
  @site_id
end

#tracking_id ⇒ String? (readonly)

Returns:

  • (String, nil) 


32
33
34
 
# File 'lib/ebay/shopping.rb', line 32

def tracking_id
  @tracking_id
end

#tracking_partner_code ⇒ String? (readonly)

Returns:

  • (String, nil) 


35
36
37
 
# File 'lib/ebay/shopping.rb', line 35

def tracking_partner_code
  @tracking_partner_code
end

#version ⇒ String (readonly)

Returns:

  • (String) 


26
27
28
 
# File 'lib/ebay/shopping.rb', line 26

def version
  @version
end

#version_handling ⇒ String? (readonly)

Returns:

  • (String, nil) 


29
30
31
 
# File 'lib/ebay/shopping.rb', line 29

def version_handling
  @version_handling
end

Instance Method Details

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

Returns one or more eBay catalog products based on a query string or product ID value

Parameters:

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

Returns:

  • (HTTP::Response) 


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

def find_products(payload = {})
  request('FindProducts', payload)
end

#get_category_info(category_id, payload = {}) ⇒ HTTP::Response

Retrieves high-level data for a specified eBay category

Parameters:

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

Returns:

  • (HTTP::Response) 


78
79
80
81
 
# File 'lib/ebay/shopping.rb', line 78

def get_category_info(category_id, payload = {})
  payload = payload.merge('CategoryID' => category_id)
  request('GetCategoryInfo', payload)
end

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

Gets the official eBay system time in GMT

Parameters:

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

Returns:

  • (HTTP::Response) 


87
88
89
 
# File 'lib/ebay/shopping.rb', line 87

def get_ebay_time(payload = {})
  request('GeteBayTime', payload)
end

#get_item_status(*item_ids, payload = {}) ⇒ HTTP::Response

Retrieves the current status of up to 20 eBay listings

Parameters:

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

Returns:

  • (HTTP::Response) 


97
98
99
100
101
 
# File 'lib/ebay/shopping.rb', line 97

def get_item_status(*item_ids)
  payload = item_ids.last.is_a?(Hash) ? item_ids.pop : {}
  payload = payload.merge('ItemID' => item_ids.join(','))
  request('GetItemStatus', payload)
end

#get_multiple_items(*item_ids, payload = {}) ⇒ HTTP::Response

Retrieves publicly available data for one or more listings

Parameters:

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

Returns:

  • (HTTP::Response) 


109
110
111
112
113
114
 
# File 'lib/ebay/shopping.rb', line 109

def get_multiple_items(*item_ids)
  payload = item_ids.last.is_a?(Hash) ? item_ids.pop : {}
  payload = payload.merge('ItemID' => item_ids.join(','))

  request('GetMultipleItems', payload)
end

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

Gets shipping costs for a listing

Parameters:

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

Returns:

  • (HTTP::Response) 


121
122
123
124
 
# File 'lib/ebay/shopping.rb', line 121

def get_shipping_costs(item_id, payload = {})
  payload = payload.merge('ItemID' => item_id)
  request('GetShippingCosts', payload)
end

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

Gets publicly visible details about one listing

Parameters:

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

Returns:

  • (HTTP::Response) 


131
132
133
134
 
# File 'lib/ebay/shopping.rb', line 131

def get_single_item(item_id, payload = {})
  payload = payload.merge('ItemID' => item_id)
  request('GetSingleItem', payload)
end

#get_user_profile(user_id, payload = {}) ⇒ HTTP::Response

Retrieves user information

Parameters:

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

Returns:

  • (HTTP::Response) 


141
142
143
144
 
# File 'lib/ebay/shopping.rb', line 141

def (user_id, payload = {})
  payload = payload.merge('UserID' => user_id)
  request('GetUserProfile', payload)
end