Search auction products in a campaign

    Search auction products in a campaign


    Article summary

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

    Customer access key

    campaignKey
    stringRequired

    Campaign key

    Query parameters
    groupId
    integer (int64)

    Product group id set in a console.

    Responses
    200

    200

    Result
    "[\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\": true,\n        \"bidStartingPrice\": 50.0,\n        \"bidDuration\": 120,\n        \"bidIncrementalAmount\": 1,\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\": 2,\n        \"stockStatus\": \"LOW_IN_STOCK\",\n        \"auction\" : {\n            \"productId\" : \"1002 \",\n            \"auctionStatus\" : \"READY\",\n            \"startingPrice\" : 50.0,\n            \"bidRound\" : 1,\n            \"currentPrice\" : 50.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\": \"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\": true,\n        \"bidStartingPrice\": 28.0,\n        \"bidDuration\": 120,\n        \"bidIncrementalAmount\": 1,\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\": 3,\n        \"stockStatus\": \"LOW_IN_STOCK\",\n        \"auction\" : {\n            \"productId\" : \"1003 \",\n            \"auctionStatus\" : \"ONGOING\",\n            \"startingPrice\" : 50.0,\n            \"bidRound\" : 3,\n            \"currentPrice\" : 52.0,\n            \"winningPrice\" : null,\n            \"recommendedPrices\" : [\n                53.0\n            ],\n            \"winner\" : null,\n            \"leader\" : {\n                \"uid\": 350964901054939144,\n                \"name\": \"shoplive-user\"\n            },\n            \"winnerCheckoutScheme\" : null,\n            \"startedAt\" : 1675248192969,\n            \"endingAt\" : 1675248232969,\n            \"endedAt\" : null\n        }\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        \"bidDuration\": 120,\n        \"bidIncrementalAmount\": 1,\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\n"
    Array of object
    object
    productId
    string
    Example1002
    customerProductId
    string
    ExampleSHOPLIVE_PRODUCT_2
    name
    string
    ExampleHoodie
    brand
    string
    ExampleSHOPLIVE
    description
    url
    string
    Examplehttps://www.shoplive.cloud/en
    sku
    string
    ExampleSKU002
    imageUrl
    string
    Examplehttps://image.shoplive.cloud/40afe353-0d23-47b6-acdf-10d1fca10c57.jpeg
    currency
    string
    ExampleUSD
    showPrice
    boolean
    Defaulttrue
    ExampleTrue
    originalPrice
    integer
    Default0
    Example50
    discountPrice
    integer
    Default0
    Example37
    discountRate
    integer
    Default0
    Example26
    enableAuction
    boolean
    Defaulttrue
    ExampleTrue
    bidStartingPrice
    integer
    Default0
    Example50
    bidDuration
    integer
    Default0
    Example120
    bidIncrementalAmount
    integer
    Default0
    Example1
    extendBidDuration
    boolean
    Defaulttrue
    ExampleTrue
    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
    Example2
    stockStatus
    string
    ExampleLOW_IN_STOCK
    auction
    object
    productId
    string
    Example1002
    auctionStatus
    string
    ExampleREADY
    startingPrice
    integer
    Default0
    Example50
    bidRound
    integer
    Default0
    Example1
    currentPrice
    integer
    Default0
    Example50
    winningPrice
    recommendedPrices
    winner
    leader
    winnerCheckoutScheme
    startedAt
    endingAt
    endedAt
    4XX

    4XX

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