Class: Peddler::APIs::FinanceRemittance20260317

Inherits:
Peddler::API
  • Object
show all
Defined in:
lib/peddler/apis/finance_remittance_2026_03_17.rb,
lib/peddler/apis/finance_remittance_2026_03_17/error.rb,
lib/peddler/apis/finance_remittance_2026_03_17/breakdown.rb,
lib/peddler/apis/finance_remittance_2026_03_17/error_list.rb,
lib/peddler/apis/finance_remittance_2026_03_17/remittance_item.rb,
lib/peddler/apis/finance_remittance_2026_03_17/remittance_header.rb,
lib/peddler/apis/finance_remittance_2026_03_17/related_identifier.rb,
lib/peddler/apis/finance_remittance_2026_03_17/get_remittance_response.rb,
lib/peddler/apis/finance_remittance_2026_03_17/related_item_identifier.rb,
lib/peddler/apis/finance_remittance_2026_03_17/get_remittances_response.rb,
sig/peddler/apis/finance_remittance_2026_03_17.rbs

Overview

The Selling Partner API for Finance Remittance

The Selling Partner API for Finance Remittance provides programmatic access to selling partner payment remittance data, including remittance summaries and detailed line items.

See Also:

Defined Under Namespace

Classes: Breakdown, Error, ErrorList, GetRemittanceResponse, GetRemittancesResponse, RelatedIdentifier, RelatedItemIdentifier, RemittanceHeader, RemittanceItem

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

#get_remittance(unique_payment_id, marketplace_id, next_token_for_line_items: nil) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Returns detailed line items for a specific remittance. Results are paginated.

Parameters:

  • unique_payment_id (String) —

    The unique identifier for the payment.

  • marketplace_id (String) —

    The marketplaceId is a globally unique identifier used to specify which Amazon store a request is targeting. For more information, refer to Store Identifiers.

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

    A token to fetch the next page of results. Use the value returned in the previous response.

  • (String)
  • (String)
  • next_token_for_line_items: (String, nil) (defaults to: nil)

Returns:



52
53
54
55
56
57
58
59
60
 
# File 'lib/peddler/apis/finance_remittance_2026_03_17.rb', line 52

def get_remittance(unique_payment_id, marketplace_id, next_token_for_line_items: nil)
  path = "/finances/remittances/2026-03-17/remittances/#{percent_encode(unique_payment_id)}"
  params = {
    "marketplaceId" => marketplace_id,
    "nextTokenForLineItems" => next_token_for_line_items,
  }.compact
  parser = -> { GetRemittanceResponse }
  get(path, params:, parser:)
end

#get_remittance_headers(marketplace_id, start_date: nil, end_date: nil, next_token: nil) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Returns a list of remittance summaries for the specified Amazon store, filtered by date range. Results are paginated.

Parameters:

  • marketplace_id (String) —

    The marketplaceId is a globally unique identifier used to specify which Amazon store a request is targeting. For more information, refer to Store Identifiers.

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

    The earliest payment date for remittances to include in the response. Dates are in ISO 8601 date-time format. The default is 30 days prior to the time of the request. The minimum start date is one year ago from the current date.

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

    The latest payment date for remittances to include in the response. Dates are in ISO 8601 date-time format. The default is the current date-time. The maximum date range between startDate and endDate is 90 days.

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

    A token to fetch the next page of results. Use the value returned in the previous response.

  • (String)
  • start_date: (String, nil) (defaults to: nil)
  • end_date: (String, nil) (defaults to: nil)
  • next_token: (String, nil) (defaults to: nil)

Returns:



30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/peddler/apis/finance_remittance_2026_03_17.rb', line 30

def get_remittance_headers(marketplace_id, start_date: nil, end_date: nil, next_token: nil)
  path = "/finances/remittances/2026-03-17/remittances"
  params = {
    "marketplaceId" => marketplace_id,
    "startDate" => start_date,
    "endDate" => end_date,
    "nextToken" => next_token,
  }.compact
  parser = -> { GetRemittancesResponse }
  get(path, params:, parser:)
end