Class: Peddler::API::ListingsRestrictions20210801

Inherits:
Peddler::API
  • Object
show all
Defined in:
lib/peddler/api/listings_restrictions_2021_08_01.rb

Overview

Selling Partner API for Listings Restrictions

The Selling Partner API for Listings Restrictions provides programmatic access to restrictions on Amazon catalog listings. For more information, see the href="https://developer-docs.amazon.com/sp-api/docs/listings-restrictions-api-v2021-08-01-use-case-guide">https://developer-docs.amazon.com/sp-api/docs/listings-restrictions-api-v2021-08-01-use-case-guide Listings Restrictions API Use Case Guide.

Instance Attribute Summary

Attributes inherited from Peddler::API

#access_token, #endpoint

Instance Method Summary collapse

Methods inherited from Peddler::API

#cannot_sandbox!, #endpoint_uri, #http, #initialize, #meter, #must_sandbox!, #retriable, #sandbox, #sandbox?, #use, #via

Constructor Details

This class inherits a constructor from Peddler::API

Instance Method Details

#get_listings_restrictions(asin, seller_id, marketplace_ids, condition_type: nil, reason_locale: nil, rate_limit: 5.0) ⇒ Hash

Note:

This operation can make a static sandbox call.

Returns listing restrictions for an item in the Amazon Catalog.

Parameters:

  • asin (String) —

    The Amazon Standard Identification Number (ASIN) of the item.

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

    The condition used to filter restrictions.

  • seller_id (String) —

    A selling partner identifier, such as a merchant account.

  • marketplace_ids (Array<String>) —

    A comma-delimited list of Amazon marketplace identifiers for the request.

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

    A locale for reason text localization. When not provided, the default language code of the first marketplace is used. Examples: "en_US", "fr_CA", "fr_FR". Localized messages default to "en_US" when a localization is not available in the specified locale.

  • rate_limit (Float) (defaults to: 5.0) —

    Requests per second

Returns:

  • (Hash) —

    The API response



33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/peddler/api/listings_restrictions_2021_08_01.rb', line 33

def get_listings_restrictions(asin, seller_id, marketplace_ids, condition_type: nil, reason_locale: nil,
  rate_limit: 5.0)
  path = "/listings/2021-08-01/restrictions"
  params = {
    "asin" => asin,
    "conditionType" => condition_type,
    "sellerId" => seller_id,
    "marketplaceIds" => marketplace_ids,
    "reasonLocale" => reason_locale,
  }.compact

  meter(rate_limit).get(path, params:)
end