Module: Peddler::Types::ProductFeesV0

Defined in:

lib/peddler/types/product_fees_v0/error.rb,
lib/peddler/types/product_fees_v0/points.rb,
lib/peddler/types/product_fees_v0/fee_detail.rb,
lib/peddler/types/product_fees_v0/money_type.rb,
lib/peddler/types/product_fees_v0/fees_estimate.rb,
lib/peddler/types/product_fees_v0/fees_estimate_error.rb,
lib/peddler/types/product_fees_v0/included_fee_detail.rb,
lib/peddler/types/product_fees_v0/fees_estimate_result.rb,
lib/peddler/types/product_fees_v0/fees_estimate_request.rb,
lib/peddler/types/product_fees_v0/price_to_estimate_fees.rb,
lib/peddler/types/product_fees_v0/fees_estimate_identifier.rb,
lib/peddler/types/product_fees_v0/fees_estimate_by_id_request.rb,
lib/peddler/types/product_fees_v0/get_my_fees_estimate_result.rb,
lib/peddler/types/product_fees_v0/get_my_fees_estimate_request.rb,
lib/peddler/types/product_fees_v0/get_my_fees_estimate_response.rb,
lib/peddler/types/product_fees_v0/get_my_fees_estimates_error_list.rb

Constant Summary

Error =

An object representing an error that occurred during the API operation.

Structure.new do
  # @return [String] An error code that identifies the type of error that occurred.
  attribute(:code, String)

  # @return [String] A message that describes the error condition.
  attribute(:message, String)

  # @return [String] Additional details that can help the caller understand or fix the issue.
  attribute(:details, String)
end

Points =

The number of Amazon Points offered with the purchase of an item.The Amazon Points program is only available in Japan.

Structure.new do
  # @return [Integer] The number of Amazon Points
  attribute(:points_number, Integer, from: "PointsNumber")

  # @return [Money]
  attribute(:points_monetary_value, Money, from: "PointsMonetaryValue")
end

FeeDetail =

The type of fee, fee amount, and other details.

Structure.new do
  # @return [String] The type of fee charged to a seller.
  attribute(:fee_type, String, from: "FeeType")

  # @return [Money] The amount charged for a given fee.
  attribute(:fee_amount, Money, from: "FeeAmount")

  # @return [Money] The promotion amount for a given fee.
  attribute(:fee_promotion, Money, from: "FeePromotion")

  # @return [Money] The tax amount for a given fee.
  attribute(:tax_amount, Money, from: "TaxAmount")

  # @return [Money] The final fee amount for a given fee.
  attribute(:final_fee, Money, from: "FinalFee")

  # @return [Array<IncludedFeeDetail>]
  attribute(:included_fee_detail_list, [IncludedFeeDetail], from: "IncludedFeeDetailList")
end

MoneyType =

An object representing a monetary value with its currency information.

Structure.new do
  # @return [String] The currency code in ISO 4217 format.
  attribute(:currency_code, String, from: "CurrencyCode")

  # @return [Float] The monetary value.
  attribute(:amount, Float, from: "Amount")
end

FeesEstimate =

The total estimated fees for an item and a list of details.

Structure.new do
  # @return [String] The time at which the fees were estimated. This defaults to the time the request is made.
  attribute(:time_of_fees_estimation, String, from: "TimeOfFeesEstimation")

  # @return [Money] Total estimated fees for a given item, price, and fulfillment channel.
  attribute(:total_fees_estimate, Money, from: "TotalFeesEstimate")

  # @return [Array<FeeDetail>]
  attribute(:fee_detail_list, [FeeDetail], from: "FeeDetailList")
end

FeesEstimateError =

An unexpected error occurred during this operation.

Structure.new do
  # @return [String] An error type, identifying either the receiver or the sender as the originator of the error.
  attribute(:type, String, from: "Type")

  # @return [String] An error code that identifies the type of error that occurred.
  attribute(:code, String, from: "Code")

  # @return [String] A message that describes the error condition.
  attribute(:message, String, from: "Message")

  # @return [Array]
  attribute(:detail, Array, from: "Detail")
end

IncludedFeeDetail =

The type of fee, fee amount, and other details.

Structure.new do
  # @return [String] The type of fee charged to a seller.
  attribute(:fee_type, String, from: "FeeType")

  # @return [Money] The amount charged for a given fee.
  attribute(:fee_amount, Money, from: "FeeAmount")

  # @return [Money] The promotion amount for a given fee.
  attribute(:fee_promotion, Money, from: "FeePromotion")

  # @return [Money] The tax amount for a given fee.
  attribute(:tax_amount, Money, from: "TaxAmount")

  # @return [Money] The final fee amount for a given fee.
  attribute(:final_fee, Money, from: "FinalFee")
