Class: Peddler::APIs::Vehicles20241101

Inherits:
Peddler::API show all
Defined in:
lib/peddler/apis/vehicles_2024_11_01.rb,
lib/peddler/apis/vehicles_2024_11_01/error.rb,
lib/peddler/apis/vehicles_2024_11_01/vehicle.rb,
lib/peddler/apis/vehicles_2024_11_01/error_list.rb,
lib/peddler/apis/vehicles_2024_11_01/pagination.rb,
lib/peddler/apis/vehicles_2024_11_01/engine_output.rb,
lib/peddler/apis/vehicles_2024_11_01/month_and_year.rb,
lib/peddler/apis/vehicles_2024_11_01/vehicles_response.rb,
lib/peddler/apis/vehicles_2024_11_01/vehicle_identifiers.rb,
sig/peddler/apis/vehicles_2024_11_01.rbs

Overview

The Selling Partner API for Automotive.

The Selling Partner API for Automotive provides programmatic access to information needed by selling partners to provide compatibility information about their listed products.

See Also:

Defined Under Namespace

Classes: EngineOutput, Error, ErrorList, MonthAndYear, Pagination, Vehicle, VehicleIdentifiers, VehiclesResponse

Instance Attribute Summary

Attributes inherited from Peddler::API

#access_token, #endpoint, #retries

Instance Method Summary collapse

Methods inherited from Peddler::API

#cannot_sandbox!, #delete, #endpoint_uri, #get, #http, #initialize, #must_sandbox!, #patch, #percent_encode, #post, #put, #request, #sandbox, #sandbox?, #stringify_array, #timestamp, #user_agent

Constructor Details

This class inherits a constructor from Peddler::API

Instance Method Details

#get_vehicles(marketplace_id, vehicle_type, page_token: nil, updated_after: nil) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Get the latest collection of vehicles

Parameters:

  • page_token (String) (defaults to: nil) —

    A token to fetch a certain page when there are multiple pages worth of results.

  • marketplace_id (String) —

    An identifier for the marketplace in which the resource operates.

  • vehicle_type (String) —

    An identifier for vehicle type.

  • updated_after (String) (defaults to: nil) —

    Date in ISO 8601 format, if provided only vehicles which are modified/added to Amazon's catalog after this date will be returned.

  • (String)
  • (String)
  • page_token: (String, nil) (defaults to: nil)
  • updated_after: (String, nil) (defaults to: nil)

Returns:



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/peddler/apis/vehicles_2024_11_01.rb', line 23

def get_vehicles(marketplace_id, vehicle_type, page_token: nil, updated_after: nil)
  path = "/catalog/2024-11-01/automotive/vehicles"
  params = {
    "pageToken" => page_token,
    "marketplaceId" => marketplace_id,
    "vehicleType" => vehicle_type,
    "updatedAfter" => updated_after,
  }.compact
  parser = -> { VehiclesResponse }
  get(path, params:, parser:)
end