class Peddler::API::Feeds20210630

Selling Partner API for Feeds

The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner.

Public Instance Methods

cancel_feed(feed_id, rate_limit: 2.0) click to toggle source

Cancels the feed that you specify. Only feeds with ‘processingStatus=IN_QUEUE` can be cancelled. Cancelled feeds are returned in subsequent calls to the [`getFeed`](developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#getfeed) and [`getFeeds`](developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#getfeeds) operations.

@note This operation can make a static sandbox call. @param feed_id [String] The identifier for the feed. This identifier is unique only in combination with a seller

ID.

@param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/feeds_2021_06_30.rb, line 75
def cancel_feed(feed_id, rate_limit: 2.0)
  path = "/feeds/2021-06-30/feeds/#{feed_id}"

  meter(rate_limit).delete(path)
end
create_feed(body, rate_limit: 0.0083) click to toggle source

Creates a feed. Upload the contents of the feed document before calling this operation.

@note This operation can make a static sandbox call. @param body [Hash] Information required to create the feed. @param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/feeds_2021_06_30.rb, line 59
def create_feed(body, rate_limit: 0.0083)
  path = "/feeds/2021-06-30/feeds"

  meter(rate_limit).post(path, body:)
end
create_feed_document(body, rate_limit: 0.5) click to toggle source

Creates a feed document for the feed type that you specify. This operation returns a presigned URL for uploading the feed document contents. It also returns a ‘feedDocumentId` value that you can pass in with a subsequent call to the [`createFeed`](developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#createfeed) operation.

@note This operation can make a static sandbox call. @param body [Hash] Specifies the content type for the createFeedDocument operation. @param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/feeds_2021_06_30.rb, line 103
def create_feed_document(body, rate_limit: 0.5)
  path = "/feeds/2021-06-30/documents"

  meter(rate_limit).post(path, body:)
end
get_feed(feed_id, rate_limit: 2.0) click to toggle source

Returns feed details (including the ‘resultDocumentId`, if available) for the feed that you specify.

@note This operation can make a static sandbox call. @param feed_id [String] The identifier for the feed. This identifier is unique only in combination with a seller

ID.

@param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/feeds_2021_06_30.rb, line 88
def get_feed(feed_id, rate_limit: 2.0)
  path = "/feeds/2021-06-30/feeds/#{feed_id}"

  meter(rate_limit).get(path)
end
get_feed_document(feed_document_id, rate_limit: 0.0222) click to toggle source

Returns the information required for retrieving a feed document’s contents.

@note This operation can make a static sandbox call. @param feed_document_id [String] The identifier of the feed document. @param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/feeds_2021_06_30.rb, line 115
def get_feed_document(feed_document_id, rate_limit: 0.0222)
  path = "/feeds/2021-06-30/documents/#{feed_document_id}"

  meter(rate_limit).get(path)
end
get_feeds(feed_types: nil, marketplace_ids: nil, page_size: 10, processing_statuses: nil, created_since: nil, created_until: nil, next_token: nil, rate_limit: 0.0222) click to toggle source

Returns feed details for the feeds that match the filters that you specify.

@note This operation can make a static sandbox call. @param feed_types [Array<String>] A list of feed types used to filter feeds. When feedTypes is provided, the

other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also
be provided. Either feedTypes or nextToken is required.

@param marketplace_ids [Array<String>] A list of marketplace identifiers used to filter feeds. The feeds

returned will match at least one of the marketplaces that you specify.

@param page_size [Integer] The maximum number of feeds to return in a single call. @param processing_statuses [Array<String>] A list of processing statuses used to filter feeds. @param created_since [String] The earliest feed creation date and time for feeds included in the response, in

ISO 8601 format. The default is 90 days ago. Feeds are retained for a maximum of 90 days.

@param created_until [String] The latest feed creation date and time for feeds included in the response, in ISO

8601 format. The default is now.

@param next_token [String] A string token returned in the response to your previous request. nextToken is

returned when the number of results exceeds the specified pageSize value. To get the next page of results,
call the getFeeds operation and include this token as the only parameter. Specifying nextToken with any other
parameters will cause the request to fail.

@param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/feeds_2021_06_30.rb, line 37
def get_feeds(feed_types: nil, marketplace_ids: nil, page_size: 10, processing_statuses: nil, created_since: nil,
  created_until: nil, next_token: nil, rate_limit: 0.0222)
  path = "/feeds/2021-06-30/feeds"
  params = {
    "feedTypes" => feed_types,
    "marketplaceIds" => marketplace_ids,
    "pageSize" => page_size,
    "processingStatuses" => processing_statuses,
    "createdSince" => created_since,
    "createdUntil" => created_until,
    "nextToken" => next_token,
  }.compact

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