Contents x
    Retrieve an auction in progress
      • Print
      Contents

      Retrieve an auction in progress

        • Print
        Article summary

        Get
        /v2/{accessKey}/campaign/{campaignKey}/product/auction/inprogress
        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    \"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}"
        Expand All
        object
        productId
        string
        Example1003
        customerProductId
        string
        ExampleSHOPLIVE_PRODUCT_3
        name
        string
        ExampleT-Shirts
        brand
        string
        ExampleSHOPLIVE
        description
        url
        string
        Examplehttps://www.shoplive.cloud/en
        sku
        string
        ExampleSKU003
        imageUrl
        string
        Examplehttps://image.shoplive.cloud/67129efb-d859-48b6-94b9-d411fb6de550.jpeg
        currency
        string
        ExampleUSD
        showPrice
        boolean
        Defaulttrue
        ExampleTrue
        originalPrice
        integer
        Default0
        Example30
        discountPrice
        integer
        Default0
        Example28
        discountRate
        integer
        Default0
        Example6
        enableAuction
        boolean
        Defaulttrue
        ExampleTrue
        bidStartingPrice
        integer
        Default0
        Example28
        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
        Example3
        stockStatus
        string
        ExampleLOW_IN_STOCK
        auction
        object
        productId
        string
        Example1003
        auctionStatus
        string
        ExampleONGOING
        startingPrice
        integer
        Default0
        Example50
        bidRound
        integer
        Default0
        Example3
        currentPrice
        integer
        Default0
        Example52
        winningPrice
        recommendedPrices
        Array of integer
        integer
        Default0
        Example53
        winner
        leader
        object
        uid
        integer
        Default0
        Example350964901054939140
        name
        string
        Exampleshoplive-user
        winnerCheckoutScheme
        startedAt
        integer
        Default0
        Example1675248192969
        endingAt
        integer
        Default0
        Example1675248232969
        endedAt
        4XX

        4XX

        Result
        "{\n    \"_s\": -000,\n    \"_e\": \"Error message\"\n}"
        What's Next