Product object

productId

Long!

Automatically generated unique product ID.

customerProductId

String?

Customer's product ID and must be unique(defined by the customer). customerProductId can be set by Product API only and Shoplive Admin tool doesn't support the input form of this field at the moment. Shoplive Admin interface will be updated soon to accommodate this field.

name

String!

Product name.

brand

String?

Brand name.

brandIdentifier

String?

Brand id set by the customer.

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 image URL.

currency

String!

Currency of the price.

showPrice

Boolean!

Whether show the price or not on the Shoplive Player.

originalPrice

Double?

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

discountPrice

Double?

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

discountRate

Double?

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

enableAuction

Boolean!

Whether the product supports an auction.

bidStartingPrice

Double?

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

bidDuration

Integer?

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

bidIncrementalAmount

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.

ctaButtonTitle

String?

You can customize the CTA(call-to-action) title of the product. As it requires UI customization, it needs to be discussed with Shoplive. Please contact ask@shoplive.cloud if you want to use this feature.

locked

Boolean!

In the case of true, this product belongs to specific campaigns and cannot be deleted.

seller

Seller?

Seller information that owns the product.

createdAt

String!

Created DateTime when the campaign is created (format: YYYY-MM-DD'T'HH:mm:ss'Z')

updatedAt

String!

Updated DateTime when the campaign is updated (format: YYYY-MM-DD'T'HH:mm:ss'Z')