Class: Peddler::APIs::ListingsItems20210801

Inherits:
Peddler::API show all
Defined in:
lib/peddler/apis/listings_items_2021_08_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 Listings Items API Use Case Guide.

Instance Attribute Summary

Attributes inherited from Peddler::API

#access_token, #endpoint, #parser, #retries

Instance Method Summary collapse

Methods inherited from Peddler::API

#endpoint_uri, #http, #initialize, #meter, #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) ⇒ Peddler::Response

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.

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:



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

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

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

#get_listings_item(seller_id, sku, marketplace_ids, issue_locale: nil, included_data: ["summaries"], rate_limit: 5.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Returns details about 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.

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.

  • included_data (Array<String>) (defaults to: ["summaries"]) —

    A comma-delimited list of data sets to include in the response. Default: summaries.

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

    Requests per second

Returns:



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/peddler/apis/listings_items_2021_08_01.rb', line 59

def get_listings_item(seller_id, sku, marketplace_ids, issue_locale: nil, included_data: ["summaries"],
  rate_limit: 5.0)
  path = "/listings/2021-08-01/items/#{seller_id}/#{sku}"
  params = {
    "marketplaceIds" => marketplace_ids,
    "issueLocale" => issue_locale,
    "includedData" => included_data,
  }.compact

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

#patch_listings_item(seller_id, sku, marketplace_ids, body, included_data: ["issues"], mode: nil, issue_locale: nil, rate_limit: 5.0) ⇒ Peddler::Response

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.

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.

  • included_data (Array<String>) (defaults to: ["issues"]) —

    A comma-delimited list of data sets to include in the response. Default: issues.

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

    The mode of operation 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:



87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/peddler/apis/listings_items_2021_08_01.rb', line 87

def patch_listings_item(seller_id, sku, marketplace_ids, body, included_data: ["issues"], mode: nil,
  issue_locale: nil, rate_limit: 5.0)
  path = "/listings/2021-08-01/items/#{seller_id}/#{sku}"
  params = {
    "marketplaceIds" => marketplace_ids,
    "includedData" => included_data,
    "mode" => mode,
    "issueLocale" => issue_locale,
  }.compact

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

#put_listings_item(seller_id, sku, marketplace_ids, body, included_data: ["issues"], mode: nil, issue_locale: nil, rate_limit: 5.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Creates or fully updates an existing listings item for a selling partner. Note: This operation has a throttling rate of one request per second when mode is VALIDATION_PREVIEW. 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.

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.

  • included_data (Array<String>) (defaults to: ["issues"]) —

    A comma-delimited list of data sets to include in the response. Default: issues.

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

    The mode of operation 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:



119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/peddler/apis/listings_items_2021_08_01.rb', line 119

def put_listings_item(seller_id, sku, marketplace_ids, body, included_data: ["issues"], mode: nil,
  issue_locale: nil, rate_limit: 5.0)
  path = "/listings/2021-08-01/items/#{seller_id}/#{sku}"
  params = {
    "marketplaceIds" => marketplace_ids,
    "includedData" => included_data,
    "mode" => mode,
    "issueLocale" => issue_locale,
  }.compact

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

#search_listings_items(seller_id, marketplace_ids, issue_locale: nil, included_data: ["summaries"], identifiers: nil, identifiers_type: nil, variation_parent_sku: nil, package_hierarchy_sku: nil, created_after: nil, created_before: nil, last_updated_after: nil, last_updated_before: nil, with_issue_severity: nil, with_status: nil, without_status: nil, sort_by: "lastUpdatedDate", sort_order: "DESC", page_size: 10, page_token: nil, rate_limit: 5.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Search for and return a list of selling partner listings items and their respective details.

Parameters:

  • seller_id (String) —

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

  • marketplace_ids (Array<String>) —

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

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

    A locale that is used to localize issues. When not provided, the default language code of the first marketplace is used. Examples: "en_US", "fr_CA", "fr_FR". When a localization is not available in the specified locale, localized messages default to "en_US".

  • included_data (Array<String>) (defaults to: ["summaries"]) —

    A comma-delimited list of datasets that you want to include in the response. Default: summaries.

  • identifiers (Array<String>) (defaults to: nil) —

    A comma-delimited list of product identifiers that you can use to search for listings items. Note: 1. This is required when you specify identifiersType. 2. You cannot use 'identifiers' if you specify variationParentSku or packageHierarchySku.

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

    A type of product identifiers that you can use to search for listings items. Note: This is required when identifiers is provided.

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

    Filters results to include listing items that are variation children of the specified SKU. Note: You cannot use variationParentSku if you include identifiers or packageHierarchySku in your request.

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

    Filter results to include listing items that contain or are contained by the specified SKU. Note: You cannot use packageHierarchySku if you include identifiers or variationParentSku in your request.

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

    A date-time that is used to filter listing items. The response includes listings items that were created at or after this time. Values are in ISO 8601 date-time format.

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

    A date-time that is used to filter listing items. The response includes listings items that were created at or before this time. Values are in ISO 8601 date-time format.

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

    A date-time that is used to filter listing items. The response includes listings items that were last updated at or after this time. Values are in ISO 8601 date-time format.

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

    A date-time that is used to filter listing items. The response includes listings items that were last updated at or before this time. Values are in ISO 8601 date-time format.

  • with_issue_severity (Array<String>) (defaults to: nil) —

    Filter results to include only listing items that have issues that match one or more of the specified severity levels.

  • with_status (Array<String>) (defaults to: nil) —

    Filter results to include only listing items that have the specified status.

  • without_status (Array<String>) (defaults to: nil) —

    Filter results to include only listing items that don't contain the specified statuses.

  • sort_by (String) (defaults to: "lastUpdatedDate") —

    An attribute by which to sort the returned listing items.

  • sort_order (String) (defaults to: "DESC") —

    The order in which to sort the result items.

  • page_size (Integer) (defaults to: 10) —

    The number of results that you want to include on each page.

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

    A token that you can use to fetch a specific page when there are multiple pages of results.

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

    Requests per second

Returns:



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/peddler/apis/listings_items_2021_08_01.rb', line 177

def search_listings_items(seller_id, marketplace_ids, issue_locale: nil, included_data: ["summaries"],
  identifiers: nil, identifiers_type: nil, variation_parent_sku: nil, package_hierarchy_sku: nil,
  created_after: nil, created_before: nil, last_updated_after: nil, last_updated_before: nil,
  with_issue_severity: nil, with_status: nil, without_status: nil, sort_by: "lastUpdatedDate", sort_order: "DESC",
  page_size: 10, page_token: nil, rate_limit: 5.0)
  path = "/listings/2021-08-01/items/#{seller_id}"
  params = {
    "marketplaceIds" => marketplace_ids,
    "issueLocale" => issue_locale,
    "includedData" => included_data,
    "identifiers" => identifiers,
    "identifiersType" => identifiers_type,
    "variationParentSku" => variation_parent_sku,
    "packageHierarchySku" => package_hierarchy_sku,
    "createdAfter" => created_after,
    "createdBefore" => created_before,
    "lastUpdatedAfter" => last_updated_after,
    "lastUpdatedBefore" => last_updated_before,
    "withIssueSeverity" => with_issue_severity,
    "withStatus" => with_status,
    "withoutStatus" => without_status,
    "sortBy" => sort_by,
    "sortOrder" => sort_order,
    "pageSize" => page_size,
    "pageToken" => page_token,
  }.compact

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