Variable promotionReportConst

Type declaration

• Readonlydefinitions: {
      DetailsByProduct: {
          description: "An object that contains details about a product.";
          examples: readonly [
              {
                  asin: "B08755Z2ND";
                  productAmountSpent: 4425.22;
                  productAmountSpentCurrencyCode: "USD";
                  productGlanceViews: 380;
                  productName: "BrandX Product, Travel Size, 3 Pack";
                  productRevenue: 16371.85;
                  productRevenueCurrencyCode: "USD";
                  productUnitsSold: 20;
              },
          ];
          properties: {
              asin: {
                  description: "The product ASIN.";
                  examples: readonly ["B08755Z2ND"];
                  type: "string";
              };
              productAmountSpent: {
                  description: "Total funding provided by the vendor at the ASIN level. For vendors only.";
                  examples: readonly [4425.22];
                  minimum: 0;
                  type: "number";
              };
              productAmountSpentCurrencyCode: {
                  description: "ISO 4217 currency code of productAmountSpent.";
                  examples: readonly ["USD"];
                  type: "string";
              };
              productGlanceViews: {
                  description: "The number of customer views of the product detail page.";
                  examples: readonly [380];
                  minimum: 0;
                  type: "integer";
              };
              productName: {
                  description: "The product name.";
                  examples: readonly ["BrandX Product, Travel Size, 3 Pack"];
                  type: "string";
              };
              productRevenue: {
                  description: "The total revenue generated at the ASIN level. For sellers, this is equivalent to \"sales\" in the Seller Central UI.";
                  examples: readonly [16371.85];
                  minimum: 0;
                  type: "number";
              };
              productRevenueCurrencyCode: {
                  description: "ISO 4217 currency code of productRevenue.";
                  examples: readonly ["USD"];
                  type: "string";
              };
              productUnitsSold: {
                  description: "The number of units sold at the promotional price.";
                  examples: readonly [20];
                  minimum: 0;
                  type: "integer";
              };
          };
          required: readonly [
              "asin",
              "productName",
              "productUnitsSold",
              "productRevenue",
              "productRevenueCurrencyCode",
          ];
          type: "object";
      };
      DetailsByPromotion: {
          description: "An object that contains details about a promotion and every included product.";
          examples: readonly [
              {
                  amountSpent: 9338.2;
                  amountSpentCurrencyCode: "USD";
                  createdDateTime: "2020-09-18T13:24:39Z";
                  creationChannel: "SELF-SERVICE";
                  endDateTime: "2020-11-23T12:34:56Z";
                  fundingAgreementId: "58985408";
                  glanceViews: 41084;
                  includedProducts: readonly [
                      {
                          asin: "B08755Z2ND";
                          productAmountSpent: 4425.22;
                          productAmountSpentCurrencyCode: "USD";
                          productGlanceViews: 380;
                          productName: "Save on BrandX Product Name";
                          productRevenue: 16371.85;
                          productRevenueCurrencyCode: "USD";
                          productUnitsSold: 20;
                      },
                  ];
                  lastUpdatedDateTime: "2020-09-18T13:24:39Z";
                  marketplaceId: "ATVPDKIKX0DER";
                  merchantId: "A21MAFL4G6JTR3";
                  promotionId: "16913551269";
                  promotionName: "Save on BrandX Product Name";
                  revenue: 32917.01;
                  revenueCurrencyCode: "USD";
                  startDateTime: "2020-11-23T12:34:56Z";
                  status: "APPROVED";
                  type: "BEST_DEAL";
                  unitsSold: 121;
                  vendorCode: "ABCDE";
              },
          ];
          properties: {
              amountSpent: {
                  description: "Total funding provided across all ASINs in the promotion. For vendors only.";
                  examples: readonly [9338.2];
                  minimum: 0;
                  type: "number";
              };
              amountSpentCurrencyCode: {
                  description: "The ISO 4217 currency code of amountSpent.";
                  examples: readonly ["USD"];
                  type: "string";
              };
              createdDateTime: {
                  description: "The promotion creation date-time in ISO 8601 format in UTC.";
                  examples: readonly ["2020-09-18T13:24:39Z"];
                  format: "date-time";
                  type: "string";
              };
              creationChannel: {
                  description: "The mode of creation for the promotion.";
                  enum: readonly ["SELF-SERVICE", "FULL-SERVICE", "AUTOMATED", "MANUAL"];
                  type: "string";
                  "x-docgen-enum-table-extension": readonly [
                      {
                          description: "Created by the vendor/seller directly in Vendor/Seller Central.";
                          value: "SELF-SERVICE";
                      },
                      {
                          description: "Created on behalf of the vendor/seller by account managers.";
                          value: "FULL-SERVICE";
                      },
                      {
                          description: "Created automatically by a system in response to a trigger. For example, Deal-O-Matic.";
                          value: "AUTOMATED";
                      },
                      {
                          description: "Only used for digital point-of-sale discounts created in Vendisto.";
                          value: "MANUAL";
                      },
                  ];
              };
              endDateTime: {
                  description: "Promotion end date-time in ISO 8601 format in UTC.";
                  examples: readonly ["2020-11-23T12:34:56Z"];
                  format: "date-time";
                  type: "string";
              };
              fundingAgreementId: {
                  description: "The ID for the funding agreement. For vendors only.";
                  examples: readonly ["58985408"];
                  type: "string";
              };
              glanceViews: {
                  description: "The total customer views for all product detail pages.";
                  examples: readonly [41084];
                  minimum: 0;
                  type: "integer";
              };
              includedProducts: {
                  description: "List of included products and their details.";
                  items: { $ref: "#/definitions/DetailsByProduct" };
                  type: "array";
              };
              lastUpdatedDateTime: {
                  description: "The promotion last updated date-time in ISO 8601 format in UTC.";
                  examples: readonly ["2020-09-18T13:24:39Z"];
                  format: "date-time";
                  type: "string";
              };
              marketplaceId: {
                  description: "The marketplace the promotion is running in.";
                  examples: readonly ["ATVPDKIKX0DER"];
                  type: "string";
              };
              merchantId: {
                  description: "The merchant customer ID associated with the promotion funding agreement. For sellers only.";
                  examples: readonly ["A21MAFL4G6JTR3"];
                  type: "string";
              };
              promotionId: {
                  description: "The unique identifier of the promotion.";
                  examples: readonly ["16913551269"];
                  type: "string";
              };
              promotionName: {
                  description: "The customer facing name of the promotion.";
                  examples: readonly ["Save on BrandX Product Name"];
                  type: "string";
              };
              revenue: {
                  description: "The total revenue generated across all ASINs in the promotion. For sellers, this is equivalent to \"sales\" in the Seller Central UI.";
                  examples: readonly [32917.01];
                  minimum: 0;
                  type: "number";
              };
              revenueCurrencyCode: {
                  description: "The ISO 4217 currency code of revenue.";
                  examples: readonly ["USD"];
                  type: "string";
              };
              startDateTime: {
                  description: "Promotion start date-time in ISO 8601 format in UTC.";
                  examples: readonly ["2020-11-23T12:34:56Z"];
                  format: "date-time";
                  type: "string";
              };
              status: {
                  description: "The state that the promotion is in.";
                  enum: readonly [
                      "APPROVED",
                      "PENDING_APPROVAL",
                      "NEEDS_YOUR_ATTENTION",
                      "CANCELED",
                  ];
                  type: "string";
              };
              type: {
                  description: "The type of the promotion.";
                  enum: readonly [
                      "BEST_DEAL",
                      "DEAL_OF_THE_DAY",
                      "LIGHTNING_DEAL",
                      "PRICE_DISCOUNT",
                      "SALES_DISCOUNT",
                      "COUPON",
                      "PROMO_CODE",
                  ];
                  type: "string";
              };
              unitsSold: {
                  description: "The number of units sold across all ASINs in the promotion.";
                  examples: readonly [121];
                  minimum: 0;
                  type: "integer";
              };
              vendorCode: {
                  description: "The vendor code associated with the promotion funding agreement. For vendors only.";
                  examples: readonly ["ABCDE"];
                  type: "string";
              };
          };
          required: readonly [
              "promotionId",
              "promotionName",
              "unitsSold",
              "revenue",
              "revenueCurrencyCode",
              "startDateTime",
              "endDateTime",
              "type",
              "status",
              "creationChannel",
              "marketplaceId",
              "createdDateTime",
              "lastUpdatedDateTime",
              "includedProducts",
          ];
          type: "object";
      };
  }

