Class: Peddler::APIs::ActionItems20260601

Inherits:
Peddler::API show all
Defined in:
lib/peddler/apis/action_items_2026_06_01.rb,
lib/peddler/apis/action_items_2026_06_01/error.rb,
lib/peddler/apis/action_items_2026_06_01/impact.rb,
lib/peddler/apis/action_items_2026_06_01/estimate.rb,
lib/peddler/apis/action_items_2026_06_01/error_list.rb,
lib/peddler/apis/action_items_2026_06_01/pagination.rb,
lib/peddler/apis/action_items_2026_06_01/references.rb,
lib/peddler/apis/action_items_2026_06_01/resolution.rb,
lib/peddler/apis/action_items_2026_06_01/action_item.rb,
lib/peddler/apis/action_items_2026_06_01/resolutions.rb,
lib/peddler/apis/action_items_2026_06_01/localized_text.rb,
lib/peddler/apis/action_items_2026_06_01/action_item_type.rb,
lib/peddler/apis/action_items_2026_06_01/dismissal_reason.rb,
lib/peddler/apis/action_items_2026_06_01/catalog_reference.rb,
lib/peddler/apis/action_items_2026_06_01/action_item_impacts.rb,
lib/peddler/apis/action_items_2026_06_01/action_item_statuses.rb,
lib/peddler/apis/action_items_2026_06_01/action_plan_reference.rb,
lib/peddler/apis/action_items_2026_06_01/impact_definition_ref.rb,
lib/peddler/apis/action_items_2026_06_01/estimate_definition_ref.rb,
lib/peddler/apis/action_items_2026_06_01/search_refinement_value.rb,
lib/peddler/apis/action_items_2026_06_01/get_action_item_response.rb,
lib/peddler/apis/action_items_2026_06_01/search_refinement_values.rb,
lib/peddler/apis/action_items_2026_06_01/resolution_definition_ref.rb,
lib/peddler/apis/action_items_2026_06_01/list_action_items_response.rb,
lib/peddler/apis/action_items_2026_06_01/action_item_type_definition.rb,
lib/peddler/apis/action_items_2026_06_01/dismiss_action_item_request.rb,
lib/peddler/apis/action_items_2026_06_01/dismiss_action_item_response.rb,
lib/peddler/apis/action_items_2026_06_01/action_item_type_classifications.rb,
sig/peddler/apis/action_items_2026_06_01.rbs

Overview

The Selling Partner API for Action Items

The Selling Partner API for Action Items enables you to discover and inspect action items surfaced by Amazon, including recommendations, issues, and tasks.

See Also:

Defined Under Namespace

Classes: ActionItem, ActionItemImpacts, ActionItemStatuses, ActionItemType, ActionItemTypeClassifications, ActionItemTypeDefinition, ActionPlanReference, CatalogReference, DismissActionItemRequest, DismissActionItemResponse, DismissalReason, Error, ErrorList, Estimate, EstimateDefinitionRef, GetActionItemResponse, Impact, ImpactDefinitionRef, ListActionItemsResponse, LocalizedText, Pagination, References, Resolution, ResolutionDefinitionRef, Resolutions, SearchRefinementValue, SearchRefinementValues

Constant Summary

Constants inherited from Peddler::API

Peddler::API::TRANSIENT_STATUSES

Instance Attribute Summary

Attributes inherited from Peddler::API

#access_token, #base_url, #endpoint, #retries

Instance Method Summary collapse

Methods inherited from Peddler::API

#cannot_sandbox!, #delete, #endpoint_uri, #get, #host_header, #http, #initialize, #must_sandbox!, #parse_base_url, #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

#dismiss_action_item(action_item_id, body) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Dismiss the specified action item. An optional reason can be provided.

Parameters:

  • action_item_id (String) —

    The unique identifier of the action item.

  • body (Hash) —

    The request body for the dismissActionItem operation.

  • (String)
  • (Hash[untyped, untyped])

Returns:



85
86
87
88
89
 
# File 'lib/peddler/apis/action_items_2026_06_01.rb', line 85

def dismiss_action_item(action_item_id, body)
  path = "/actionItems/2026-06-01/items/#{percent_encode(action_item_id)}/dismissals"
  parser = -> { DismissActionItemResponse }
  post(path, body:, parser:)
end

#get_action_item(action_item_id, locale: nil, included_data: nil) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Retrieve a single action item by ID with full detail.

