EcommerceItemInfo | WebHare Platform SDK
WebHare Platform SDK
    Preparing search index...

    Type Alias EcommerceItemInfo

    EcommerceItemInfo: {
        affiliation?: string;
        coupon?: string;
        discount?: number;
        index?: number;
        item_brand?: string;
        item_category?: string;
        item_category2?: string;
        item_category3?: string;
        item_category4?: string;
        item_category5?: string;
        item_id?: string;
        item_list_id?: string;
        item_list_name?: string;
        item_name?: string;
        item_variant?: string;
        location_id?: string;
        price?: number;
        quantity?: number;
    } & ({ item_id: string } | { item_name: string })

    Type declaration

    • Optionalaffiliation?: string

      A product affiliation to designate a supplying company or brick and mortar store location. Note: affiliation is only available at the item-scope.

    • Optionalcoupon?: string

      The coupon name/code associated with the item. Event-level and item-level coupon parameters are independent.

    • Optionaldiscount?: number

      The unit monetary discount value associated with the item.

    • Optionalindex?: number

      The index/position of the item in a list.

    • Optionalitem_brand?: string

      The brand of the item.

    • Optionalitem_category?: string

      The category of the item. If used as part of a category hierarchy or taxonomy then this will be the first category.

    • Optionalitem_category2?: string

      The second category hierarchy or additional taxonomy for the item.

    • Optionalitem_category3?: string
    • Optionalitem_category4?: string
    • Optionalitem_category5?: string
    • Optionalitem_id?: string

      The ID of the item. *One of item_id or item_name is required.

    • Optionalitem_list_id?: string

      The ID of the list in which the item was presented to the user. If set, event-level item_list_id is ignored. If not set, event-level item_list_id is used, if present.

    • Optionalitem_list_name?: string

      The name of the list in which the item was presented to the user. If set, event-level item_list_name is ignored. If not set, event-level item_list_name is used, if present.

    • Optionalitem_name?: string

      The name of the item. *One of item_id or item_name is required.

    • Optionalitem_variant?: string

      The item variant or unique code or description for additional item details/options.

    • Optionallocation_id?: string

      The physical location associated with the item (e.g. the physical store location). It's recommended to use the Google Place ID that corresponds to the associated item. A custom location ID can also be used. Note: location id is only available at the item-scope.

    • Optionalprice?: number

      The monetary unit price of the item, in units of the specified currency parameter. If a discount applies to the item, set price to the discounted unit price and specify the unit price discount in the discount parameter.

    • Optionalquantity?: number

      Item quantity. If not set, quantity is set to 1.

    • { item_id: string }
    • { item_name: string }