Module: Peddler::Reports::VendorForecasting

Defined in:
lib/peddler/reports/vendor_forecasting.rb,
lib/peddler/reports/vendor_forecasting/report.rb,
lib/peddler/reports/vendor_forecasting/report_options.rb,
lib/peddler/reports/vendor_forecasting/forecast_by_asin.rb,
lib/peddler/reports/vendor_forecasting/report_specification.rb

Overview

Forecast customer demand of your products for production and inventory planning purposes.

Constant Summary collapse

Report =

Forecast customer demand of your products for production and inventory planning purposes.

Structure.new do
  # @return [Array<ForecastByAsin>]
  attribute(:forecast_by_asin, [ForecastByASIN], from: "forecastByAsin")

  # @return [Hash] The report input summary which includes the marketplace, selling program, and last updated
  # date.
  attribute(:report_specification, ReportSpecification, from: "reportSpecification")
end
ReportOptions =

Report options specifying parameters such as sellingProgram.

Structure.new do
  # @return [String] The selling program.
  attribute(:selling_program, String, from: "sellingProgram")
end
ForecastByASIN =

Describes forecast units for a particular ASIN for a specific period of time in the future.

Structure.new do
  # @return [String] The Amazon Standard Identification Number.
  attribute(:asin, String)

  # @return [Date] The end date of the time period being forecasted. The forecasted time period includes this
  # date.
  attribute(:end_date, Date, from: "endDate")

  # @return [Date] The date that the forecast was generated.
  attribute(:forecast_generation_date, Date, from: "forecastGenerationDate")

  # @return [Float] The average amount of forecast units that Amazon has predicted for this date range. This means
  # that, on average, Amazon predicts that this many stock units will be purchased during this date range.
  attribute(:mean_forecast_units, Float, from: "meanForecastUnits")

  # @return [Float] The 70th percentile of forecast units that Amazon has predicted for this date range. This
  # means that Amazon has forecasted a 70% probability that the ASIN will not run out of stock during the date
  # range if this many units of inventory are present at the start of the date range.
  attribute(:p70_forecast_units, Float, from: "p70ForecastUnits")

  # @return [Float] The 80th percentile of forecast units that Amazon has predicted for this date range. This
  # means that Amazon has forecasted an 80% probability that the ASIN will not run out of stock during the date
  # range if this many units of inventory are present at the start of the date range.
  attribute(:p80_forecast_units, Float, from: "p80ForecastUnits")

  # @return [Float] The 90th percentile of forecast units that Amazon has predicted for this date range. This
  # means that Amazon has forecasted a 90% probability that the ASIN will not run out of stock during the date
  # range if this many units of inventory are present at the start of the date range.
  attribute(:p90_forecast_units, Float, from: "p90ForecastUnits")

  # @return [Date] The start date of the time period being forecasted. The forecasted time period includes this
  # date.
  attribute(:start_date, Date, from: "startDate")
end
ReportSpecification =

The report input summary which includes the marketplace, selling program, and last updated date.

Structure.new do
  # @return [Date] The date when the report was last updated. Follows the
  # {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} Date format of YYYY-MM-DD.
  attribute(:last_updated_date, Date, from: "lastUpdatedDate")

  # @return [Array<String>] This parameter must match the marketplaceId of the selling partner account. Each
  # selling partner account belongs to only one marketplaceId.
  attribute(:marketplace_ids, [String], from: "marketplaceIds")

  # @return [ReportOptions] Report options specifying parameters such as sellingProgram.
  attribute(:report_options, ReportOptions, from: "reportOptions")

  # @return [String] The report type.
  attribute(:report_type, String, from: "reportType")
end

Class Method Summary collapse

Class Method Details

.parse(hash) ⇒ Object 



12
13
14
 
# File 'lib/peddler/reports/vendor_forecasting.rb', line 12

def parse(hash)
  Report.parse(hash)
end