• Syncube
  • Gift card hero storefront API

GiftHeroAPI

Gift card hero API description

API module loads asynchronous so you need to subscribe to the initalization event

window.addEventListener('gift.hero:initalized', function() {
     const { GiftHeroAPI } = window;
  // Your code goes here...
});
example

You may find an example of custom interface here:

see

https://jsfiddle.net/syncubecommerce/k486aLyq/59/ (React)

Hierarchy

  • GiftHeroApi

Index

Methods

Methods

addToCart

  • addToCart(quantity?: number): Promise<{ data: any; status: number }>

  • Add a gift card product to a cart.

    Parameters

    • quantity: number = 1

      quantity of gift cards added to a cart.

    Returns Promise<{ data: any; status: number }>

generatePreview

  • generatePreview(): Promise<void>

  • Generate gift card preview modal.

    Returns Promise<void>

getImages

  • getImages(): string[]

  • Get array of a gift card images

    Returns string[]

    array or gift card images.

getOptions

  • getOptions(): { name: string; values: { id: number; name: string; price: number }[] }

  • Get gift card product options (denomination)

    Returns { name: string; values: { id: number; name: string; price: number }[] }

    Array of gift card product options

    • name: string
    • values: { id: number; name: string; price: number }[]

getTranslations

  • getTranslations(): {}

  • Get interface text and translations object

    Returns {}

    traslations object

    • [key: string]: string

getVariants

  • getVariants(): any[]

  • Get gift card product variants

    Returns any[]

    array of product variants

setCardData

  • setCardData(cardData: CardDataType): void

  • Set gift card data at once

    Parameters

    • cardData: { deliveryDate?: Date; email?: string; from: string; image: string; message: string; phone?: string; variantId: number }

      gift card data object

      • Optional deliveryDate?: Date
      • Optional email?: string
      • from: string
      • image: string
      • message: string
      • variantId: number

    Returns void

setDeliveryDate

  • setDeliveryDate(date: Date): void

  • Set delivery date and time

    Parameters

    • date: Date

      gift card delivery date and time object.

    Returns void

setEmail

  • setEmail(email: string): void

  • Set delivery email

    Parameters

    • email: string

      gift card delivery email

    Returns void

setFrom

  • setFrom(name: string): void

  • Set current from name.

    Parameters

    • name: string

      name of the user sending a gift card.

    Returns void

setImage

  • setImage(image: string): void

  • Set current selected gift card image. (First image is selected by default).

    Parameters

    • image: string

      selected variant id

    Returns void

setMessage

  • setMessage(message: string): void

  • Set current greeting message.

    Parameters

    • message: string

      greeting message written by the user.

    Returns void

setVariant

  • setVariant(variantId: number): void

  • Set current selected gift card variant by id

    Parameters

    • variantId: number

      selected variant id

    Returns void

validate

  • validate(): ValidationErros

  • Gift card data validation. If email and/or data are set the following fields are mandatory: message, name, deliveryDate, email.

    Returns ValidationErros