Variable vendorForecastingReportConst

Type declaration

• Readonlydefinitions: {
      ForecastByAsin: {
          description: "Describes forecast units for a particular ASIN for a specific period of time in the future.";
          examples: readonly [
              {
                  asin: "B123456789";
                  endDate: "2021-06-12";
                  forecastGenerationDate: "2021-06-06";
                  meanForecastUnits: 3.1;
                  p70ForecastUnits: 3.7;
                  p80ForecastUnits: 30.2;
                  p90ForecastUnits: 300.8;
                  startDate: "2021-06-06";
              },
          ];
          properties: {
              asin: {
                  description: "The Amazon Standard Identification Number.";
                  examples: readonly ["B123456789"];
                  type: "string";
              };
              endDate: {
                  description: "The end date of the time period being forecasted. The forecasted time period includes this date.";
                  examples: readonly ["2021-06-12"];
                  format: "date";
                  type: "string";
              };
              forecastGenerationDate: {
                  description: "The date that the forecast was generated.";
                  examples: readonly ["2021-06-06"];
                  format: "date";
                  type: "string";
              };
              meanForecastUnits: {
                  description: "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.";
                  examples: readonly [1.25];
                  minimum: 0;
                  type: "number";
              };
              p70ForecastUnits: {
                  description: "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.";
                  examples: readonly [2.25];
                  minimum: 0;
                  type: "number";
              };
              p80ForecastUnits: {
                  description: "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.";
                  examples: readonly [3.25];
                  minimum: 0;
                  type: "number";
              };
              p90ForecastUnits: {
                  description: "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.";
                  examples: readonly [4.25];
                  minimum: 0;
                  type: "number";
              };
              startDate: {
                  description: "The start date of the time period being forecasted. The forecasted time period includes this date.";
                  examples: readonly ["2021-06-06"];
                  format: "date";
                  type: "string";
              };
          };
          required: readonly [
              "forecastGenerationDate",
              "asin",
              "startDate",
              "endDate",
              "meanForecastUnits",
              "p70ForecastUnits",
              "p80ForecastUnits",
              "p90ForecastUnits",
          ];
          type: "object";
      };
  }

• Readonlydescription: "Forecast customer demand of your products for production and inventory planning purposes."

