Module: Peddler::Types::ListingsItems20210801

Defined in:: lib/peddler/types/listings_items_2021_08_01/item.rb,
lib/peddler/types/listings_items_2021_08_01/error.rb,
lib/peddler/types/listings_items_2021_08_01/issue.rb,
lib/peddler/types/listings_items_2021_08_01/points.rb,
lib/peddler/types/listings_items_2021_08_01/audience.rb,
lib/peddler/types/listings_items_2021_08_01/error_list.rb,
lib/peddler/types/listings_items_2021_08_01/item_image.rb,
lib/peddler/types/listings_items_2021_08_01/pagination.rb,
lib/peddler/types/listings_items_2021_08_01/issue_exemption.rb,
lib/peddler/types/listings_items_2021_08_01/item_attributes.rb,
lib/peddler/types/listings_items_2021_08_01/patch_operation.rb,
lib/peddler/types/listings_items_2021_08_01/item_procurement.rb,
lib/peddler/types/listings_items_2021_08_01/item_relationship.rb,
lib/peddler/types/listings_items_2021_08_01/issue_enforcements.rb,
lib/peddler/types/listings_items_2021_08_01/item_search_results.rb,
lib/peddler/types/listings_items_2021_08_01/item_variation_theme.rb,
lib/peddler/types/listings_items_2021_08_01/fulfillment_availability.rb,
lib/peddler/types/listings_items_2021_08_01/issue_enforcement_action.rb,
lib/peddler/types/listings_items_2021_08_01/item_offer_by_marketplace.rb,
lib/peddler/types/listings_items_2021_08_01/listings_item_put_request.rb,
lib/peddler/types/listings_items_2021_08_01/item_summary_by_marketplace.rb,
lib/peddler/types/listings_items_2021_08_01/listings_item_patch_request.rb,
lib/peddler/types/listings_items_2021_08_01/item_identifiers_by_marketplace.rb,
lib/peddler/types/listings_items_2021_08_01/item_product_type_by_marketplace.rb,
lib/peddler/types/listings_items_2021_08_01/item_relationships_by_marketplace.rb,
lib/peddler/types/listings_items_2021_08_01/listings_item_submission_response.rb

Constant Summary collapse

Item = A listings item.

Structure.new do
  # @return [String] A selling partner provided identifier for an Amazon listing.
  attribute(:sku, String)

  # @return [Array<ItemSummaryByMarketplace>]
  attribute(:summaries, [ItemSummaryByMarketplace])

  # @return [ItemAttributes]
  attribute(:attributes, ItemAttributes)

  # @return [Array<Issue>]
  attribute(:issues, [Issue])

  # @return [Array<ItemOfferByMarketplace>]
  attribute(:offers, [ItemOfferByMarketplace])

  # @return [Array<FulfillmentAvailability>] The fulfillment availability for the listings item.
  attribute(:fulfillment_availability, [FulfillmentAvailability], from: "fulfillmentAvailability")

  # @return [Array<ItemProcurement>] The vendor procurement information for the listings item.
  attribute(:procurement, [ItemProcurement])

  # @return [Array<ItemRelationshipsByMarketplace>]
  attribute(:relationships, [ItemRelationshipsByMarketplace])

  # @return [Array<ItemProductTypeByMarketplace>]
  attribute(:product_types, [ItemProductTypeByMarketplace], from: "productTypes")
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

Issue = An issue with a listings item.

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

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

  # @return [String] The severity of the issue.
  attribute(:severity, String)

  # @return [Array<String>] The names of the attributes associated with the issue, if applicable.
  attribute(:attribute_names, [String], from: "attributeNames")

  # @return [Array<String>] List of issue categories.
  #
  # Possible values:
  #
  # * 'INVALID_ATTRIBUTE' - Indicating an invalid attribute in the listing.
  #
  # * 'MISSING_ATTRIBUTE' - Highlighting a missing attribute in the listing.
  #
  # * 'INVALID_IMAGE' - Signifying an invalid image in the listing.
  #
  # * 'MISSING_IMAGE' - Noting the absence of an image in the listing.
  #
  # * 'INVALID_PRICE' - Pertaining to issues with the listing's price-related attributes.
  #
  # * 'MISSING_PRICE' - Pointing out the absence of a price attribute in the listing.
  #
  # * 'DUPLICATE' - Identifying listings with potential duplicate problems, such as this ASIN potentially being a
  # duplicate of another ASIN.
  #
  # * 'QUALIFICATION_REQUIRED' - Indicating that the listing requires qualification-related approval.
  attribute(:categories, [String])

  # @return [IssueEnforcements] This field provides information about the enforcement actions taken by Amazon that
  # affect the publishing or status of a listing. It also includes details about any associated exemptions.
  attribute(:enforcements, IssueEnforcements)
end

Points = The number of Amazon Points offered with the purchase of an item, and their monetary value. Note that the Points element is only returned in Japan (JP).

Structure.new do
  # @return [Integer]
  attribute(:points_number, Integer, from: "pointsNumber")
end

Audience = Buyer segment or program this offer is applicable to.