• Readonlydescription: "The Promotion Performance report contains data to help vendors optimize their promotions and adjust their advertising strategies. Currently three promotion types are supported: Best Deal, Lightning Deal, and Price Discount. This report supports start dates up to two years before the current date."

• Readonlyexamples: readonly [
      {
          promotions: readonly [
              {
                  amountSpent: 9338.2;
                  amountSpentCurrencyCode: "USD";
                  createdDateTime: "2020-09-18T13:24:39Z";
                  creationChannel: "SELF-SERVICE";
                  endDateTime: "2020-11-23T12:34:56Z";
                  fundingAgreementId: "58985408";
                  glanceViews: 41084;
                  includedProducts: readonly [
                      {
                          asin: "B08755Z2ND";
                          productAmountSpent: 4425.22;
                          productAmountSpentCurrencyCode: "USD";
                          productGlanceViews: 380;
                          productName: "BrandX Product, Travel Size, 3 Pack";
                          productRevenue: 16371.85;
                          productRevenueCurrencyCode: "USD";
                          productUnitsSold: 20;
                      },
                  ];
                  lastUpdatedDateTime: "2020-09-18T13:24:39Z";
                  marketplaceId: "ATVPDKIKX0DER";
                  merchantId: "A21MAFL4G6JTR3";
                  promotionId: "16913551269";
                  promotionName: "Save on BrandX Product Name";
                  revenue: 32917.01;
                  revenueCurrencyCode: "USD";
                  startDateTime: "2020-11-23T12:34:56Z";
                  status: "APPROVED";
                  type: "BEST_DEAL";
                  unitsSold: 121;
                  vendorCode: "ABCDE";
              },
          ];
          reportSpecification: {
              marketplaceIds: readonly ["ATVPDKIKX0DER"];
              reportOptions: {
                  promotionStartDateFrom: "2020-11-23T15:33:26Z";
                  promotionStartDateTo: "2020-12-06T15:33:26Z";
              };
              reportType: "GET_PROMOTION_PERFORMANCE_REPORT";
          };
      },
  ]

