Campaign object

API v2

Campaign object

Article summary

Did you find this summary helpful?

Thank you for your feedback

Property name	Type	Description
campaignMeta	CampaignMeta!	Meta information of the campaign
stream	Stream!	Stream information of the campaign
campaignProductList	List<CampaignProduct>?	List of CampaignProduct object.
seller	Seller?	Seller information of the campaign

CampaignMeta object

Property name	Type	Read only	Description
campaignId	String!	O	Automatically generated identifier of the campaign. (numeric string)
campaignKey	String!	O	Automatically generated key (max 32bytes and alphanumeric). This key is used to specify a campaign in the API call.
accessKey	String!	O	Unique key for each customer. Most of the Shoplive API requires this accessKey.
shoplivePlayerUrl	String!	O	Player URL provided by Shoplive for test viewing
title	String!		Title of the campaign
description	String?		Description of the campaign
campaignStatus	String!	O	READY, REHEARSAL, ONAIR, ENDED
rerun	Boolean!	O	Boolean flag indicating whether the campaign is rerun campaign.
userCount	Integer?	O	Number of viewers in real-time when the campaign status is ONAIR or REHEARSAL. The total number of viewers when the campaign has ended. (when the campaign status is ENDED) * Null when the campaign status is READY.
concurrentUserCount	Integer?	O	Number of concurrent viewers in real-time when the campaign status is ONAIR or REHEARSAL. * Null when the campaign status is READY or ENDED.
likeCount	Integer?	O	campaignStatus READY: null campaignStatus REHEARSAL: Number of likes in real-time campaignStatus ONAIR: Number of likes in real-time campaignStatus ENDED: Total number of likes
rehearsalPasscode	String!		Passcode to enter the live streaming in rehearsal mode
serveReplay	Boolean!		Whether to serve a replay when this campaign ended.
logoImageUrl	String?	O	Logo image URL
brand	Brand?		Brand object
preCampaignVideoUrl	String?		Pre-campaign Video URL
preCampaignImageUrl	String?		Pre-campaign Image URL
postCampaignImageUrl	String?		Post-campaign Image URL
backgroundImageUrl	String?		Background Image URL
ieUnsupportImageUrl	String?		Image for the IE browser
tags	List?		Tag information set for the campaign (Max 10 tags can be set)
scheduledStartAt	String!		Scheduled start DateTime of the campaign (format: `YYYY-MM-DD'T'HH:mm:ss'Z'`)
scheduledEndAt	String?		Scheduled end DateTime of the campaign (format: `YYYY-MM-DD'T'HH:mm:ss'Z'`)
campaignStartedAt	String?	O	Actual start DateTime of the campaign (format: `YYYY-MM-DD'T'HH:mm:ss'Z'`)
campaignEndedAt	String?	O	Actual end DateTime of the campaign (format: `YYYY-MM-DD'T'HH:mm:ss'Z'`)
createdAt	String!	O	Campaign Created At (UTC) (format: `YYYY-MM-DD'T'HH:mm:ss'Z'`)
updatedAt	String!	O	Campaign Last Updated At (UTC) (format: `YYYY-MM-DD'T'HH:mm:ss'Z'`)

Stream object

Property name	Type	Description
streamUrl	String!	RTMP stream URL info for the streaming software (e.g., OBS)
streamKey	String!	RTMP stream key info for the streaming software (e.g., OBS)
videoAspectRatio	String!	Video aspect ratio. 9:16 (portrait) or 16:9 (landscape)
liveUrl	String!	Master m3u8 URL of the live streaming.
liveUrls	List<String, String>?	Set of m3u8 URL of the live streaming by resolution (320p, 480p, 720p, 1080p).
previewLiveUrl	String!	m3u8 URL of the preview video (320p resolution). Preview is a video format to implement a video thumbnail on the web browser.
replayLiveUrl	String?	Master m3u8 URL of the replay streaming. This value is set only after the campaign is ended.
replayLiveUrls	List<String, String>?	Set of m3u8 URL of the replay streaming by resolution (320p, 480p, 720p, 1080p).
previewReplayLiveUrl	String?	m3u8 URL of the preview replay video (320p resolution). Preview is a video format to implement a video thumbnail on the web browser. This value is set only after the campaign is ended. If the preview parameter is specified with a value of 1 in the query string of the URL, it indicates that the data usage for playing the preview replay video is included in your quota usage.

CampaignProduct object

