Search products in a campaign

    Search products in a campaign


    Article summary

    Get
    /v2/{accessKey}/campaign/{campaignKey}/product
    Header parameters
    Authorization
    stringRequired
    Path parameters
    accessKey
    stringRequired

    Customer access key

    campaignKey
    stringRequired

    Campaign key

    Responses
    200

    200

    Result
    "[\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\": \"1237\",\n        \"showingNow\": true,\n        \"sortOrder\": 1,\n        \"stockStatus\": \"IN_STOCK\",\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\": \"1237\",\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\": \"1237\",\n        \"showingNow\": false,\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        \"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\": \"1237\",\n        \"showingNow\": false,\n        \"sortOrder\": 4,\n        \"stockStatus\": \"IN_STOCK\",\n        \"auction\": {\n            \"productId\": \"1004\",\n            \"auctionStatus\": \"READY\",\n            \"startingPrice\": 7.0,\n            \"bidRound\": 1,\n            \"currentPrice\": 7.0,\n            \"winningPrice\": null,\n            \"recommendedPrices\": null,\n            \"winner\": null,\n            \"leader\": null,\n            \"winnerCheckoutScheme\": null,\n            \"startedAt\": null,\n            \"endingAt\": null,\n            \"endedAt\": null\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\": \"1237\",\n        \"showingNow\": false,\n        \"sortOrder\": 5,\n        \"stockStatus\": \"IN_STOCK\",\n        \"auction\": null\n    }\n]\n\n"
    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
    Example1237
    showingNow
    boolean
    Defaulttrue
    ExampleTrue
    sortOrder
    integer
    Default0
    Example1
    stockStatus
    string
    ExampleIN_STOCK
    auction
    400

    400

    Result
    "{}"
    object