• Readonlyexamples: readonly [
      {
          forecastByAsin: readonly [
              {
                  asin: "B123456789";
                  endDate: "2021-06-12";
                  forecastGenerationDate: "2021-06-06";
                  meanForecastUnits: 3.1;
                  p70ForecastUnits: 3.9;
                  p80ForecastUnits: 30.3;
                  p90ForecastUnits: 300.7;
                  startDate: "2021-06-06";
              },
              {
                  asin: "B123456789";
                  endDate: "2021-06-19";
                  forecastGenerationDate: "2021-06-06";
                  meanForecastUnits: 3.1;
                  p70ForecastUnits: 3.9;
                  p80ForecastUnits: 30.3;
                  p90ForecastUnits: 300.7;
                  startDate: "2021-06-13";
              },
              {
                  asin: "B123456789";
                  endDate: "2021-06-26";
                  forecastGenerationDate: "2021-06-06";
                  meanForecastUnits: 3.1;
                  p70ForecastUnits: 3.9;
                  p80ForecastUnits: 30.3;
                  p90ForecastUnits: 300.7;
                  startDate: "2021-06-20";
              },
              {
                  asin: "B123456789";
                  endDate: "2021-07-03";
                  forecastGenerationDate: "2021-06-06";
                  meanForecastUnits: 3.1;
                  p70ForecastUnits: 3.9;
                  p80ForecastUnits: 30.3;
                  p90ForecastUnits: 300.7;
                  startDate: "2021-06-27";
              },
              {
                  asin: "B123456789";
                  endDate: "2021-07-10";
                  forecastGenerationDate: "2021-06-06";
                  meanForecastUnits: 3.1;
                  p70ForecastUnits: 3.9;
                  p80ForecastUnits: 30.3;
                  p90ForecastUnits: 300.7;
                  startDate: "2021-07-04";
              },
              {
                  asin: "B123456789";
                  endDate: "2021-07-17";
                  forecastGenerationDate: "2021-06-06";
                  meanForecastUnits: 3.1;
                  p70ForecastUnits: 3.9;
                  p80ForecastUnits: 30.3;
                  p90ForecastUnits: 300.7;
                  startDate: "2021-07-11";
              },
              {
                  asin: "B123456789";
                  endDate: "2021-07-24";
                  forecastGenerationDate: "2021-06-06";
                  meanForecastUnits: 3.1;
                  p70ForecastUnits: 3.9;
                  p80ForecastUnits: 30.3;
                  p90ForecastUnits: 300.7;
                  startDate: "2021-07-18";
              },
              {
                  asin: "B123456789";
                  endDate: "2021-07-31";
                  forecastGenerationDate: "2021-06-06";
                  meanForecastUnits: 3.1;
                  p70ForecastUnits: 3.9;
                  p80ForecastUnits: 30.3;
                  p90ForecastUnits: 300.7;
                  startDate: "2021-07-25";
              },
              {
                  asin: "B123456789";
                  endDate: "2021-08-07";
                  forecastGenerationDate: "2021-06-06";
                  meanForecastUnits: 3.1;
                  p70ForecastUnits: 3.9;
                  p80ForecastUnits: 30.3;
                  p90ForecastUnits: 300.7;
                  startDate: "2021-08-01";
              },
              {
                  asin: "B123456789";
                  endDate: "2021-08-14";
                  forecastGenerationDate: "2021-06-06";
                  meanForecastUnits: 3.1;
                  p70ForecastUnits: 3.9;
                  p80ForecastUnits: 30.3;
                  p90ForecastUnits: 300.7;
                  startDate: "2021-08-08";
              },
              {
                  asin: "B123456789";
                  endDate: "2021-08-21";
                  forecastGenerationDate: "2021-06-06";
                  meanForecastUnits: 3.1;
                  p70ForecastUnits: 3.9;
                  p80ForecastUnits: 30.3;
                  p90ForecastUnits: 300.7;
                  startDate: "2021-08-15";
              },
              {
                  asin: "B123456789";
                  endDate: "2021-08-28";
                  forecastGenerationDate: "2021-06-06";
                  meanForecastUnits: 3.1;
                  p70ForecastUnits: 3.9;
                  p80ForecastUnits: 30.3;
                  p90ForecastUnits: 300.7;
                  startDate: "2021-08-22";
              },
              {
                  asin: "B123456789";
                  endDate: "2021-09-04";
                  forecastGenerationDate: "2021-06-06";
                  meanForecastUnits: 3.1;
                  p70ForecastUnits: 3.9;
                  p80ForecastUnits: 30.3;
                  p90ForecastUnits: 300.7;
                  startDate: "2021-08-29";
              },
              {
                  asin: "B123456789";
                  endDate: "2021-09-11";
                  forecastGenerationDate: "2021-06-06";
                  meanForecastUnits: 3.1;
                  p70ForecastUnits: 3.9;
                  p80ForecastUnits: 30.3;
                  p90ForecastUnits: 300.7;
                  startDate: "2021-09-05";
              },
              {
                  asin: "B123456789";
                  endDate: "2021-09-18";
                  forecastGenerationDate: "2021-06-06";
                  meanForecastUnits: 3.1;
                  p70ForecastUnits: 3.9;
                  p80ForecastUnits: 30.3;
                  p90ForecastUnits: 300.7;
                  startDate: "2021-09-12";
              },
              {
                  asin: "B123456789";
                  endDate: "2021-09-25";
                  forecastGenerationDate: "2021-06-06";
                  meanForecastUnits: 3.1;
                  p70ForecastUnits: 3.9;
                  p80ForecastUnits: 30.3;
                  p90ForecastUnits: 300.7;
                  startDate: "2021-09-19";
              },
              {
                  asin: "B123456789";
                  endDate: "2021-10-02";
                  forecastGenerationDate: "2021-06-06";
                  meanForecastUnits: 3.1;
                  p70ForecastUnits: 3.9;
                  p80ForecastUnits: 30.3;
                  p90ForecastUnits: 300.7;
                  startDate: "2021-09-26";
              },
              {
                  asin: "B123456789";
                  endDate: "2021-10-09";
                  forecastGenerationDate: "2021-06-06";
                  meanForecastUnits: 3.1;
                  p70ForecastUnits: 3.9;
                  p80ForecastUnits: 30.3;
                  p90ForecastUnits: 300.7;
                  startDate: "2021-10-03";
              },
              {
                  asin: "B123456789";
                  endDate: "2021-10-16";
                  forecastGenerationDate: "2021-06-06";
                  meanForecastUnits: 3.1;
                  p70ForecastUnits: 3.9;
                  p80ForecastUnits: 30.3;
                  p90ForecastUnits: 300.7;
                  startDate: "2021-10-10";
              },
              {
                  asin: "B123456789";
                  endDate: "2021-10-23";
                  forecastGenerationDate: "2021-06-06";
                  meanForecastUnits: 3.1;
                  p70ForecastUnits: 3.9;
                  p80ForecastUnits: 30.3;
                  p90ForecastUnits: 300.7;
                  startDate: "2021-10-17";
              },
              {
                  asin: "B123456789";
                  endDate: "2021-10-30";
                  forecastGenerationDate: "2021-06-06";
                  meanForecastUnits: 3.1;
                  p70ForecastUnits: 3.9;
                  p80ForecastUnits: 30.3;
                  p90ForecastUnits: 300.7;
                  startDate: "2021-10-24";
              },
              {
                  asin: "B123456789";
                  endDate: "2021-11-06";
                  forecastGenerationDate: "2021-06-06";
                  meanForecastUnits: 3.1;
                  p70ForecastUnits: 3.9;
                  p80ForecastUnits: 30.3;
                  p90ForecastUnits: 300.7;
                  startDate: "2021-10-31";
              },
              {
                  asin: "B123456789";
                  endDate: "2021-11-13";
                  forecastGenerationDate: "2021-06-06";
                  meanForecastUnits: 3.1;
                  p70ForecastUnits: 3.9;
                  p80ForecastUnits: 30.3;
                  p90ForecastUnits: 300.7;
                  startDate: "2021-11-07";
              },
              {
                  asin: "B123456789";
                  endDate: "2021-11-20";
                  forecastGenerationDate: "2021-06-06";
                  meanForecastUnits: 3.1;
                  p70ForecastUnits: 3.9;
                  p80ForecastUnits: 30.3;
                  p90ForecastUnits: 300.7;
                  startDate: "2021-11-14";
              },
              {
                  asin: "B123456789";
                  endDate: "2021-11-27";
                  forecastGenerationDate: "2021-06-06";
                  meanForecastUnits: 3.1;
                  p70ForecastUnits: 3.9;
                  p80ForecastUnits: 30.3;
                  p90ForecastUnits: 300.7;
                  startDate: "2021-11-21";
              },
              {
                  asin: "B123456789";
                  endDate: "2021-12-04";
                  forecastGenerationDate: "2021-06-06";
                  meanForecastUnits: 3.1;
                  p70ForecastUnits: 3.9;
                  p80ForecastUnits: 30.3;
                  p90ForecastUnits: 300.7;
                  startDate: "2021-11-28";
              },
              {
                  asin: "B123456789";
                  endDate: "2021-12-11";
                  forecastGenerationDate: "2021-06-06";
                  meanForecastUnits: 3.1;
                  p70ForecastUnits: 3.9;
                  p80ForecastUnits: 30.3;
                  p90ForecastUnits: 300.7;
                  startDate: "2021-12-05";
              },
          ];
          reportSpecification: {
              lastUpdatedDate: "2021-06-20";
              marketplaceIds: readonly ["ATVPDKIKX0DER"];
              reportOptions: { sellingProgram: "RETAIL" };
              reportType: "GET_VENDOR_FORECASTING_REPORT";
          };
      },
  ]