Property name	Type	Description
productId	Long!	Automatically generated unique product ID
*customerProductId*	String?	Customer's product ID and must be unique(defined by the customer). customerProductId can be set by Product API only and Shoplive Admin tool doesn't support the input form of this field at the moment. Shoplive Admin interface will be updated soon to accommodate this field.
name	String!	Product name
brand	String?	Brand name
description	String?	Description of the product
brandIdentifier	String?	Brand key
url	String!	Product URL. When clicking the product info on the Shoplive Player, this is the destination URL.
sku	String?	Product SKU information (defined by the customer)
imageUrl	String?	Product thumbnail image URL. Shoplive automatically generates a thumbnail URL when creating a product object.
currency	String!	Currency of the price
showPrice	Boolean!	Whether show the price or not.
originalPrice	Double?	e.g. 20.00 ($20.00 if the currency is USD)
discountPrice	Double?	e.g. 15.00 ($20.00 if the currency is USD)
discountRate	Double?	e.g. 25.00 (if the discount rate is 25%)
enableAuction	Boolean!	Whether the product is an auction product
bidStartingPrice	Double?	Starting price of the auction (e.g. 0.99)
bidDuration	Integer?	Bidding time of the auction (seconds)
bidIncrementalAmount	Double?	Incremental amount of the bidding
extendBidDuration	Boolean?	Whether to increase the time available to bid
seller	Seller?	Seller information that owns the product
createdAt	String!	Created DateTime when the campaign is created (format: `YYYY-MM-DD'T'HH:mm:ss'Z'`)
updatedAt	String!	Created DateTime when the campaign is updated (format: `YYYY-MM-DD'T'HH:mm:ss'Z'`)
campaignId	String!	Automatically generated identifier of the campaign. (numeric string)
visible	Boolean?	‘visible’ status of the product.
purchasable	Boolean?	‘purchasable’ status of the product.
showingNow	Boolean!	'Now' status of the product. (=pin)
sortOrder	Integer!	Order of the product presentation. (=listOrder)
stockStatus	String!	IN_STOCK, LOW_IN_STOCK , SOLD_OUT
auction	Auction?	Auction information of the product.

Auction object

Property name	Type	Description
productId	Long!	Automatically generated unique product ID
auctionStatus	String!	READY, ONGOING, ENDED
startingPrice	Double!	Starting price of the auction
bidRound	Integer!	Bidding round of the auction
currentPrice	Double!	Current price of the auction
winningPrice	Double?	Winning price of the auction
recommendedPrices	List<Double>?	Recommended bidding price of the auction
winner	Bidder?	Winning bidder of the auction.
leader	Bidder?	The highest bidder of the auction.
winnerCheckoutScheme	String?	App scheme which the winner can purchase the product.
startedAt	Long?	Actual start DateTime of the auction (format: Timestamp in milliseconds)
endingAt	Long?	Estimated end DateTime of the auction (format: Timestamp in milliseconds)
endedAt	Long?	Actual end DateTime of the auction (format: Timestamp in milliseconds)

Bidder object

Property name	Type	Description
uid	Long!	Automatically generated identifier of the user. (numeric)
userId	String?	Identifier of the user. (defined by the customer)
name	String!	Name of the user.

Sample