Parameters:

  • action_item_id (String) —

    The unique identifier of the action item.

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

    The BCP 47 locale for localized content. Defaults to en-US.

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

    A list of optional datasets to include in the response. When omitted, only core action item fields are returned. Known values: impacts, resolutions, references.

  • (String)
  • locale: (String, nil) (defaults to: nil)
  • included_data: (Array[String], nil) (defaults to: nil)

Returns:



69
70
71
72
73
74
75
76
77
 
# File 'lib/peddler/apis/action_items_2026_06_01.rb', line 69

def get_action_item(action_item_id, locale: nil, included_data: nil)
  path = "/actionItems/2026-06-01/items/#{percent_encode(action_item_id)}"
  params = {
    "locale" => locale,
    "includedData" => stringify_array(included_data),
  }.compact
  parser = -> { GetActionItemResponse }
  get(path, params:, parser:)
end

#list_action_items(statuses: nil, classifications: nil, type_definition_ids: nil, marketplace_ids: nil, updated_after: nil, updated_before: nil, included_data: nil, sort_by: "recommended", sort_order: "DESC", page_size: 10, page_token: nil, locale: nil) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Retrieve a paginated, filterable list of action items for the selling partner. When you specify multiple filters, only action items that match all of them are returned. When you specify multiple values for one filter, action items that match any of those values are returned.

Parameters:

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

    Filter by status (OR match). Known values: PENDING_SELLING_PARTNER, AUTOMATABLE, DISMISSABLE, SNOOZABLE, DISMISSED, SNOOZED, OVERDUE, ACTIONED, RESOLVED.

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

    Filter by classification (OR match). Known values: ISSUE, RECOMMENDATION, TASK.

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

    Filter by action item type definition IDs. Multiple values allowed.

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

    Filter by marketplace IDs.

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

    Retrieve items last updated at or after this time. When used with updatedBefore, this value must be earlier than updatedBefore.

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

    Retrieve items last updated at or before this time. When used with updatedAfter, this value must be later than updatedAfter.

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

    A list of optional datasets to include in the response. When omitted, only core action item fields are returned. Known values: impacts, resolutions, references, refinements.

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

    How to sort results. Defaults to recommended. Known values: lastUpdatedDate, recommended.

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

    The sort order. Defaults to DESC. Known values: ASC, DESC.

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

    Number of results per page.

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

    A token to retrieve a specific page of results. Pass the nextToken or previousToken value from a previous response.

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

    The BCP 47 locale for localized content. Defaults to en-US.

  • statuses: (Array[String], nil) (defaults to: nil)
  • classifications: (Array[String], nil) (defaults to: nil)
  • type_definition_ids: (Array[String], nil) (defaults to: nil)
  • marketplace_ids: (Array[String], nil) (defaults to: nil)
  • updated_after: (String, nil) (defaults to: nil)
  • updated_before: (String, nil) (defaults to: nil)
  • included_data: (Array[String], nil) (defaults to: nil)
  • sort_by: (String, nil) (defaults to: "recommended")
  • sort_order: (String, nil) (defaults to: "DESC")
  • page_size: (Integer, nil) (defaults to: 10)
  • page_token: (String, nil) (defaults to: nil)
  • locale: (String, nil) (defaults to: nil)

Returns:



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/peddler/apis/action_items_2026_06_01.rb', line 39

def list_action_items(statuses: nil, classifications: nil, type_definition_ids: nil, marketplace_ids: nil,
  updated_after: nil, updated_before: nil, included_data: nil, sort_by: "recommended", sort_order: "DESC",
  page_size: 10, page_token: nil, locale: nil)
  path = "/actionItems/2026-06-01/items"
  params = {
    "statuses" => stringify_array(statuses),
    "classifications" => stringify_array(classifications),
    "typeDefinitionIds" => stringify_array(type_definition_ids),
    "marketplaceIds" => stringify_array(marketplace_ids),
    "updatedAfter" => updated_after,
    "updatedBefore" => updated_before,
    "includedData" => stringify_array(included_data),
    "sortBy" => sort_by,
    "sortOrder" => sort_order,
    "pageSize" => page_size,
    "pageToken" => page_token,
    "locale" => locale,
  }.compact
  parser = -> { ListActionItemsResponse }
  get(path, params:, parser:)
end