Shoplive messages

Add an event listener on your page. For example,

const onReceiveMessage = (e) => { 
  if (e.data?.shopliveMessage) {
    const { shopliveMessage, payload } = e.data;
    console.log(shopliveMessage, payload);
  }
}
window.addEventListener("message", onReceiveMessage);

ON_CAMPAIGN_STATUS_CHANGED

{
  shopliveMessage: "ON_CAMPAIGN_STATUS_CHANGED",
  payload: CampaignBriefs
}

ON_CLICK_ADJUST_PRICE

{
  shopliveMessage: "ON_CLICK_ADJUST_PRICE",
  payload: {
    product: Product,
    auction: Auction | undefined // If it is a BIN product, this is undefined
  }
}

ON_AUCTION_STARTED

{
  shopliveMessage: "ON_AUCTION_STARTED",
  payload: {
    product: Product,
    auction: Auction
  }
}

ON_AUCTION_ENDED

{
  shopliveMessage: "ON_AUCTION_ENDED",
  payload: {
    product: Product,
    auction: Auction
  }
}

eBay - Auction V2

ON_CLICK_AUCTION_START

{
  shopliveMessage: "ON_CLICK_AUCTION_START",
  payload: {
    product: Product,
    auction: Auction
  }
}

ON_CLICK_AUCTION_END

{
  shopliveMessage: "ON_CLICK_AUCTION_END",
  payload: {
    product: Product,
    auction: Auction
  }
}

ON_CLICK_AUCTION_RESET

{
  shopliveMessage: "ON_CLICK_AUCTION_RESET",
  payload: {
    product: Product,
    auction: Auction
  }
}

Payload objects

CampaignBriefs

Key	Type	Description
campaignKey	String	Automatically generated key (max 32bytes and alphanumeric). This key is used to specify a campaign in the API call.
campaignId	String	Automatically generated identifier of the campaign. (numeric)
campaignStatus	String	"READY" \| "REHEARSAL" \| "ONAIR" \| "ENDED"
title	String	Title of the campaign

Product object

Key	Type	Description
productId	String
customerProductId	String
originalPrice	String	Product's original price. (Not applied to auction item)
discountPrice	String	Product's discount price. (Not applied to auction item)
discountRate	String	Product's discount rate. (Not applied to auction item)
name	String
brand	String
brandIdentifier	String
description	String
sku	String
currency	String	e.g) "USD"
url	String
imageUrl	String
showingNow	Bool
stockStatus	String	`IN_STOCK` \| `LOW_IN_STOCK` \| `SOLD_OUT`
auctionStatus	String	`READY` \| `ONGOING` \| `ENDED` \| null

Auction object

Key	Type	Description
bidRound	Number
bidStatus	String	`ACCEPTED` `REJECTED`
bidDuration	Number	Auction running time in seconds
extendedDuration	Boolean	Allow duration extended of auction.
currentPrice	Number
endedAt	Number	Time for auction to completely end
endingAt	Number	Estimated time for auction to end ( can be increased)
productId	String
startingPrice	Number	The initial price for bid
winner	`Winner`
winnerCheckoutScheme	String
winningPrice	Number
recommendedPrices	Number[]	The prices[Array] displayed on Bid button
leader	`Leader`

Winner object

Key	Type	Description
name	string
uid	string
userId	string

Leader object

Key	Type	Description
name	string
uid	string
userId	string

Full examples

<html>
  <head>
    <title>Shoplive - Console event example</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, viewport-fit=cover, shrink-to-fit=no" />

    <style>
      html,
      body {
        margin: 0; padding: 0 4px; background-color: #eee;
      }
      iframe {
        display: block; width: 95vw; height: 90vh; margin: auto; border: 1px solid gray;
      }
    </style>

    <script>
      const onReceiveMessage = (e) => {
        if (e.data?.shopliveMessage) {
          const { shopliveMessage, payload } = e.data;
          document.querySelector("#message").innerText = shopliveMessage;
          document.querySelector("#payload").innerText = JSON.stringify(payload);
        }
      };
      window.addEventListener("message", onReceiveMessage);
    </script>
  </head>
  <body>
    <h1 id="message">Message</h1>
    <p id="payload">payload</p>
    <iframe id="console"></iframe>
    <script>
      const src = new URLSearchParams(location.search).get("src") || "https://admin.shoplive.cloud";
      document.querySelector("#console").src = src;
    </script>
  </body>
</html>

eBay Console - Shoplive messages

eBay Console - Shoplive messages

Shoplive messages

ON_CAMPAIGN_STATUS_CHANGED

ON_CLICK_ADJUST_PRICE

ON_AUCTION_STARTED

ON_AUCTION_ENDED

eBay - Auction V2

ON_CLICK_AUCTION_START

ON_CLICK_AUCTION_END

ON_CLICK_AUCTION_RESET

Payload objects

CampaignBriefs

Product object

Auction object

Winner object

Leader object

Full examples

What's Next