{
    "campaignMeta": {
        "campaignId": "1234",
        "campaignKey": "{campaignKey}",
        "accessKey": "{accessKey}",
        "shoplivePlayerUrl": "https://www.shoplive.show/v1/player.html?ak={accessKey}&ck={campaignKey}",
        "title": "Shoplive Liveshow",
        "description": "Liveshow description",
        "tags": [ "tag1", "tag2" ],
        "campaignStatus": "READY",
        "userCount": null,
        "likeCount": null,
        "rehearsalPasscode": "9876",
        "serveReplay": false,
        "logoImageUrl": null,
        "preCampaignVideoUrl": null,
        "preCampaignImageUrl": "https://image.shoplive.cloud/14352cf2-ef40-4ba9-93af-279a104cb3c8.png",
        "postCampaignImageUrl": "https://image.shoplive.cloud/6da19c2d-8d53-4cea-801f-7b39913f7c35.png",
        "backgroundImageUrl": "https://image.shoplive.cloud/0b1bd566-4087-40ef-b376-fb863a888d72.png",
        "ieUnsupportImageUrl": "https://image.shoplive.cloud/5a0fd01c-8889-4d28-8a15-8b7661a422a2.png",
        "scheduledStartAt": "2022-11-01T09:00:00Z",
        "scheduledEndAt": "2022-11-01T10:00:00Z",
        "campaignStartedAt": null,
        "campaignEndedAt": null,
        "createdAt": "2022-11-01T08:15:00Z",
        "updatedAt": "2022-11-01T08:29:09Z"
    },
    "stream": {
        "streamUrl": "rtmp://stream.shoplive.cloud:1935/stream",
        "streamKey": "{streamKey}",
        "videoAspectRatio": "9:16",
        "liveUrl": "https://live.shoplive.cloud/live/{streamKey}.m3u8",
        "liveUrls": {
            "720p": "https://live.shoplive.cloud/live/{streamKey}_720p/playlist.m3u8",
            "480p": "https://live.shoplive.cloud/live/{streamKey}_480p/playlist.m3u8" 
        },
        "previewLiveUrl": "https://live.shoplive.cloud/live/{streamKey}_480p/index.m3u8",
        "replayLiveUrl": null,
        "replayLiveUrls": null,
        "previewReplayLiveUrl": "https://api.shoplive.cloud/v1/replay/{accessKey}/{campaignKey}/replay_320p/ORIGINAL/index.m3u8?preview=1"
    },
    "campaignProductList": [
        {
            "productId": "1001",
            "customerProductId": "SHOPLIVE_PRODUCT_1",
            "name": "Keyring",
            "brand": "SHOPLIVE",
            "description": null,
            "url": "https://www.shoplive.cloud/en",
            "sku": "SKU001",
            "imageUrl": "https://image.shoplive.cloud/e05d1464-1942-4e4e-bb0b-c4310167d465.jpeg",
            "currency": "USD",
            "showPrice": true,
            "originalPrice": 20.0,
            "discountPrice": 10.0,
            "discountRate": 50.0,
            "enableAuction": false,
            "bidStartingPrice": null,
            "bidDuration": null,
            "bidIncrementalAmount": null,
            "extendBidDuration": null,
            "seller": {
                "sellerId": "1",
                "name": "Shoplive Product Store",
                "profileUrl": "https://image.shoplive.cloud/7910e586-19a4-4740-804b-5f9da02e6939.jpg",
                "storeUrl": "https://shoplive.cloud",
                "description": "Description of the seller",
                "schemes": null
            },
            "createdAt": "2022-05-20T08:01:05Z",
            "updatedAt": "2022-05-20T11:27:34Z",
            "campaignId": "1234",
            "showingNow": true,
            "sortOrder": 1,
            "stockStatus": "IN_STOCK",
            "auction": null
        },
        {
            "productId": "1002",
            "customerProductId": "SHOPLIVE_PRODUCT_2",
            "name": "Hoodie",
            "brand": "SHOPLIVE",
            "description": null,
            "url": "https://www.shoplive.cloud/en",
            "sku": "SKU002",
            "imageUrl": "https://image.shoplive.cloud/40afe353-0d23-47b6-acdf-10d1fca10c57.jpeg",
            "currency": "USD",
            "showPrice": true,
            "originalPrice": 50.0,
            "discountPrice": 37.0,
            "discountRate": 26.0,
            "enableAuction": false,
            "bidStartingPrice": null,
            "bidDuration": null,
            "bidIncrementalAmount": null,
            "extendBidDuration": null,
            "seller": {
                "sellerId": "1",
                "name": "Shoplive Product Store",
                "profileUrl": "https://image.shoplive.cloud/7910e586-19a4-4740-804b-5f9da02e6939.jpg",
                "storeUrl": "https://shoplive.cloud",
                "description": "Description of the seller",
                "schemes": null
            },
            "createdAt": "2022-05-20T08:01:05Z",
            "updatedAt": "2022-05-20T11:27:34Z",
            "campaignId": "1234",
            "showingNow": true,
            "sortOrder": 2,
            "stockStatus": "LOW_IN_STOCK",
            "auction": null
        },
        {
            "productId": "1003",
            "customerProductId": "SHOPLIVE_PRODUCT_3",
            "name": "T-Shirts",
            "brand": "SHOPLIVE",
            "description": null,
            "url": "https://www.shoplive.cloud/en",
            "sku": "SKU003",
            "imageUrl": "https://image.shoplive.cloud/67129efb-d859-48b6-94b9-d411fb6de550.jpeg",
            "currency": "USD",
            "showPrice": true,
            "originalPrice": 30.0,
            "discountPrice": 28.0,
            "discountRate": 6.0,
            "enableAuction": false,
            "bidStartingPrice": null,
            "bidDuration": null,
            "bidIncrementalAmount": null,
            "extendBidDuration": null,
            "seller": {
                "sellerId": "1",
                "name": "Shoplive Product Store",
                "profileUrl": "https://image.shoplive.cloud/7910e586-19a4-4740-804b-5f9da02e6939.jpg",
                "storeUrl": "https://shoplive.cloud",
                "description": "Description of the seller",
                "schemes": null
            },
            "createdAt": "2022-05-20T08:01:05Z",
            "updatedAt": "2022-05-20T11:27:34Z",
            "campaignId": "1234",
            "showingNow": false,
            "sortOrder": 3,
            "stockStatus": "SOLD_OUT",
            "auction": null
        },
        {
            "productId": "1004",
            "customerProductId": "SHOPLIVE_PRODUCT_4",
            "name": "Mug",
            "brand": "SHOPLIVE",
            "description": null,
            "url": "https://www.shoplive.cloud/en",
            "sku": "SKU004",
            "imageUrl": "https://image.shoplive.cloud/b22c72c7-d2f8-49c3-83f0-314c59740649.jpeg",
            "currency": "USD",
            "showPrice": true,
            "originalPrice": 10.0,
            "discountPrice": 7.0,
            "discountRate": 30.0,
            "enableAuction": true,
            "bidStartingPrice": 7.0,
            "bidDuration": 120,
            "bidIncrementalAmount": 1.0,
            "extendBidDuration": true,
            "seller": {
                "sellerId": "1",
                "name": "Shoplive Product Store",
                "profileUrl": "https://image.shoplive.cloud/7910e586-19a4-4740-804b-5f9da02e6939.jpg",
                "storeUrl": "https://shoplive.cloud",
                "description": "Description of the seller",
                "schemes": null
            },
            "createdAt": "2022-05-20T08:01:05Z",
            "updatedAt": "2022-05-20T11:27:34Z",
            "campaignId": "1234",
            "showingNow": false,
            "sortOrder": 4,
            "stockStatus": "IN_STOCK",
            "auction": {
                "productId": "1004",
                "auctionStatus": "READY",
                "startingPrice": 7.0,
                "bidRound": 1,
                "currentPrice": 7.0,
                "winningPrice": null,
                "recommendedPrices": null,
                "winner": null,
                "leader": null,
                "winnerCheckoutScheme": null,
                "startedAt": null,
                "endingAt": null,
                "endedAt": null
            }
        },
        {
            "productId": "1005",
            "customerProductId": "SHOPLIVE_PRODUCT_5",
            "name": "Ballcap",
            "brand": "SHOPLIVE",
            "description": null,
            "url": "https://www.shoplive.cloud/en",
            "sku": "SKU005",
            "imageUrl": "https://image.shoplive.cloud/ae4d67b6-9d92-4a19-a457-6566420c5b9b.jpeg",
            "currency": "USD",
            "showPrice": true,
            "originalPrice": 18.0,
            "discountPrice": 14.0,
            "discountRate": 22.0,
            "enableAuction": false,
            "bidStartingPrice": null,
            "bidDuration": null,
            "bidIncrementalAmount": null,
            "extendBidDuration": null,
            "seller": {
                "sellerId": "1",
                "name": "Shoplive Product Store",
                "profileUrl": "https://image.shoplive.cloud/7910e586-19a4-4740-804b-5f9da02e6939.jpg",
                "storeUrl": "https://shoplive.cloud",
                "description": "Description of the seller",
                "schemes": null
            },
            "createdAt": "2022-05-20T08:01:05Z",
            "updatedAt": "2022-05-20T11:27:34Z",
            "campaignId": "1234",
            "showingNow": false,
            "sortOrder": 5,
            "stockStatus": "IN_STOCK",
            "auction": null
        }
    ],
    "seller": {
        "sellerId": "1",
        "name": "Shoplive Product Store",
        "profileUrl": "https://image.shoplive.cloud/7910e586-19a4-4740-804b-5f9da02e6939.jpg",
        "storeUrl": "https://shoplive.cloud",
        "description": "Description of the seller",
        "schemes": null,
        "sellerIdentifier": "seller_identifier"
    }
}

