@apptus/esales-api/src/models/sponsored-page.ts

Library for making requests to Elevate 4 API v3

import type { BaseParams } from './common/mod.ts';
import type { SponsoredList } from './mod.ts';


export interface SponsoredPageParams extends BaseParams {
  /**
   * Required if the `Referer` header is missing, used to identify the current page.
   * Any string is accepted, but using URLs is a good practice to follow.
   */
  pageReference: string;
    /**
   * The ID of a response template to apply to all product lists returned.
   *
   * Templates can adjust which attributes are returned for products, and makes
   * `presentCustom` unnecessary. Templates can be imported via the Admin API.
   * @see https://docs.apptus.com/elevate/4/guides/product-list-response-templates/
   */
  templateId?: string;
}

export interface SponsoredPage {
  /** Lists with winners and sponsored, sort orders and hit count */
  sponsoredLists: SponsoredList[];
};