Variable sellerCouponReportConst

Type declaration

• Readonlydefinitions: {
      AsinDetails: {
          description: "Contains details about an asin.";
          examples: readonly [{ asin: "B08XJWMYR5" }, { asin: "B07Z7XTQKZ" }];
          properties: {
              asin: {
                  description: "The asin of the product.";
                  examples: readonly ["B08XJWMYR5"];
                  type: "string";
              };
          };
          required: readonly ["asin"];
          type: "object";
      };
      CouponDetails: {
          description: "Contains details about a coupon.";
          examples: readonly [
              {
                  asins: readonly [{ asin: "B08XJWMYR5" }, { asin: "B07Z7XTQKZ" }];
                  budget: 10000;
                  budgetPercentageUsed: 0.4;
                  budgetRemaining: 9957.71;
                  budgetSpent: 42.29;
                  clips: 13;
                  couponId: "A2NW32V27GZS2T";
                  currencyCode: "USD";
                  customerSegment: "All (Default)";
                  discountAmount: 10;
                  discountType: "PERCENT_OFF_LIST_PRICE";
                  endDateTime: "2021-11-29T23:59:59Z";
                  marketplaceId: "ATVPDKIKX0DER";
                  merchantId: "A21MAFL4G6JTR3";
                  name: "Product $40 Off";
                  redemptions: 1;
                  sales: 62.1;
                  startDateTime: "2021-11-26T05:59:59Z";
                  totalDiscount: 40;
                  websiteMessage: "Save on BrandX Product";
              },
          ];
          properties: {
              asins: {
                  description: "Products associated with the coupon.";
                  items: { $ref: "#/definitions/AsinDetails" };
                  type: "array";
              };
              budget: {
                  description: "The budget allocated to the coupon to cover discount offering and clip/redemption fees. Currency value.";
                  examples: readonly [10000];
                  minimum: 0;
                  type: "number";
              };
              budgetPercentageUsed: {
                  description: "Percentage of the allocated budget that has been spent, equal to the budgetSpent divided by budget.";
                  examples: readonly [0.4];
                  maximum: 100;
                  minimum: 0;
                  type: "number";
              };
              budgetRemaining: {
                  description: "The budget remaining for the coupon, equal to budget minus budgetSpent. Currency value. Represents a gross value, including purchases that were returned or cancelled.";
                  examples: readonly [9957.71];
                  minimum: 0;
                  type: "number";
              };
              budgetSpent: {
                  description: "Total amount spent by the seller on the coupon, including clip fees and redemption fees. Currency value. Represents a gross value, including purchases that were returned or cancelled.";
                  examples: readonly [42.29];
                  minimum: 0;
                  type: "number";
              };
              clips: {
                  description: "Number of times the coupon has been applied on the product page by unique customers.";
                  examples: readonly [13];
                  minimum: 0;
                  type: "integer";
              };
              couponId: {
                  description: "Unique identifier of the coupon.";
                  examples: readonly ["A2NW32V27GZS2T"];
                  type: "string";
              };
              currencyCode: {
                  description: "The ISO 4217 currency code of all currency values in the coupon.";
                  examples: readonly ["USD"];
                  type: "string";
              };
              customerSegment: {
                  description: "Customer segment that the coupon is available to.";
                  examples: readonly ["All (Default)", "Amazon Prime", "Amazon Student"];
                  type: "string";
              };
              discountAmount: {
                  description: "Discount amount the customer receives. Reflects a percentage when discountType is PERCENT_OFF_LIST_PRICE and a currency value when discountType is AMOUNT_OFF_LIST_PRICE.";
                  examples: readonly [10];
                  minimum: 0;
                  type: "number";
              };
              discountType: {
                  description: "Whether the discount is given as a fixed amount or a percentage off the list price.";
                  enum: readonly ["PERCENT_OFF_LIST_PRICE", "AMOUNT_OFF_LIST_PRICE"];
                  type: "string";
              };
              endDateTime: {
                  description: "Coupon end date-time in UTC.";
                  examples: readonly ["2021-11-29T23:59:59Z"];
                  format: "date-time";
                  type: "string";
              };
              marketplaceId: {
                  description: "Marketplace the coupon is running in.";
                  examples: readonly ["ATVPDKIKX0DER"];
                  type: "string";
              };
              merchantId: {
                  description: "Merchant customer ID associated with the coupon.";
                  examples: readonly ["A21MAFL4G6JTR3"];
                  type: "string";
              };
              name: {
                  description: "The name given to the coupon.";
                  examples: readonly ["Product $40 Off"];
                  type: "string";
              };
              redemptions: {
                  description: "Number of times the coupon has been used for a purchase. Represents a gross value, including purchases that were returned or cancelled.";
                  examples: readonly [1];
                  minimum: 0;
                  type: "integer";
              };
              sales: {
                  description: "Total revenue generated by redemptions of the coupon after the discount. Currency value. Represents a gross value, including purchases that were returned or cancelled.";
                  examples: readonly [62.1];
                  minimum: 0;
                  type: "number";
              };
              startDateTime: {
                  description: "Coupon start date-time in UTC.";
                  examples: readonly ["2021-11-26T05:59:59Z"];
                  format: "date-time";
                  type: "string";
              };
              totalDiscount: {
                  description: "Total amount saved by customers redeeming the coupon. Currency value. Represents a gross value, including purchases that were returned or cancelled.";
                  examples: readonly [40];
                  minimum: 0;
                  type: "number";
              };
              websiteMessage: {
                  description: "The message displayed with the coupon on the product page.";
                  examples: readonly ["Save on BrandX Product"];
                  type: "string";
              };
          };
          required: readonly [
              "couponId",
              "merchantId",
              "marketplaceId",
              "currencyCode",
              "startDateTime",
              "endDateTime",
              "customerSegment",
              "clips",
              "redemptions",
              "totalDiscount",
              "budgetSpent",
              "budgetPercentageUsed",
              "asins",
          ];
          type: "object";
      };
  }