campaignStatus: ONAIR

{
    "campaignMeta": {
        "campaignId": "1234",
        "campaignKey": "{campaignKey}",
        "accessKey": "{accessKey}",
        "shoplivePlayerUrl": "https://www.shoplive.show/v1/player.html?ak={accessKey}&ck={campaignKey}",
        "title": "Shoplive Liveshow",
        "description": "Liveshow description",
        "tags": [ "tag1", "tag2" ],
        "campaignStatus": "ONAIR",
        "userCount": 123,
        "likeCount": 3132,
        "rehearsalPasscode": "9876",
        "serveReplay": false,
        "logoImageUrl": null,
        "preCampaignVideoUrl": null,
        "preCampaignImageUrl": "https://image.shoplive.cloud/14352cf2-ef40-4ba9-93af-279a104cb3c8.png",
        "postCampaignImageUrl": "https://image.shoplive.cloud/6da19c2d-8d53-4cea-801f-7b39913f7c35.png",
        "backgroundImageUrl": "https://image.shoplive.cloud/0b1bd566-4087-40ef-b376-fb863a888d72.png",
        "ieUnsupportImageUrl": "https://image.shoplive.cloud/5a0fd01c-8889-4d28-8a15-8b7661a422a2.png",
        "scheduledStartAt": "2022-11-01T09:00:00Z",
        "scheduledEndAt": "2022-11-01T10:00:00Z",
        "campaignStartedAt": "2022-11-01T09:10:05Z",
        "campaignEndedAt": null,
        "createdAt": "2022-11-01T08:15:00Z",
        "updatedAt": "2022-11-01T08:29:09Z"
    },
    "stream": {
        "streamUrl": "rtmp://stream.shoplive.cloud:1935/stream",
        "streamKey": "{streamKey}",
        "videoAspectRatio": "9:16",
        "liveUrl": "https://live.shoplive.cloud/live/{streamKey}.m3u8",
        "liveUrls": {
            "720p": "https://live.shoplive.cloud/live/{streamKey}_720p/playlist.m3u8" 
        },
        "previewLiveUrl": "https://live.shoplive.cloud/live/{streamKey}_320p/index.m3u8",
        "replayLiveUrl": null,
        "replayLiveUrls": null,
        "previewReplayLiveUrl": "https://api.shoplive.cloud/v1/replay/{accessKey}/{campaignKey}/replay_320p/ORIGINAL/index.m3u8?preview=1"
    },
    "campaignProductList": [
        {
            "productId": "1001",
            "customerProductId": "SHOPLIVE_PRODUCT_1",
            "name": "Keyring",
            "brand": "SHOPLIVE",
            "description": null,
            "url": "https://www.shoplive.cloud/en",
            "sku": "SKU001",
            "imageUrl": "https://image.shoplive.cloud/e05d1464-1942-4e4e-bb0b-c4310167d465.jpeg",
            "currency": "USD",
            "showPrice": true,
            "originalPrice": 20.0,
            "discountPrice": 10.0,
            "discountRate": 50.0,
            "enableAuction": false,
            "bidStartingPrice": null,
            "bidDuration": null,
            "bidIncrementalAmount": null,
            "extendBidDuration": null,
            "seller": {
                "sellerId": "1",
                "name": "Shoplive Product Store",
                "profileUrl": "https://image.shoplive.cloud/7910e586-19a4-4740-804b-5f9da02e6939.jpg",
                "storeUrl": "https://shoplive.cloud",
                "description": "Description of the seller",
                "schemes": null
            },
            "createdAt": "2022-05-20T08:01:05Z",
            "updatedAt": "2022-05-20T11:27:34Z",
            "campaignId": "1234",
            "showingNow": true,
            "sortOrder": 1,
            "stockStatus": "SOLD_OUT",
            "auction": null
        },
        {
            "productId": "1002",
            "customerProductId": "SHOPLIVE_PRODUCT_2",
            "name": "Hoodie",
            "brand": "SHOPLIVE",
            "description": null,
            "url": "https://www.shoplive.cloud/en",
            "sku": "SKU002",
            "imageUrl": "https://image.shoplive.cloud/40afe353-0d23-47b6-acdf-10d1fca10c57.jpeg",
            "currency": "USD",
            "showPrice": true,
            "originalPrice": 50.0,
            "discountPrice": 37.0,
            "discountRate": 26.0,
            "enableAuction": false,
            "bidStartingPrice": null,
            "bidDuration": null,
            "bidIncrementalAmount": null,
            "extendBidDuration": null,
            "seller": {
                "sellerId": "1",
                "name": "Shoplive Product Store",
                "profileUrl": "https://image.shoplive.cloud/7910e586-19a4-4740-804b-5f9da02e6939.jpg",
                "storeUrl": "https://shoplive.cloud",
                "description": "Description of the seller",
                "schemes": null
            },
            "createdAt": "2022-05-20T08:01:05Z",
            "updatedAt": "2022-05-20T11:27:34Z",
            "campaignId": "1234",
            "showingNow": true,
            "sortOrder": 2,
            "stockStatus": "LOW_IN_STOCK",
            "auction": null
        },
        {
            "productId": "1003",
            "customerProductId": "SHOPLIVE_PRODUCT_3",
            "name": "T-Shirts",
            "brand": "SHOPLIVE",
            "description": null,
            "url": "https://www.shoplive.cloud/en",
            "sku": "SKU003",
            "imageUrl": "https://image.shoplive.cloud/67129efb-d859-48b6-94b9-d411fb6de550.jpeg",
            "currency": "USD",
            "showPrice": true,
            "originalPrice": 30.0,
            "discountPrice": 28.0,
            "discountRate": 6.0,
            "enableAuction": false,
            "bidStartingPrice": null,
            "bidDuration": null,
            "bidIncrementalAmount": null,
            "extendBidDuration": null,
            "seller": {
                "sellerId": "1",
                "name": "Shoplive Product Store",
                "profileUrl": "https://image.shoplive.cloud/7910e586-19a4-4740-804b-5f9da02e6939.jpg",
                "storeUrl": "https://shoplive.cloud",
                "description": "Description of the seller",
                "schemes": null
            },
            "createdAt": "2022-05-20T08:01:05Z",
            "updatedAt": "2022-05-20T11:27:34Z",
            "campaignId": "1234",
            "showingNow": false,
            "sortOrder": 3,
            "stockStatus": "IN_STOCK",
            "auction": null
        },
        {
            "productId": "1004",
            "customerProductId": "SHOPLIVE_PRODUCT_4",
            "name": "Mug",
            "brand": "SHOPLIVE",
            "description": null,
            "url": "https://www.shoplive.cloud/en",
            "sku": "SKU004",
            "imageUrl": "https://image.shoplive.cloud/b22c72c7-d2f8-49c3-83f0-314c59740649.jpeg",
            "currency": "USD",
            "showPrice": true,
            "originalPrice": 10.0,
            "discountPrice": 7.0,
            "discountRate": 30.0,
            "enableAuction": true,
            "bidStartingPrice": 7.0,
            "bidDuration": 120,
            "bidIncrementalAmount": 1.0,
            "extendBidDuration": true,
            "seller": {
                "sellerId": "1",
                "name": "Shoplive Product Store",
                "profileUrl": "https://image.shoplive.cloud/7910e586-19a4-4740-804b-5f9da02e6939.jpg",
                "storeUrl": "https://shoplive.cloud",
                "description": "Description of the seller",
                "schemes": null
            },
            "createdAt": "2022-05-20T08:01:05Z",
            "updatedAt": "2022-05-20T11:27:34Z",
            "campaignId": "1234",
            "showingNow": true,
            "sortOrder": 4,
            "stockStatus": "IN_STOCK",
            "auction": {
                "productId": "1004",
                "auctionStatus": "ONGOING",
                "startingPrice": 7.0,
                "bidRound": 3,
                "currentPrice": 9.0,
                "winningPrice": null,
                "recommendedPrices": [
                    10.0
                ],
                "winner": null,
                "leader": {
                    "uid": "350964901054939144",
                    "userId": "test@shoplive.cloud",
                    "name": "ShopliveUser-1"
                },
                "winnerCheckoutScheme": null,
                "startedAt": 1667294430000,
                "endingAt": 1667294550000,
                "endedAt": null
            }
        },
        {
            "productId": "1005",
            "customerProductId": "SHOPLIVE_PRODUCT_5",
            "name": "Ballcap",
            "brand": "SHOPLIVE",
            "description": null,
            "url": "https://www.shoplive.cloud/en",
            "sku": "SKU005",
            "imageUrl": "https://image.shoplive.cloud/ae4d67b6-9d92-4a19-a457-6566420c5b9b.jpeg",
            "currency": "USD",
            "showPrice": true,
            "originalPrice": 18.0,
            "discountPrice": 14.0,
            "discountRate": 22.0,
            "enableAuction": false,
            "bidStartingPrice": null,
            "bidDuration": null,
            "bidIncrementalAmount": null,
            "extendBidDuration": null,
            "seller": {
                "sellerId": "1",
                "name": "Shoplive Product Store",
                "profileUrl": "https://image.shoplive.cloud/7910e586-19a4-4740-804b-5f9da02e6939.jpg",
                "storeUrl": "https://shoplive.cloud",
                "description": "Description of the seller",
                "schemes": null
            },
            "createdAt": "2022-05-20T08:01:05Z",
            "updatedAt": "2022-05-20T11:27:34Z",
            "campaignId": "1234",
            "showingNow": false,
            "sortOrder": 5,
            "stockStatus": "IN_STOCK",
            "auction": null
        }
    ],
    "seller": {
        "sellerId": "1",
        "name": "Shoplive Product Store",
        "profileUrl": "https://image.shoplive.cloud/7910e586-19a4-4740-804b-5f9da02e6939.jpg",
        "storeUrl": "https://shoplive.cloud",
        "description": "Description of the seller",
        "schemes": null
    }
}

