Shortform object

The Shortform object contains the video and various metadata that make up an individual shortform. You can use this object to create a preview screen composed of multiple thumbnails or to construct feeds for playing individual shortform. The Shortform search API or retrieval API can provide access to this object's information.

Please note that currently, only search and retrieval functionality for Shortforms are available via the API. However, in the near future, API support for creating, updating, and deleting Shortforms is also planned to be introduced. With the addition of these new functionalities, customers will be able to directly manage Shortforms through the API.

Shortform object

Field	Type	Description
shortformId	String!	Unique ID assigned to each Shortform generated by the Shoplive system.
createdAt	String!	Date and time when the Shortform was created is in the following format: (format: YYYY-MM-DD'T'HH:mm:ss'Z', e.g. 2023-12-25T08:00:00Z)
updatedAt	String!	Date and time when the Shortform was updated is in the following format: (format: YYYY-MM-DD'T'HH:mm:ss'Z', e.g. 2023-12-25T08:00:00Z)
status	String!	Status flag of the visibility of a shortform (OPEN \| HIDDEN \| SCHEDULED)
details	details	The details of each shortform include the following properties. - title - description - brand - tags - productCount - productBanner - products
activity	activity	The activity information associated with each shortform includes the following properties. - viewCount - likeCount - commentCount - bookmarkCount - shareCount
video	video	The property of the video associated with the shortform includes the following properties. - duration - videoId - videoUrl - previewVideoUrl - screenshotUrl

Details object

The details of each shortform include the following properties.

Field	Type	Description
title	String!	Title of the shortform
description	String?	Description of the shortform
brand	brand	Brand information set for the shortform
tags	List?	Tag information set for the shortform (Max 5 tags can be set)
productCount	Integer!	Number of products set in the shortform
productBanner	productBanner	Product banner information set in the shortform
products	products	Information about the products associated with the shortform.

Activity object

The activity information associated with each shortform includes the following properties. Please be informed that you cannot obtain activity values such as likeCount, commentCount, bookmarkCount, and shareCount through the results of this search API.

Field	Type	Description
viewCount	Integer!	Number of users who have watched the shortform
likeCount	Integer?	Number of times the shortform has been liked (not available in the Search API)
commentCount	Integer?	Number of comments on the shortform (not available in the Search API)
bookmarkCount	Integer?	Number of times the shortform has been bookmarked (not available in the Search API)
shareCount	Integer?	Number of times the shortform has been shared (not available in the Search API)

Video object

The property of video associated with the shortform includes the following properties.

Field	Type	Description
duration	Integer!	Total playback duration of the shortform video (in milliseconds).
videoId	String!	Unique video ID (string) of the shortform video managed by Shoplive.
videoUrl	String!	Playback URL (m3u8) of the shortform video. This is the original video of the shortform and should not be used for preview screens. It is recommended for client implementation of feeds. Adaptive Bitrate needs to be implemented manually.
previewUrl	String!	Preview video URL (m3u8) of the shortform video. This URL is used to play a low-resolution (320P) video for preview screens. If repeated playback of a video with a length of X seconds is required, it needs to be implemented manually.
screenshotUrl	String!	URL for displaying the thumbnail image of the short form video.

Brand object

Field	Type	Description
id	String!	Brand ID
identifier	String!	Unique string for brand identification
name	String!	Brand Name
imageUrl	String!	Brand image URL

ProductBanner object

A product banner is a banner that can be displayed at the top of a UI where a list of products is shown. It is commonly used on product campaigns or promotion pages, with a link inserted into the banner.

Field	Type	Description
title	String!	Product Banner Title
imageUrl	String?	Product Banner Image URL
scheme	String?	URL or Scheme to which the Product Banner will redirect when clicked.

Products object

Please note that even if multiple products are set in a single Shortform, in the search API, only the most recently set product is returned in the API result.

Field	Type	Description
productId	String!	The unique product ID managed by the Shoplive system.
name	String!	Product Title
brand	String?	Brand Information of the Product
url	String!	Product Detail Page URL
sku	String?	Product SKU Information
imageUrl	String?	Product Image URL
currency	String!	Currency information of the Product
showPrice	Boolean!	Flag to indicate if the Product Price should be displayed (true \| false)
originalPrice	Double!	Original Price of the Product
discountPrice	Double?	Discounted Price of the Product
discountRate	Double?	Discount Percentage of the Product Price
stockStatus	String!	Stock Status of the Product (IN_STOCK \| LOW_IN_STOCK \| SOLD_OUT)

Sample