• Readonlyproperties: {
      forecastByAsin: {
          items: { $ref: "#/definitions/ForecastByAsin" };
          type: "array";
      };
      reportSpecification: {
          description: "The report input summary which includes the marketplace, selling program, and last updated date.";
          examples: readonly [
              {
                  lastUpdatedDate: "2021-06-20";
                  marketplaceIds: readonly ["ATVPDKIKX0DER"];
                  reportOptions: { sellingProgram: "RETAIL" };
                  reportType: "GET_VENDOR_FORECASTING_REPORT";
              },
          ];
          properties: {
              lastUpdatedDate: {
                  description: "The date when the report was last updated. Follows the <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> Date format of YYYY-MM-DD.";
                  examples: readonly ["2021-06-20"];
                  format: "date";
                  type: "string";
              };
              marketplaceIds: {
                  description: "This parameter must match the marketplaceId of the selling partner account. Each selling partner account belongs to only one marketplaceId.";
                  examples: readonly [readonly ["ATVPDKIKX0DER"]];
                  items: { type: "string" };
                  type: "array";
              };
              reportOptions: {
                  description: "Report options specifying parameters such as sellingProgram.";
                  examples: readonly [{ sellingProgram: "RETAIL" }];
                  properties: {
                      sellingProgram: {
                          description: "The selling program.";
                          enum: readonly ["RETAIL", "FRESH"];
                          type: "string";
                      };
                  };
                  required: readonly ["sellingProgram"];
                  type: "object";
              };
              reportType: {
                  description: "The report type.";
                  enum: readonly ["GET_VENDOR_FORECASTING_REPORT"];
                  type: "string";
              };
          };
          required: readonly [
              "reportType",
              "reportOptions",
              "lastUpdatedDate",
              "marketplaceIds",
          ];
          type: "object";
      };
  }

• Readonlyrequired: readonly ["reportSpecification", "forecastByAsin"]

• Readonlytype: "object"