campaignStatus: ENDED

{
    "campaignMeta": {
        "campaignId": "1234",
        "campaignKey": "{campaignKey}",
        "accessKey": "{accessKey}",
        "shoplivePlayerUrl": "https://www.shoplive.show/v1/player.html?ak={accessKey}&ck={campaignKey}",
        "title": "Shoplive Liveshow",
        "description": "Liveshow description",
        "tags": [ "tag1", "tag2" ],
        "campaignStatus": "ENDED",
        "userCount": 15923,
        "likeCount": 102683,
        "rehearsalPasscode": "9876",
        "serveReplay": false,
        "logoImageUrl": null,
        "preCampaignVideoUrl": null,
        "preCampaignImageUrl": "https://image.shoplive.cloud/14352cf2-ef40-4ba9-93af-279a104cb3c8.png",
        "postCampaignImageUrl": "https://image.shoplive.cloud/6da19c2d-8d53-4cea-801f-7b39913f7c35.png",
        "backgroundImageUrl": "https://image.shoplive.cloud/0b1bd566-4087-40ef-b376-fb863a888d72.png",
        "ieUnsupportImageUrl": "https://image.shoplive.cloud/5a0fd01c-8889-4d28-8a15-8b7661a422a2.png",
        "scheduledStartAt": "2022-11-01T09:00:00Z",
        "scheduledEndAt": "2022-11-01T10:00:00Z",
        "campaignStartedAt": "2022-11-01T09:10:05Z",
        "campaignEndedAt": "2022-11-01T10:05:05Z",
        "createdAt": "2022-11-01T08:15:00Z",
        "updatedAt": "2022-11-01T08:29:09Z"
    },
    "stream": {
        "streamUrl": "rtmp://stream.shoplive.cloud:1935/stream",
        "streamKey": "{streamKey}",
        "videoAspectRatio": "9:16",
        "liveUrl": "https://live.shoplive.cloud/live/{streamKey}.m3u8",
        "liveUrls": {
            "720p": "https://live.shoplive.cloud/live/{streamKey}_720p/playlist.m3u8" 
        },
        "previewLiveUrl": "https://live.shoplive.cloud/live/{streamKey}_320p/index.m3u8",
        "replayLiveUrl": "https://private.shopliveapi.com/v1/replay/{accessKey}/{campaignKey}/replay.m3u8?replayMode=ORIGINAL",
        "replayLiveUrls": {
            "720p": "https://private.shopliveapi.com/v1/replay/{accessKey}/{campaignKey}/ORIGINAL/720p/index.m3u8"
        },
        "previewReplayLiveUrl": "https://api.shoplive.cloud/v1/replay/{accessKey}/{campaignKey}/replay_320p/ORIGINAL/index.m3u8?preview=1"
    },
    "campaignProductList": [
        {
            "productId": "1001",
            "customerProductId": "SHOPLIVE_PRODUCT_1",
            "name": "Keyring",
            "brand": "SHOPLIVE",
            "description": null,
            "url": "https://www.shoplive.cloud/en",
            "sku": "SKU001",
            "imageUrl": "https://image.shoplive.cloud/e05d1464-1942-4e4e-bb0b-c4310167d465.jpeg",
            "currency": "USD",
            "showPrice": true,
            "originalPrice": 20.0,
            "discountPrice": 10.0,
            "discountRate": 50.0,
            "enableAuction": false,
            "bidStartingPrice": null,
            "bidDuration": null,
            "bidIncrementalAmount": null,
            "extendBidDuration": null,
            "seller": {
                "sellerId": "1",
                "name": "Shoplive Product Store",
                "profileUrl": "https://image.shoplive.cloud/7910e586-19a4-4740-804b-5f9da02e6939.jpg",
                "storeUrl": "https://shoplive.cloud",
                "description": "Description of the seller",
                "schemes": null
            },
            "createdAt": "2022-05-20T08:01:05Z",
            "updatedAt": "2022-05-20T11:27:34Z",
            "campaignId": "1234",
            "showingNow": true,
            "sortOrder": 1,
            "stockStatus": "SOLD_OUT",
            "auction": null
        },
        {
            "productId": "1002",
            "customerProductId": "SHOPLIVE_PRODUCT_2",
            "name": "Hoodie",
            "brand": "SHOPLIVE",
            "description": null,
            "url": "https://www.shoplive.cloud/en",
            "sku": "SKU002",
            "imageUrl": "https://image.shoplive.cloud/40afe353-0d23-47b6-acdf-10d1fca10c57.jpeg",
            "currency": "USD",
            "showPrice": true,
            "originalPrice": 50.0,
            "discountPrice": 37.0,
            "discountRate": 26.0,
            "enableAuction": false,
            "bidStartingPrice": null,
            "bidDuration": null,
            "bidIncrementalAmount": null,
            "extendBidDuration": null,
            "seller": {
                "sellerId": "1",
                "name": "Shoplive Product Store",
                "profileUrl": "https://image.shoplive.cloud/7910e586-19a4-4740-804b-5f9da02e6939.jpg",
                "storeUrl": "https://shoplive.cloud",
                "description": "Description of the seller",
                "schemes": null
            },
            "createdAt": "2022-05-20T08:01:05Z",
            "updatedAt": "2022-05-20T11:27:34Z",
            "campaignId": "1234",
            "showingNow": true,
            "sortOrder": 2,
            "stockStatus": "LOW_IN_STOCK",
            "auction": null
        },
        {
            "productId": "1003",
            "customerProductId": "SHOPLIVE_PRODUCT_3",
            "name": "T-Shirts",
            "brand": "SHOPLIVE",
            "description": null,
            "url": "https://www.shoplive.cloud/en",
            "sku": "SKU003",
            "imageUrl": "https://image.shoplive.cloud/67129efb-d859-48b6-94b9-d411fb6de550.jpeg",
            "currency": "USD",
            "showPrice": true,
            "originalPrice": 30.0,
            "discountPrice": 28.0,
            "discountRate": 6.0,
            "enableAuction": false,
            "bidStartingPrice": null,
            "bidDuration": null,
            "bidIncrementalAmount": null,
            "extendBidDuration": null,
            "seller": {
                "sellerId": "1",
                "name": "Shoplive Product Store",
                "profileUrl": "https://image.shoplive.cloud/7910e586-19a4-4740-804b-5f9da02e6939.jpg",
                "storeUrl": "https://shoplive.cloud",
                "description": "Description of the seller",
                "schemes": null
            },
            "createdAt": "2022-05-20T08:01:05Z",
            "updatedAt": "2022-05-20T11:27:34Z",
            "campaignId": "1234",
            "showingNow": true,
            "sortOrder": 3,
            "stockStatus": "SOLD_OUT",
            "auction": null
        },
        {
            "productId": "1004",
            "customerProductId": "SHOPLIVE_PRODUCT_4",
            "name": "Mug",
            "brand": "SHOPLIVE",
            "description": null,
            "url": "https://www.shoplive.cloud/en",
            "sku": "SKU004",
            "imageUrl": "https://image.shoplive.cloud/b22c72c7-d2f8-49c3-83f0-314c59740649.jpeg",
            "currency": "USD",
            "showPrice": true,
            "originalPrice": 10.0,
            "discountPrice": 7.0,
            "discountRate": 30.0,
            "enableAuction": true,
            "bidStartingPrice": 7.0,
            "bidDuration": 120,
            "bidIncrementalAmount": 1,
            "extendBidDuration": true,
            "seller": {
                "sellerId": "1",
                "name": "Shoplive Product Store",
                "profileUrl": "https://image.shoplive.cloud/7910e586-19a4-4740-804b-5f9da02e6939.jpg",
                "storeUrl": "https://shoplive.cloud",
                "description": "Description of the seller",
                "schemes": null
            },
            "createdAt": "2022-05-20T08:01:05Z",
            "updatedAt": "2022-05-20T11:27:34Z",
            "campaignId": "1234",
            "showingNow": true,
            "sortOrder": 4,
            "stockStatus": "SOLD_OUT",
            "auction": {
                "productId": "1004",
                "auctionStatus": "ENDED",
                "startingPrice": 7.0,
                "bidRound": 3,
                "currentPrice": 0.0,
                "winningPrice": 9.0,
                "recommendedPrices": null,
                "winner": {
                    "uid": "350964901054939144",
                    "userId": "test@shoplive.cloud",
                    "name": "ShopliveUser-1"
                },
                "leader": null,
                "winnerCheckoutScheme": null,
                "startedAt": 1667294430000,
                "endingAt": null,
                "endedAt": 1667294550000
            }
        },
        {
            "productId": "1005",
            "customerProductId": "SHOPLIVE_PRODUCT_5",
            "name": "Ballcap",
            "brand": "SHOPLIVE",
            "description": null,
            "url": "https://www.shoplive.cloud/en",
            "sku": "SKU005",
            "imageUrl": "https://image.shoplive.cloud/ae4d67b6-9d92-4a19-a457-6566420c5b9b.jpeg",
            "currency": "USD",
            "showPrice": true,
            "originalPrice": 18.0,
            "discountPrice": 14.0,
            "discountRate": 22.0,
            "enableAuction": false,
            "bidStartingPrice": null,
            "bidDuration": null,
            "bidIncrementalAmount": null,
            "extendBidDuration": null,
            "seller": {
                "sellerId": "1",
                "name": "Shoplive Product Store",
                "profileUrl": "https://image.shoplive.cloud/7910e586-19a4-4740-804b-5f9da02e6939.jpg",
                "storeUrl": "https://shoplive.cloud",
                "description": "Description of the seller",
                "schemes": null
            },
            "createdAt": "2022-05-20T08:01:05Z",
            "updatedAt": "2022-05-20T11:27:34Z",
            "campaignId": "1234",
            "showingNow": true,
            "sortOrder": 5,
            "stockStatus": "SOLD_OUT",
            "auction": null
        }
    ],
    "seller": {
        "sellerId": "1",
        "name": "Shoplive Product Store",
        "profileUrl": "https://image.shoplive.cloud/7910e586-19a4-4740-804b-5f9da02e6939.jpg",
        "storeUrl": "https://shoplive.cloud",
        "description": "Description of the seller",
        "schemes": null
    }
}

What's Next

Search campaigns

Table of contents

Campaign object
Sample