<div class="cm-s-neo" style="box-sizing: border-box; display: inherit;">{
    <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"shortformId"</span> : <span class="cm-string" style="box-sizing: border-box; color: rgb(179, 94, 20);">"123456789012345678"</span>,
    <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"createdAt"</span> : <span class="cm-string" style="box-sizing: border-box; color: rgb(179, 94, 20);">"2023-12-25T08:00:00Z"</span>, 
    <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"updatedAt"</span> : <span class="cm-string" style="box-sizing: border-box; color: rgb(179, 94, 20);">"2023-12-26T08:00:00Z"</span>,
    <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"status"</span> : <span class="cm-string" style="box-sizing: border-box; color: rgb(179, 94, 20);">"OPEN"</span>,
    <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"details"</span> : {
      <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"title"</span> : <span class="cm-string" style="box-sizing: border-box; color: rgb(179, 94, 20);">"Shortform Title"</span>,
      <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"description"</span> : <span class="cm-string" style="box-sizing: border-box; color: rgb(179, 94, 20);">"This is a sample description"</span>,
      <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"brand"</span> : {
        <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"id"</span> : <span class="cm-number" style="box-sizing: border-box; color: rgb(117, 67, 138);">123</span>,
        <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"identifier"</span> : <span class="cm-string" style="box-sizing: border-box; color: rgb(179, 94, 20);">"shoplive"</span>, 
        <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"name"</span> : <span class="cm-string" style="box-sizing: border-box; color: rgb(179, 94, 20);">"Shoplive"</span>,
        <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"imageUrl"</span> : <span class="cm-string" style="box-sizing: border-box; color: rgb(179, 94, 20);">"https://image.shoplive.cloud/brand-image.png"</span>
      },
      <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"tags"</span> : [ <span class="cm-string" style="box-sizing: border-box; color: rgb(179, 94, 20);">"food"</span>, <span class="cm-string" style="box-sizing: border-box; color: rgb(179, 94, 20);">"snack"</span> ],
      <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"productCount"</span> : <span class="cm-number" style="box-sizing: border-box; color: rgb(117, 67, 138);">3</span>,
      <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"productBanner"</span> : {
        <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"title"</span> : <span class="cm-string" style="box-sizing: border-box; color: rgb(179, 94, 20);">"Product Banner Title"</span>,
        <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"imageUrl"</span> : <span class="cm-string" style="box-sizing: border-box; color: rgb(179, 94, 20);">"https://image.shoplive.cloud/product-banner-image.png"</span>,
        <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"scheme"</span>: <span class="cm-string" style="box-sizing: border-box; color: rgb(179, 94, 20);">"https://www.shoplive.cloud/product"</span> 
      },
      <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"products"</span> : [ {
        <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"productId"</span> : <span class="cm-number" style="box-sizing: border-box; color: rgb(117, 67, 138);">54321</span>,
        <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"name"</span> : <span class="cm-string" style="box-sizing: border-box; color: rgb(179, 94, 20);">"Shoelive T-shirts"</span>,
        <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"brand"</span> : <span class="cm-string" style="box-sizing: border-box; color: rgb(179, 94, 20);">"Shoplive Brand"</span>,
        <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"url"</span> : <span class="cm-string" style="box-sizing: border-box; color: rgb(179, 94, 20);">"https://shoplivedemo.com/product/54321"</span>,
        <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"sku"</span> : <span class="cm-string" style="box-sizing: border-box; color: rgb(179, 94, 20);">"sku001"</span>,
        <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"imageUrl"</span> : <span class="cm-string" style="box-sizing: border-box; color: rgb(179, 94, 20);">"https://image.shoplive.cloud/product-image.png"</span>,
        <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"currency"</span> : <span class="cm-string" style="box-sizing: border-box; color: rgb(179, 94, 20);">"KRW"</span>,
        <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"showPrice"</span> : <span class="cm-atom" style="box-sizing: border-box; color: rgb(117, 67, 138);">true</span>,
        <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"originalPrice"</span> : <span class="cm-number" style="box-sizing: border-box; color: rgb(117, 67, 138);">3400.0</span>,
        <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"discountPrice"</span> : <span class="cm-number" style="box-sizing: border-box; color: rgb(117, 67, 138);">2500.0</span>,
        <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"discountRate"</span> : <span class="cm-number" style="box-sizing: border-box; color: rgb(117, 67, 138);">26.0</span>,
        <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"stockStatus"</span> : <span class="cm-string" style="box-sizing: border-box; color: rgb(179, 94, 20);">"IN_STOCK"</span>
      } ]
    },
    <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"activity"</span> : {
      <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"viewCount"</span> : <span class="cm-number" style="box-sizing: border-box; color: rgb(117, 67, 138);">2345</span>,
      <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"likeCount"</span> : <span class="cm-number" style="box-sizing: border-box; color: rgb(117, 67, 138);">123</span>,
      <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"commentCount"</span> : <span class="cm-number" style="box-sizing: border-box; color: rgb(117, 67, 138);">123</span>,
      <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"bookmarkCount"</span> : <span class="cm-number" style="box-sizing: border-box; color: rgb(117, 67, 138);">123</span>,
      <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"shareCount"</span> : <span class="cm-number" style="box-sizing: border-box; color: rgb(117, 67, 138);">321</span> 
    },
    <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"video"</span> :  {
      <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"duration"</span> : <span class="cm-number" style="box-sizing: border-box; color: rgb(117, 67, 138);">3600</span>,
      <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"videoId"</span> : <span class="cm-string" style="box-sizing: border-box; color: rgb(179, 94, 20);">"1234"</span>,
      <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"videoUrl"</span> : <span class="cm-string" style="box-sizing: border-box; color: rgb(179, 94, 20);">"https://resource.shoplive.cloud/video/shortsform/video.m3u8"</span>,
      <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"previewVideoUrl"</span> : <span class="cm-string" style="box-sizing: border-box; color: rgb(179, 94, 20);">"https://resource.shoplive.cloud/video/shortsform/previewVideo.m3u8"</span>,
      <span class="cm-property" style="box-sizing: border-box; color: rgb(29, 117, 179);">"screenshotUrl"</span> : <span class="cm-string" style="box-sizing: border-box; color: rgb(179, 94, 20);">"https://image.shoplive.cloud/shortform/screenshot.png"</span>
    } ,
}</div>

Shortform object

Shortform object

Details object

Activity object

Video object

Brand object

ProductBanner object

Products object

Sample

What's Next