• Readonlydescription: "This report contains data to help sellers optimize their coupons and adjust their advertising strategies. This report supports start dates up to two years before the current date."

• Readonlyexamples: readonly [
      {
          coupons: readonly [
              {
                  asins: readonly [{ asin: "B08XJWMYR5" }, { asin: "B07Z7XTQKZ" }];
                  budget: 10000;
                  budgetPercentageUsed: 0.4;
                  budgetRemaining: 9957.71;
                  budgetSpent: 42.29;
                  clips: 13;
                  couponId: "A2NW32V27GZS2T";
                  currencyCode: "USD";
                  customerSegment: "All (Default)";
                  discountAmount: 10;
                  discountType: "PERCENT_OFF_LIST_PRICE";
                  endDateTime: "2021-11-29T23:59:59Z";
                  marketplaceId: "ATVPDKIKX0DER";
                  merchantId: "A21MAFL4G6JTR3";
                  name: "Product $40 Off";
                  redemptions: 1;
                  sales: 62.1;
                  startDateTime: "2021-11-26T05:59:59Z";
                  totalDiscount: 40;
                  websiteMessage: "Save on BrandX Product";
              },
          ];
          reportSpecification: {
              marketplaceIds: readonly ["ATVPDKIKX0DER"];
              reportOptions: {
                  couponStartDateFrom: "2021-11-01T15:33:26Z";
                  couponStartDateTo: "2021-11-30T15:33:26Z";
              };
              reportType: "GET_COUPON_PERFORMANCE_REPORT";
          };
      },
  ]

• Readonlyproperties: {
      coupons: {
          description: "A list of included coupons.";
          items: { $ref: "#/definitions/CouponDetails" };
          type: "array";
      };
      reportSpecification: {
          description: "Summarizes the original report request.";
          examples: readonly [
              {
                  marketplaceIds: readonly ["ATVPDKIKX0DER"];
                  reportOptions: {
                      couponStartDateFrom: "2021-11-01T15:33:26Z";
                      couponStartDateTo: "2021-11-30T15:33:26Z";
                  };
                  reportType: "GET_COUPON_PERFORMANCE_REPORT";
              },
          ];
          properties: {
              marketplaceIds: {
                  description: "Marketplace IDs as 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 parameters couponStartDateFrom and couponStartDateTo.";
                  properties: {
                      couponStartDateFrom: {
                          description: "The start of a date-time range in UTC used for selecting coupons to report on. All coupons with a start date-time that falls within the range will be included.";
                          examples: readonly ["2021-11-01T15:33:26Z"];
                          format: "date-time";
                          type: "string";
                      };
                      couponStartDateTo: {
                          description: "The end of a date-time range in UTC used for selecting coupons to report on. All coupons with a start date-time that falls within the range will be included.";
                          examples: readonly ["2021-11-30T15:33:26Z"];
                          format: "date-time";
                          type: "string";
                      };
                  };
                  required: readonly ["couponStartDateFrom", "couponStartDateTo"];
                  type: "object";
              };
              reportType: {
                  description: "The report type.";
                  examples: readonly ["GET_COUPON_PERFORMANCE_REPORT"];
                  type: "string";
              };
          };
          required: readonly ["reportType", "reportOptions", "marketplaceIds"];
          type: "object";
      };
  }

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

• Readonlytype: "object"