Structure.new do
  # @return [String] Name of the audience an offer is applicable to.
  #
  # Common values:
  #
  # * 'ALL' - Standard offer audience for buyers on Amazon retail websites.
  #
  # * 'B2B' - Offer audience for Amazon Business website buyers.
  attribute(:value, String)

  # @return [String] Localized display name for the audience.
  attribute(:display_name, String, from: "displayName")
end

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

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

ItemImage = The image for the listings item.

Structure.new do
  # @return [String] The link, or URL, to the image.
  attribute(:link, String)

  # @return [Integer] The height of the image in pixels.
  attribute(:height, Integer)

  # @return [Integer] The width of the image in pixels.
  attribute(:width, Integer)
end

Pagination = When a request produces a response that exceeds the pageSize, pagination occurs. This means the response is divided into individual pages. To retrieve the next page or the previous page, you must pass the nextToken value or the previousToken value as the pageToken parameter in the next request. When you receive the last page, there is no nextToken key in the pagination object.

Structure.new do
  # @return [String] A token that can be used to fetch the next page.
  attribute(:next_token, String, from: "nextToken")

  # @return [String] A token that can be used to fetch the previous page.
  attribute(:previous_token, String, from: "previousToken")
end

IssueExemption = Conveying the status of the listed enforcement actions and, if applicable, provides information about the exemption's expiry date.

Structure.new do
  # @return [String] This field indicates the current exemption status for the listed enforcement actions. It can
  # take values such as `EXEMPT`, signifying permanent exemption, `EXEMPT_UNTIL_EXPIRY_DATE` indicating temporary
  # exemption until a specified date, or `NOT_EXEMPT` signifying no exemptions, and enforcement actions were
  # already applied.
  attribute(:status, String)

  # @return [String] Represents the timestamp, in ISO 8601 format, that specifies the date when the temporary
  # exemptions expires, and Amazon begins enforcing the listed actions.
  attribute(:expiry_date, String, from: "expiryDate")
end

ItemAttributes = A JSON object containing structured listings item attribute data keyed by attribute name.

Structure.new do
end

PatchOperation = Individual JSON Patch operation for an HTTP PATCH request.

Structure.new do
  # @return [String] Type of JSON Patch operation. Supported JSON Patch operations include `add`, `replace`,
  # `merge` and `delete`. Refer to <https://tools.ietf.org/html/rfc6902>.
  attribute(:op, String)

  # @return [String] JSON Pointer path of the element to patch. Refer to [JavaScript Object Notation (JSON)
  # Patch](https://tools.ietf.org/html/rfc6902) for more information.
  attribute(:path, String)

  # @return [Array<Object>] JSON value to `add`, `replace`, `merge` or `delete`.
  attribute(:value, Array)
end

ItemProcurement = The vendor procurement information for the listings item.

Structure.new do
  # @return [Money] The price (numeric value) that you want Amazon to pay you for this product.
  attribute(:cost_price, Money, from: "costPrice")
end

ItemRelationship = The relationship details for a listing item.

Structure.new do
  # @return [Array<String>] Identifiers (SKUs) of the related items that are children of this listing item.
  attribute(:child_skus, [String], from: "childSkus")

  # @return [Array<String>] Identifiers (SKUs) of the related items that are parents of this listing item.
  attribute(:parent_skus, [String], from: "parentSkus")

  # @return [ItemVariationTheme] For `VARIATION` relationships, the variation theme is the combination of listing
  # item attributes that define the variation family.
  attribute(:variation_theme, ItemVariationTheme, from: "variationTheme")

  # @return [String] The type of relationship.
  attribute(:type, String)
end

IssueEnforcements = This field provides information about the enforcement actions taken by Amazon that affect the publishing or status of a listing. It also includes details about any associated exemptions.

Structure.new do
  # @return [Array<IssueEnforcementAction>] List of enforcement actions taken by Amazon that affect the publishing
  # or status of a listing.
  attribute(:actions, [IssueEnforcementAction])

  # @return [IssueExemption] The "exemption" field serves to convey the status of enforcement actions by Amazon.
  attribute(:exemption, IssueExemption)
end

ItemSearchResults = Selling partner listings items and search related metadata.

Structure.new do
  # @return [Integer] The total number of selling partner listings items found for the search criteria (only
  # results up to the page count limit is returned per request regardless of the number found).
  #
  # Note: The maximum number of items (SKUs) that can be returned and paged through is 1000.
  attribute(:number_of_results, Integer, from: "numberOfResults")

  # @return [Pagination] If available, the `nextToken` and/or `previousToken` values required to return paginated
  # results.
  attribute(:pagination, Pagination)

  # @return [Array<Item>] A list of listings items.
  attribute(:items, [Item])
end

ItemVariationTheme = A variation theme that indicates the combination of listing item attributes that define the variation family.

Structure.new do
  # @return [Array<String>] The names of the listing item attributes that are associated with the variation theme.
  attribute(:attributes, [String])

  # @return [String] The variation theme that indicates the combination of listing item attributes that define the
  # variation family.
  attribute(:theme, String)
end

FulfillmentAvailability = The fulfillment availability details for the listings item.

