Module: Peddler::Types::ListingsItems20200901

Defined in:

lib/peddler/types/listings_items_2020_09_01/error.rb,
lib/peddler/types/listings_items_2020_09_01/issue.rb,
lib/peddler/types/listings_items_2020_09_01/error_list.rb,
lib/peddler/types/listings_items_2020_09_01/patch_operation.rb,
lib/peddler/types/listings_items_2020_09_01/listings_item_put_request.rb,
lib/peddler/types/listings_items_2020_09_01/listings_item_patch_request.rb,
lib/peddler/types/listings_items_2020_09_01/listings_item_submission_response.rb

Constant Summary

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 [String] Name of the attribute associated with the issue, if applicable.
  attribute(:attribute_name, String, from: "attributeName")
end

ErrorList =

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

Structure.new do
  # @return [Array<Error>]
  attribute(:errors, [Error])
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, and
  # delete. See <https://tools.ietf.org/html/rfc6902>.
  attribute(:op, String)

  # @return [String] JSON Pointer path of the element to patch. See <https://tools.ietf.org/html/rfc6902>.
  attribute(:path, String)

  # @return [Array<Object>] JSON value to add, replace, or delete.
  attribute(:value, Array)
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] JSON object containing structured listings item attribute data keyed by attribute name.
  attribute(:attributes, Hash)
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

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