• Readonlyproperties: {
      promotions: {
          description: "The list of included promotions.";
          items: { $ref: "#/definitions/DetailsByPromotion" };
          type: "array";
      };
      reportSpecification: {
          description: "Summarizes the original report request.";
          examples: readonly [
              {
                  marketplaceIds: readonly ["ATVPDKIKX0DER"];
                  reportOptions: {
                      promotionStartDateFrom: "2020-11-23T15:33:26Z";
                      promotionStartDateTo: "2020-12-06T15:33:26Z";
                  };
                  reportType: "GET_PROMOTION_PERFORMANCE_REPORT";
              },
          ];
          properties: {
              marketplaceIds: {
                  description: "The marketplace IDs specified in the report request.";
                  examples: readonly [readonly ["ATVPDKIKX0DER"]];
                  items: {
                      description: "The marketplace ID.";
                      examples: readonly ["ATVPDKIKX0DER"];
                      type: "string";
                  };
                  type: "array";
              };
              reportOptions: {
                  description: "Report options specifying the parameters promotionStartDateFrom and promotionStartDateTo.";
                  properties: {
                      promotionStartDateFrom: {
                          description: "The start of a date and time range in ISO 8601 format used for selecting promotions to report on. All promotions with a start date-time that falls within the range will be included.";
                          examples: readonly ["2020-11-23T15:33:26Z"];
                          format: "date-time";
                          type: "string";
                      };
                      promotionStartDateTo: {
                          description: "The end of a date and time range in ISO 8601 format used for selecting promotions to report on. All promotions with a start date-time that falls within the range will be included.";
                          examples: readonly ["2020-12-06T15:33:26Z"];
                          format: "date-time";
                          type: "string";
                      };
                  };
                  required: readonly ["promotionStartDateFrom", "promotionStartDateTo"];
                  type: "object";
              };
              reportType: {
                  description: "The report type.";
                  examples: readonly ["GET_PROMOTION_PERFORMANCE_REPORT"];
                  type: "string";
              };
          };
          required: readonly ["reportType", "reportOptions", "marketplaceIds"];
          type: "object";
      };
  }

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

• Readonlytype: "object"