Module: Peddler::Types::FBAInboundEligibilityV1

Defined in:: lib/peddler/types/fba_inbound_eligibility_v1/error.rb,
lib/peddler/types/fba_inbound_eligibility_v1/error_list.rb,
lib/peddler/types/fba_inbound_eligibility_v1/item_eligibility_preview.rb,
lib/peddler/types/fba_inbound_eligibility_v1/get_item_eligibility_preview_response.rb

Defined Under Namespace

Constant Summary collapse

Error = Error response returned when the request is unsuccessful.

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

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

  # @return [String] A message that describes the error condition in a human-readable form.
  attribute?(:message, String)
end

ItemEligibilityPreview = The response object which contains the ASIN, marketplaceId if required, eligibility program, the eligibility status (boolean), and a list of ineligibility reason codes.

Structure.new do
  # @return [String] The ASIN for which eligibility was determined.
  attribute(:asin, String)

  # @return [:boolean] Indicates if the item is eligible for the program.
  attribute(:eligible_for_program, :boolean, from: "isEligibleForProgram")

  # @return [String] The program for which eligibility was determined.
  attribute(:program, String)

  # @return [Array<String>] Potential Ineligibility Reason Codes.
  attribute?(:ineligibility_reason_list, [String], from: "ineligibilityReasonList")

  # @return [String] The marketplace for which eligibility was determined.
  attribute?(:marketplace_id, String, from: "marketplaceId")
end

GetItemEligibilityPreviewResponse = The response schema for the getItemEligibilityPreview operation.

Structure.new do
  # @return [Array<Error>] An unexpected condition occurred during the GetItemEligibilityPreview operation.
  attribute?(:errors, [Error])

  # @return [ItemEligibilityPreview] The payload for the getItemEligibilityPreview operation.
  attribute?(:payload, ItemEligibilityPreview)
end