Contents x
    Create products
      • Print
      Contents

      Create products

        • Print
        Article summary

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

        Authorization: Bearer

        Path parameters
        accessKey
        stringRequired

        Customer access key

        Body parameters
        Expand All
        Array
        Example[ { "customerProductId": "CUSTOMER_PRODUCT_ID_12345", "name": "TEST PRODUCT", "url": "TEST_URL" } ]
        customerProductId
        string

        Customer's product ID and must be unique(defined by the customer).

        name
        string

        Product name

        brand
        string

        Brand name

        brandIdentifier
        string

        Brand key

        description
        string

        Description of the product

        url
        string

        Product 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            \"customerProductId\": \"SHOPLIVE_PRODUCT_1\",\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         \t\t\"enableAuction\": false,\n            \"bidStartingPrice\": null,\n            \"bidDuration\": null,\n            \"bidIncrementalAmount\": null,\n            \"extendBidDuration\": null,\n            \"locked\": false,\n            \"seller\": {\n                \"sellerId\": \"1\",\n                \"name\": \"New seller\",\n                \"profileUrl\": \"https://image.shoplive.cloud/14352cf2-ef40-4ba9-93af-279a104cb3c8.png\",\n                \"storeUrl\": \"https://shoplive.cloud\",\n                \"description\": \"Description of the seller\"\n                \"schemes\": {}\n            },\n            \"createdAt\": \"2022-05-20T08:01:04Z\",\n            \"updatedAt\": \"2022-05-20T08:01:04Z\",\n          \t\"message\": null,\n            \"status\": \"CREATE\"\n        },\n        {\n            \"productId\": \"1002\",\n            \"customerProductId\": \"SHOPLIVE_PRODUCT_2\",\n            \"name\": \"Mug\",\n            \"brand\": \"SHOPLIVE\",\n            \"description\": \"Mug description\",\n            \"url\": \"https://www.shoplive.cloud/en\",\n            \"sku\": \"SKU002\",\n            \"imageUrl\": null,\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\": \"2022-05-20T08:01:04Z\",\n            \"updatedAt\": \"2022-05-20T08:01:04Z\",\n          \t\"message\": \"Failed to load image of the product.\",\n            \"status\": \"WARN\"\n        }\n    ],\n    \"successCount\": 1,\n    \"warnCount\": 1,\n    \"failCount\": 0,\n    \"totalCount\": 2\n}"
        4XX

        4XX

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