Retrieve a campaign info

    Retrieve a campaign info


    Article summary

    Get
    /v2/{accessKey}/campaign/{campaignKey}

    This API provides "Retrieve Campaign Information" feature. This includes details about input parameters, response data structures, and examples of requests and responses.

    Header parameters
    Authorization
    stringRequired

    Authorization: Bearer

    Path parameters
    accessKey
    stringRequired

    Customer access key

    campaignKey
    stringRequired

    Campaign key

    Query parameters
    includeAuctionDetail
    boolean

    When this parameter is set to true, the auction details of auction products in campaignProductList are displayed.

    Defaultfalse
    resolutionLevel
    integer (int32)

    This parameter determines the preview video URL resolution, ranging from 1 (lowest) to 4 (highest).

    Default1
    Responses
    200

    200

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

    4XX

    Result
    "{\n    \"_s\": -000,\n    \"_e\": \"Error message\"\n}"