Contents x
    Update products
      • Print
      Contents

      Update products

        • Print
        Article summary

        Put
        /v2/{accessKey}/product
        Header parameters
        Authorization
        stringRequired

        Authorization: Bearer

        Path parameters
        accessKey
        stringRequired

        Customer access key

        Body parameters
        Array of object
        Example[ { "customerProductId": "CUSTOMER_PRODUCT_ID_12345", "name": "Updated product name", "url": "Updated product url", "description": "Updated product description" } ]
        object
        productId
        integer (int64)

        Automatically generated unique product ID(either productId or customerProductId is required)

        customerProductId
        string

        Customer's product ID and must be unique(either productId or customerProductId is required)

        name
        string

        Product name

        brand
        string

        Brand name

        brandIdentifier
        string

        Brand key

        description
        string

        Description of the product

        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

        currency
        string

        Currency of the price

        showPrice
        boolean

        Whether show the price or not.

        originalPrice
        number (double)

        e.g. 20.00 ($20.00 if the currency is USD)

        discountPrice
        number (double)

        e.g. 15.00 ($20.00 if the currency is USD)

        discountRate
        number (double)

        e.g. 25.00 (if the discount rate is 25%)

        enableAuction
        boolean

        Whether the product supports an auction

        bidStartingPrice
        number (double)

        Starting price of the auction. (e.g. 0.99) This value is required when the enableAuction is true.

        bidMaximumPrice
        number (double)

        Maximum price of the auction. (e.g. 100.99)

        bidDuration
        integer (int32)

        Bidding time of the auction in seconds. This value is required when the enableAuction is true.

        bidIncrementalAmount
        number (double)

        The incremental amount of the bidding. (e.g. 1.00) This value is required when the enableAuction is true.

        extendBidDuration
        boolean

        Whether to extend the remaining time to bid. If there is a bid when the remaining time is less than 10 seconds, the time will be increased by 10 seconds. The default value is true.

        seller
        object
        sellerId
        integer (int64) Required

        Seller ID

        Responses
        200

        200

        Result
        "{\n  \"results\" : [ \n      {\n            \"productId\": 1001,\n            \"name\": \"Keyring\",\n            \"brand\": \"SHOPLIVE\",\n            \"description\": \"Keyring description\",\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            \"bidDuration\": null,\n            \"bidIncrementalAmount\": null,\n            \"extendBidDuration\": null,\n            \"locked\": false,\n            \"seller\": null,\n            \"createdAt\": \"2022-11-30T08:01:04Z\",\n            \"updatedAt\": \"2022-11-30T12:06:02Z\",\n          \t\"message\": null,\n            \"status\": \"UPDATE\"\n        },\n        {\n            \"productId\": 10000000,\n            \"name\": \"Mug\",\n            \"brand\": \"SHOPLIVE\",\n            \"description\": \"Mug description\",\n            \"url\": \"https://www.shoplive.cloud/en\",\n            \"sku\": \"SKU002\",\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.0,\n            \"extendBidDuration\": true,\n            \"locked\": false,\n            \"seller\": null,\n            \"createdAt\": null,\n            \"updatedAt\": null,\n          \t\"message\": \"The product does not exist.\",\n            \"status\": \"FAIL\"\n        }\n    ],\n    \"successCount\": 1,\n    \"warnCount\": 0,\n    \"failCount\": 1,\n    \"totalCount\": 2\n}\n"
        Expand All
        object
        results
        Array of object
        object
        productId
        integer
        Default0
        Example1001
        name
        string
        ExampleKeyring
        brand
        string
        ExampleSHOPLIVE
        description
        string
        ExampleKeyring 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
        bidDuration
        bidIncrementalAmount
        extendBidDuration
        locked
        boolean
        Defaulttrue
        ExampleFalse
        seller
        createdAt
        string
        Example2022-11-30T08:01:04Z
        updatedAt
        string
        Example2022-11-30T12:06:02Z
        message
        status
        string
        ExampleUPDATE
        successCount
        integer
        Default0
        Example1
        warnCount
        integer
        Default0
        Example0
        failCount
        integer
        Default0
        Example1
        totalCount
        integer
        Default0
        Example2
        4XX

        4XX

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