end

FeesEstimateResult =

An item identifier and the estimated fees for the item.

Structure.new do
  # @return [String] The status of the fee request. Possible values: Success, ClientError, ServiceError.
  attribute(:status, String, from: "Status")

  # @return [FeesEstimateIdentifier] Information used to identify a fees estimate request.
  attribute(:fees_estimate_identifier, FeesEstimateIdentifier, from: "FeesEstimateIdentifier")

  # @return [FeesEstimate] The total estimated fees for an item and a list of details.
  attribute(:fees_estimate, FeesEstimate, from: "FeesEstimate")

  # @return [FeesEstimateError] An error object with a type, code, and message.
  attribute(:error, FeesEstimateError, from: "Error")
end

FeesEstimateRequest =

A product, marketplace, and proposed price used to request estimated fees.

Structure.new do
  # @return [String] A marketplace identifier.
  attribute(:marketplace_id, String, from: "MarketplaceId")

  # @return [:boolean] When true, the offer is fulfilled by Amazon.
  attribute(:amazon_fulfilled, :boolean, from: "IsAmazonFulfilled")

  # @return [PriceToEstimateFees] The product price that the fee estimate is based on.
  attribute(:price_to_estimate_fees, PriceToEstimateFees, from: "PriceToEstimateFees")

  # @return [String] A unique identifier provided by the caller to track this request.
  attribute(:identifier, String, from: "Identifier")

  # @return [String]
  attribute(:optional_fulfillment_program, String, from: "OptionalFulfillmentProgram")
end

PriceToEstimateFees =

Price information for an item, used to estimate fees.

Structure.new do
  # @return [Money] The price of the item.
  attribute(:listing_price, Money, from: "ListingPrice")

  # @return [Money] The shipping cost.
  attribute(:shipping, Money, from: "Shipping")

  # @return [Points] The number of Amazon Points offered with the purchase of an item.
  attribute(:points, Points, from: "Points")
end

FeesEstimateIdentifier =

An item identifier, marketplace, time of request, and other details that identify an estimate.

Structure.new do
  # @return [String] A marketplace identifier.
  attribute(:marketplace_id, String, from: "MarketplaceId")

  # @return [String] The seller identifier.
  attribute(:seller_id, String, from: "SellerId")

  # @return [String]
  attribute(:id_type, String, from: "IdType")

  # @return [String] The item identifier.
  attribute(:id_value, String, from: "IdValue")

  # @return [:boolean] When true, the offer is fulfilled by Amazon.
  attribute(:amazon_fulfilled, :boolean, from: "IsAmazonFulfilled")

  # @return [PriceToEstimateFees] The item price on which the fee estimate is based.
  attribute(:price_to_estimate_fees, PriceToEstimateFees, from: "PriceToEstimateFees")

  # @return [String] A unique identifier provided by the caller to track this request.
  attribute(:seller_input_identifier, String, from: "SellerInputIdentifier")

  # @return [String]
  attribute(:optional_fulfillment_program, String, from: "OptionalFulfillmentProgram")
end

FeesEstimateByIdRequest =

A product, marketplace, and proposed price used to request estimated fees.

Structure.new do
  # @return [FeesEstimateRequest]
  attribute(:fees_estimate_request, FeesEstimateRequest, from: "FeesEstimateRequest")

  # @return [String]
  attribute(:id_type, String, from: "IdType")

  # @return [String] The item identifier.
  attribute(:id_value, String, from: "IdValue")
end

GetMyFeesEstimateResult =

Response schema.

Structure.new do
  # @return [FeesEstimateResult] The item's estimated fees.
  attribute(:fees_estimate_result, FeesEstimateResult, from: "FeesEstimateResult")
end

GetMyFeesEstimateRequest =

Request schema.

Structure.new do
  # @return [FeesEstimateRequest]
  attribute(:fees_estimate_request, FeesEstimateRequest, from: "FeesEstimateRequest")
end

GetMyFeesEstimateResponse =

The response object for the GetMyFeesEstimate operation.

Structure.new do
  # @return [GetMyFeesEstimateResult] The payload for the operation.
  attribute(:payload, GetMyFeesEstimateResult)

  # @return [Array<Error>] A list of errors that may have occurred during the GetMyFeesEstimate operation.
  attribute(:errors, [Error])
end

GetMyFeesEstimatesErrorList =

A list of error responses returned when a request is unsuccessful.

Structure.new do
  # @return [Array<Error>] A list of error responses returned when a request is unsuccessful.
  attribute(:errors, [Error])
end