Selling Partner API SDK for JavaScript

    Variable detailPageTrafficEventNotificationConst

    detailPageTrafficEventNotification: {
        $id: "https://example.com/example.json";
        definitions: {
            DetailPageTrafficEvent: {
                examples: readonly [
                    {
                        accountId: "amzn1.merchant.o.A21CXK3C4ERTY8";
                        asin: "B00032HE0O";
                        endTime: "2023-02-07T16:00:00Z";
                        glanceViews: 42;
                        marketplaceId: "ATVPDKIKX0DER";
                        startTime: "2023-02-07T15:00:00Z";
                    },
                ];
                properties: {
                    accountId: {
                        $id: "#/definitions/DetailPageTrafficEvent/properties/accountId";
                        description: "The merchant customer ID or vendor group ID of the partner account this notification is sent to.";
                        examples: readonly [
                            "amzn1.merchant.o.A21CXK3C4ERTY8",
                            "amzn1.vg.6213651",
                        ];
                        type: "string";
                    };
                    asin: {
                        $id: "#/definitions/DetailPageTrafficEvent/properties/asin";
                        description: "The Amazon Standard Identification Number of the product.";
                        examples: readonly ["B00032HE0O"];
                        type: "string";
                    };
                    endTime: {
                        $id: "#/definitions/DetailPageTrafficEvent/properties/endTime";
                        description: "The end of the date-time range of the traffic data in ISO 8601 format in UTC time.";
                        examples: readonly ["2023-02-07T16:00:00Z"];
                        format: "date-time";
                        type: "string";
                    };
                    glanceViews: {
                        $id: "#/definitions/DetailPageTrafficEvent/properties/glanceViews";
                        description: "The number of customer views of the product detail page for this ASIN.";
                        examples: readonly [42];
                        minimum: 0;
                        type: "integer";
                    };
                    marketplaceId: {
                        $id: "#/definitions/DetailPageTrafficEvent/properties/marketplaceId";
                        description: "The marketplace identifier of the traffic data.";
                        examples: readonly ["ATVPDKIKX0DER"];
                        type: "string";
                    };
                    startTime: {
                        $id: "#/definitions/DetailPageTrafficEvent/properties/startTime";
                        description: "The start of the date-time range of the traffic data in ISO 8601 format in UTC time.";
                        examples: readonly ["2023-02-07T15:00:00Z"];
                        format: "date-time";
                        type: "string";
                    };
                };
                required: readonly [
                    "accountId",
                    "marketplaceId",
                    "startTime",
                    "endTime",
                    "asin",
                    "glanceViews",
                ];
                type: "object";
            };
            DetailPageTrafficEvents: {
                examples: readonly [
                    readonly [
                        {
                            accountId: "amzn1.merchant.o.A21CXK3C4ERTY8";
                            asin: "B00032HE0O";
                            endTime: "2023-02-07T16:00:00Z";
                            glanceViews: 42;
                            marketplaceId: "ATVPDKIKX0DER";
                            startTime: "2023-02-07T15:00:00Z";
                        },
                        {
                            accountId: "amzn1.merchant.o.A21CXK3C4ERTY8";
                            asin: "B00094A20U";
                            endTime: "2023-02-07T16:00:00Z";
                            glanceViews: 69;
                            marketplaceId: "ATVPDKIKX0DER";
                            startTime: "2023-02-07T15:00:00Z";
                        },
                    ],
                ];
                items: { $ref: "#/definitions/DetailPageTrafficEvent" };
                type: "array";
            };
            NotificationMetadata: {
                examples: readonly [
                    {
                        applicationId: "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336";
                        notificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746";
                        publishTime: "2023-02-07T16:45:32.378Z";
                        subscriptionId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746";
                    },
                ];
                properties: {
                    applicationId: {
                        $id: "#/definitions/NotificationMetadata/properties/applicationId";
                        examples: readonly [
                            "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336",
                        ];
                        type: "string";
                    };
                    notificationId: {
                        $id: "#/definitions/NotificationMetadata/properties/notificationId";
                        examples: readonly ["d0e9e693-c3ad-4373-979f-ed4ec98dd746"];
                        type: "string";
                    };
                    publishTime: {
                        $id: "#/definitions/NotificationMetadata/properties/publishTime";
                        examples: readonly ["2023-02-07T16:45:32.378Z"];
                        type: "string";
                    };
                    subscriptionId: {
                        $id: "#/definitions/NotificationMetadata/properties/subscriptionId";
                        examples: readonly ["d0e9e693-c3ad-4373-979f-ed4ec98dd746"];
                        type: "string";
                    };
                };
                required: readonly [
                    "applicationId",
                    "subscriptionId",
                    "publishTime",
                    "notificationId",
                ];
                type: "object";
            };
            Payload: {
                examples: readonly [
                    {
                        detailPageTrafficEvents: readonly [
                            {
                                accountId: "amzn1.merchant.o.A21CXK3C4ERTY8";
                                asin: "B00032HE0O";
                                endTime: "2023-02-07T16:00:00Z";
                                glanceViews: 42;
                                marketplaceId: "ATVPDKIKX0DER";
                                startTime: "2023-02-07T15:00:00Z";
                            },
                            {
                                accountId: "amzn1.merchant.o.A21CXK3C4ERTY8";
                                asin: "B00094A20U";
                                endTime: "2023-02-07T16:00:00Z";
                                glanceViews: 69;
                                marketplaceId: "ATVPDKIKX0DER";
                                startTime: "2023-02-07T15:00:00Z";
                            },
                        ];
                    },
                ];
                properties: {
                    detailPageTrafficEvents: {
                        $id: "#/definitions/Payload/properties/detailPageTrafficEvents";
                        $ref: "#/definitions/DetailPageTrafficEvents";
                    };
                };
                required: readonly ["detailPageTrafficEvents"];
                type: "object";
            };
        };
        description: "The root schema comprises the entire JSON document.";
        examples: readonly [
            {
                eventTime: "2023-02-07T16:05:32.378Z";
                notificationMetadata: {
                    applicationId: "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336";
                    notificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746";
                    publishTime: "2023-02-07T16:45:32.378Z";
                    subscriptionId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746";
                };
                notificationType: "DETAIL_PAGE_TRAFFIC_EVENT";
                notificationVersion: "2020-09-04";
                payload: {
                    detailPageTrafficEvents: readonly [
                        {
                            accountId: "amzn1.merchant.o.A21CXK3C4ERTY8";
                            asin: "B00032HE0O";
                            endTime: "2023-02-07T16:00:00Z";
                            glanceViews: 42;
                            marketplaceId: "ATVPDKIKX0DER";
                            startTime: "2023-02-07T15:00:00Z";
                        },
                        {
                            accountId: "amzn1.merchant.o.A21CXK3C4ERTY8";
                            asin: "B00094A20U";
                            endTime: "2023-02-07T16:00:00Z";
                            glanceViews: 69;
                            marketplaceId: "ATVPDKIKX0DER";
                            startTime: "2023-02-07T15:00:00Z";
                        },
                    ];
                };
                payloadVersion: "2020-09-04";
            },
        ];
        properties: {
            eventTime: {
                $id: "#/properties/eventTime";
                examples: readonly ["2023-02-07T16:45:32.378Z"];
                type: "string";
            };
            notificationMetadata: {
                $id: "#/properties/notificationMetadata";
                $ref: "#/definitions/NotificationMetadata";
            };
            notificationType: {
                $id: "#/properties/notificationType";
                examples: readonly ["DETAIL_PAGE_TRAFFIC_EVENT"];
                type: "string";
            };
            notificationVersion: {
                $id: "#/properties/notificationVersion";
                examples: readonly ["2020-09-04"];
                type: "string";
            };
            payload: { $id: "#/properties/payload"; $ref: "#/definitions/Payload" };
            payloadVersion: {
                $id: "#/properties/payloadVersion";
                examples: readonly ["2020-09-04"];
                type: "string";
            };
        };
        required: readonly [
            "notificationVersion",
            "notificationType",
            "payloadVersion",
            "eventTime",
            "payload",
            "notificationMetadata",
        ];
        type: "object";
    } = ...

    Type declaration

    • Readonly$id: "https://example.com/example.json"
    • Readonlydefinitions: {
          DetailPageTrafficEvent: {
              examples: readonly [
                  {
                      accountId: "amzn1.merchant.o.A21CXK3C4ERTY8";
                      asin: "B00032HE0O";
                      endTime: "2023-02-07T16:00:00Z";
                      glanceViews: 42;
                      marketplaceId: "ATVPDKIKX0DER";
                      startTime: "2023-02-07T15:00:00Z";
                  },
              ];
              properties: {
                  accountId: {
                      $id: "#/definitions/DetailPageTrafficEvent/properties/accountId";
                      description: "The merchant customer ID or vendor group ID of the partner account this notification is sent to.";
                      examples: readonly [
                          "amzn1.merchant.o.A21CXK3C4ERTY8",
                          "amzn1.vg.6213651",
                      ];
                      type: "string";
                  };
                  asin: {
                      $id: "#/definitions/DetailPageTrafficEvent/properties/asin";
                      description: "The Amazon Standard Identification Number of the product.";
                      examples: readonly ["B00032HE0O"];
                      type: "string";
                  };
                  endTime: {
                      $id: "#/definitions/DetailPageTrafficEvent/properties/endTime";
                      description: "The end of the date-time range of the traffic data in ISO 8601 format in UTC time.";
                      examples: readonly ["2023-02-07T16:00:00Z"];
                      format: "date-time";
                      type: "string";
                  };
                  glanceViews: {
                      $id: "#/definitions/DetailPageTrafficEvent/properties/glanceViews";
                      description: "The number of customer views of the product detail page for this ASIN.";
                      examples: readonly [42];
                      minimum: 0;
                      type: "integer";
                  };
                  marketplaceId: {
                      $id: "#/definitions/DetailPageTrafficEvent/properties/marketplaceId";
                      description: "The marketplace identifier of the traffic data.";
                      examples: readonly ["ATVPDKIKX0DER"];
                      type: "string";
                  };
                  startTime: {
                      $id: "#/definitions/DetailPageTrafficEvent/properties/startTime";
                      description: "The start of the date-time range of the traffic data in ISO 8601 format in UTC time.";
                      examples: readonly ["2023-02-07T15:00:00Z"];
                      format: "date-time";
                      type: "string";
                  };
              };
              required: readonly [
                  "accountId",
                  "marketplaceId",
                  "startTime",
                  "endTime",
                  "asin",
                  "glanceViews",
              ];
              type: "object";
          };
          DetailPageTrafficEvents: {
              examples: readonly [
                  readonly [
                      {
                          accountId: "amzn1.merchant.o.A21CXK3C4ERTY8";
                          asin: "B00032HE0O";
                          endTime: "2023-02-07T16:00:00Z";
                          glanceViews: 42;
                          marketplaceId: "ATVPDKIKX0DER";
                          startTime: "2023-02-07T15:00:00Z";
                      },
                      {
                          accountId: "amzn1.merchant.o.A21CXK3C4ERTY8";
                          asin: "B00094A20U";
                          endTime: "2023-02-07T16:00:00Z";
                          glanceViews: 69;
                          marketplaceId: "ATVPDKIKX0DER";
                          startTime: "2023-02-07T15:00:00Z";
                      },
                  ],
              ];
              items: { $ref: "#/definitions/DetailPageTrafficEvent" };
              type: "array";
          };
          NotificationMetadata: {
              examples: readonly [
                  {
                      applicationId: "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336";
                      notificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746";
                      publishTime: "2023-02-07T16:45:32.378Z";
                      subscriptionId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746";
                  },
              ];
              properties: {
                  applicationId: {
                      $id: "#/definitions/NotificationMetadata/properties/applicationId";
                      examples: readonly [
                          "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336",
                      ];
                      type: "string";
                  };
                  notificationId: {
                      $id: "#/definitions/NotificationMetadata/properties/notificationId";
                      examples: readonly ["d0e9e693-c3ad-4373-979f-ed4ec98dd746"];
                      type: "string";
                  };
                  publishTime: {
                      $id: "#/definitions/NotificationMetadata/properties/publishTime";
                      examples: readonly ["2023-02-07T16:45:32.378Z"];
                      type: "string";
                  };
                  subscriptionId: {
                      $id: "#/definitions/NotificationMetadata/properties/subscriptionId";
                      examples: readonly ["d0e9e693-c3ad-4373-979f-ed4ec98dd746"];
                      type: "string";
                  };
              };
              required: readonly [
                  "applicationId",
                  "subscriptionId",
                  "publishTime",
                  "notificationId",
              ];
              type: "object";
          };
          Payload: {
              examples: readonly [
                  {
                      detailPageTrafficEvents: readonly [
                          {
                              accountId: "amzn1.merchant.o.A21CXK3C4ERTY8";
                              asin: "B00032HE0O";
                              endTime: "2023-02-07T16:00:00Z";
                              glanceViews: 42;
                              marketplaceId: "ATVPDKIKX0DER";
                              startTime: "2023-02-07T15:00:00Z";
                          },
                          {
                              accountId: "amzn1.merchant.o.A21CXK3C4ERTY8";
                              asin: "B00094A20U";
                              endTime: "2023-02-07T16:00:00Z";
                              glanceViews: 69;
                              marketplaceId: "ATVPDKIKX0DER";
                              startTime: "2023-02-07T15:00:00Z";
                          },
                      ];
                  },
              ];
              properties: {
                  detailPageTrafficEvents: {
                      $id: "#/definitions/Payload/properties/detailPageTrafficEvents";
                      $ref: "#/definitions/DetailPageTrafficEvents";
                  };
              };
              required: readonly ["detailPageTrafficEvents"];
              type: "object";
          };
      }
    • Readonlydescription: "The root schema comprises the entire JSON document."
    • Readonlyexamples: readonly [
          {
              eventTime: "2023-02-07T16:05:32.378Z";
              notificationMetadata: {
                  applicationId: "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336";
                  notificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746";
                  publishTime: "2023-02-07T16:45:32.378Z";
                  subscriptionId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746";
              };
              notificationType: "DETAIL_PAGE_TRAFFIC_EVENT";
              notificationVersion: "2020-09-04";
              payload: {
                  detailPageTrafficEvents: readonly [
                      {
                          accountId: "amzn1.merchant.o.A21CXK3C4ERTY8";
                          asin: "B00032HE0O";
                          endTime: "2023-02-07T16:00:00Z";
                          glanceViews: 42;
                          marketplaceId: "ATVPDKIKX0DER";
                          startTime: "2023-02-07T15:00:00Z";
                      },
                      {
                          accountId: "amzn1.merchant.o.A21CXK3C4ERTY8";
                          asin: "B00094A20U";
                          endTime: "2023-02-07T16:00:00Z";
                          glanceViews: 69;
                          marketplaceId: "ATVPDKIKX0DER";
                          startTime: "2023-02-07T15:00:00Z";
                      },
                  ];
              };
              payloadVersion: "2020-09-04";
          },
      ]
    • Readonlyproperties: {
          eventTime: {
              $id: "#/properties/eventTime";
              examples: readonly ["2023-02-07T16:45:32.378Z"];
              type: "string";
          };
          notificationMetadata: {
              $id: "#/properties/notificationMetadata";
              $ref: "#/definitions/NotificationMetadata";
          };
          notificationType: {
              $id: "#/properties/notificationType";
              examples: readonly ["DETAIL_PAGE_TRAFFIC_EVENT"];
              type: "string";
          };
          notificationVersion: {
              $id: "#/properties/notificationVersion";
              examples: readonly ["2020-09-04"];
              type: "string";
          };
          payload: { $id: "#/properties/payload"; $ref: "#/definitions/Payload" };
          payloadVersion: {
              $id: "#/properties/payloadVersion";
              examples: readonly ["2020-09-04"];
              type: "string";
          };
      }
    • Readonlyrequired: readonly [
          "notificationVersion",
          "notificationType",
          "payloadVersion",
          "eventTime",
          "payload",
          "notificationMetadata",
      ]
    • Readonlytype: "object"
    MMNEPVFCICPMFPCPTTAAATR