Class: Peddler::API::ListingsItems20200901

Inherits:
Peddler::API show all
Defined in:
lib/peddler/api/listings_items_2020_09_01.rb

Overview

Selling Partner API for Listings Items

The Selling Partner API for Listings Items (Listings Items API) provides programmatic access to selling partner listings on Amazon. Use this API in collaboration with the Selling Partner API for Product Type Definitions, which you use to retrieve the information about Amazon product types needed to use the Listings Items API. For more information, see the Listing Items 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

#delete_listings_item(seller_id, sku, marketplace_ids, issue_locale: nil, rate_limit: 5.0) ⇒ Hash

Note:

This operation can make a static sandbox call.

Delete a listings item for a selling partner. Note: The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](developer-docs.amazon.com/sp-api/docs/url-encoding).

Parameters:

  • seller_id (String) —

    A selling partner identifier, such as a merchant account or vendor code.

  • sku (String) —

    A selling partner provided identifier for an Amazon listing.

  • marketplace_ids (Array<String>) —

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

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

    A locale for localization of issues. 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



34
35
36
37
38
39
40
41
42
 
# File 'lib/peddler/api/listings_items_2020_09_01.rb', line 34

def delete_listings_item(seller_id, sku, marketplace_ids, issue_locale: nil, rate_limit: 5.0)
  path = "/listings/2020-09-01/items/#{seller_id}/#{sku}"
  params = {
    "marketplaceIds" => marketplace_ids,
    "issueLocale" => issue_locale,
  }.compact

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

#patch_listings_item(seller_id, sku, marketplace_ids, body, issue_locale: nil, rate_limit: 5.0) ⇒ Hash

Note:

This operation can make a static sandbox call.

Partially update (patch) a listings item for a selling partner. Only top-level listings item attributes can be patched. Patching nested attributes is not supported. Note: The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](developer-docs.amazon.com/sp-api/docs/url-encoding).

Parameters:

  • seller_id (String) —

    A selling partner identifier, such as a merchant account or vendor code.

  • sku (String) —

    A selling partner provided identifier for an Amazon listing.

  • marketplace_ids (Array<String>) —

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

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

    A locale for localization of issues. 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.

  • body (Hash) —

    The request body schema for the patchListingsItem operation.

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

    Requests per second

Returns:

  • (Hash) —

    The API response



59
60
61
62
63
64
65
66
67
 
# File 'lib/peddler/api/listings_items_2020_09_01.rb', line 59

def patch_listings_item(seller_id, sku, marketplace_ids, body, issue_locale: nil, rate_limit: 5.0)
  path = "/listings/2020-09-01/items/#{seller_id}/#{sku}"
  params = {
    "marketplaceIds" => marketplace_ids,
    "issueLocale" => issue_locale,
  }.compact

  meter(rate_limit).patch(path, body:, params:)
end

#put_listings_item(seller_id, sku, marketplace_ids, body, issue_locale: nil, rate_limit: 5.0) ⇒ Hash

Note:

This operation can make a static sandbox call.

Creates a new or fully-updates an existing listings item for a selling partner. Note: The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](developer-docs.amazon.com/sp-api/docs/url-encoding).

Parameters:

  • seller_id (String) —

    A selling partner identifier, such as a merchant account or vendor code.

  • sku (String) —

    A selling partner provided identifier for an Amazon listing.

  • marketplace_ids (Array<String>) —

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

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

    A locale for localization of issues. 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.

  • body (Hash) —

    The request body schema for the putListingsItem operation.

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

    Requests per second

Returns:

  • (Hash) —

    The API response



84
85
86
87
88
89
90
91
92
 
# File 'lib/peddler/api/listings_items_2020_09_01.rb', line 84

def put_listings_item(seller_id, sku, marketplace_ids, body, issue_locale: nil, rate_limit: 5.0)
  path = "/listings/2020-09-01/items/#{seller_id}/#{sku}"
  params = {
    "marketplaceIds" => marketplace_ids,
    "issueLocale" => issue_locale,
  }.compact

  meter(rate_limit).put(path, body:, params:)
end