Structure.new do
  # @return [String] Designates which fulfillment network is used.
  attribute(:fulfillment_channel_code, String, from: "fulfillmentChannelCode")

  # @return [Integer] The quantity of the item you are making available for sale.
  attribute(:quantity, Integer)
end

IssueEnforcementAction = The enforcement action taken by Amazon that affect the publishing or status of a listing

Structure.new do
  # @return [String] The enforcement action name.
  #
  # Possible values:
  #
  # * `LISTING_SUPPRESSED` - This enforcement takes down the current listing item's buyability.
  #
  # * `ATTRIBUTE_SUPPRESSED` - An attribute's value on the listing item is invalid, which causes it to be rejected
  # by Amazon.
  #
  # * `CATALOG_ITEM_REMOVED` - This catalog item is inactive on Amazon, and all offers against it in the
  # applicable marketplace are non-buyable.
  #
  # * `SEARCH_SUPPRESSED` - This value indicates that the catalog item is hidden from search results.
  attribute(:action, String)
end

ItemOfferByMarketplace = Offer details of a listings item for an Amazon marketplace.

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

  # @return [String] Type of offer for the listings item.
  attribute(:offer_type, String, from: "offerType")

  # @return [Money] The purchase price of the listings item
  attribute(:price, Money)

  # @return [Points]
  attribute(:points, Points)

  # @return [Audience] Buyer segment or program this offer is applicable to.
  attribute(:audience, Audience)
end

ListingsItemPutRequest = The request body schema for the putListingsItem operation.

Structure.new do
  # @return [String] The Amazon product type of the listings item.
  attribute(:product_type, String, from: "productType")

  # @return [String] The name of the requirements set for the provided data.
  attribute(:requirements, String)

  # @return [Hash] A JSON object containing structured listings item attribute data keyed by attribute name.
  attribute(:attributes, Hash)
end

ItemSummaryByMarketplace = Summary details of a listings item for an Amazon marketplace.

Structure.new do
  # @return [String] A marketplace identifier. Identifies the Amazon marketplace for the listings item.
  attribute(:marketplace_id, String, from: "marketplaceId")

  # @return [String] Amazon Standard Identification Number (ASIN) of the listings item.
  attribute(:asin, String)

  # @return [String] The Amazon product type of the listings item.
  attribute(:product_type, String, from: "productType")

  # @return [String] Identifies the condition of the listings item.
  attribute(:condition_type, String, from: "conditionType")

  # @return [Array<String>] Statuses that apply to the listings item.
  attribute(:status, [String])

  # @return [String] The fulfillment network stock keeping unit is an identifier used by Amazon fulfillment
  # centers to identify each unique item.
  attribute(:fn_sku, String, from: "fnSku")

  # @return [String] The name or title associated with an Amazon catalog item.
  attribute(:item_name, String, from: "itemName")

  # @return [String] The date the listings item was created in ISO 8601 format.
  attribute(:created_date, String, from: "createdDate")

  # @return [String] The date the listings item was last updated in ISO 8601 format.
  attribute(:last_updated_date, String, from: "lastUpdatedDate")

  # @return [ItemImage] The main image for the listings item.
  attribute(:main_image, ItemImage, from: "mainImage")
end

ListingsItemPatchRequest = The request body schema for the patchListingsItem operation.

Structure.new do
  # @return [String] The Amazon product type of the listings item.
  attribute(:product_type, String, from: "productType")

  # @return [Array<PatchOperation>] One or more JSON Patch operations to perform on the listings item.
  attribute(:patches, [PatchOperation])
end

ItemIdentifiersByMarketplace = Identity attributes associated with the item in the Amazon catalog for the indicated Amazon marketplace.

Structure.new do
  # @return [String] A marketplace identifier. Identifies the Amazon marketplace for the listings item.
  attribute(:marketplace_id, String, from: "marketplaceId")

  # @return [String] Amazon Standard Identification Number (ASIN) of the listings item.
  attribute(:asin, String)
end

ItemProductTypeByMarketplace = Product types that are associated with the listing item for the specified marketplace.

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

  # @return [String] The name of the product type that is submitted by the Selling Partner.
  attribute(:product_type, String, from: "productType")
end

ItemRelationshipsByMarketplace = Relationship details for the listing item in the specified marketplace.

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

  # @return [Array<ItemRelationship>] Relationships for the listing item.
  attribute(:relationships, [ItemRelationship])
end

ListingsItemSubmissionResponse = Response containing the results of a submission to the Selling Partner API for Listings Items.

Structure.new do
  # @return [String] A selling partner provided identifier for an Amazon listing.
  attribute(:sku, String)

  # @return [String] The status of the listings item submission.
  attribute(:status, String)

  # @return [String] The unique identifier of the listings item submission.
  attribute(:submission_id, String, from: "submissionId")

  # @return [Array<Issue>] Listings item issues related to the listings item submission.
  attribute(:issues, [Issue])

  # @return [Array<ItemIdentifiersByMarketplace>] Identity attributes associated with the item in the Amazon
  # catalog, such as the ASIN.
  attribute(:identifiers, [ItemIdentifiersByMarketplace])
end