Module: Peddler::Types::ListingsRestrictions20210801

Defined in:

lib/peddler/types/listings_restrictions_2021_08_01/link.rb,
lib/peddler/types/listings_restrictions_2021_08_01/error.rb,
lib/peddler/types/listings_restrictions_2021_08_01/reason.rb,
lib/peddler/types/listings_restrictions_2021_08_01/restriction.rb,
lib/peddler/types/listings_restrictions_2021_08_01/restriction_list.rb

Constant Summary

Link =

A link to resources related to a listing restriction.

Structure.new do
  # @return [String] The URI of the related resource.
  attribute(:resource, String)

  # @return [String] The HTTP verb used to interact with the related resource.
  attribute(:verb, String)

  # @return [String] The title of the related resource.
  attribute(:title, String)

  # @return [String] The media type of the related resource.
  attribute(:type, String)
end

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] 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

Reason =

A reason for the restriction, including path forward links that may allow Selling Partners to remove the restriction, if available.

Structure.new do
  # @return [String] A message describing the reason for the restriction.
  attribute(:message, String)

  # @return [String] A code indicating why the listing is restricted.
  attribute(:reason_code, String, from: "reasonCode")

  # @return [Array<Link>] A list of path forward links that may allow Selling Partners to remove the restriction.
  attribute(:links, [Link])
end

Restriction =

A listing restriction, optionally qualified by a condition, with a list of reasons for the restriction.

Structure.new do
  # @return [String] A marketplace identifier. Identifies the Amazon marketplace where the restriction is
  # enforced.
  attribute(:marketplace_id, String, from: "marketplaceId")

  # @return [String] The condition that applies to the restriction.
  attribute(:condition_type, String, from: "conditionType")

  # @return [Array<Reason>] A list of reasons for the restriction.
  attribute(:reasons, [Reason])
end

RestrictionList =

A list of restrictions for the specified Amazon catalog item.

Structure.new do
  # @return [Array<Restriction>]
  attribute(:restrictions, [Restriction])
end