.png){kind=logo}
Shortform object
- Print
Shortform object
- Print
Article summary
Did you find this summary helpful?
Thank you for your feedback
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
Property name | 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 | The details of each shortform include the following properties.
| |
activity | The activity information associated with each shortform includes the following properties.
| |
video | The property of the video associated with the shortform includes the following properties.
|
Details object
The details of each shortform include the following properties.
Property name | Type | Description |
|---|---|---|
title | String! | Title of the shortform |
description | String? | Description of the shortform |
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 | Product banner information set in the shortform | |
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.
Property name | 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.
Property name | 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
Property name | 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.
Property name | 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.
Property name | 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
{
"shortformId": "123456789012345678",
"createdAt": "2023-12-25T08:00:00Z",
"updatedAt": "2023-12-26T08:00:00Z",
"status": "OPEN",
"details": {
"title": "Shortform Title",
"description": "This is a sample description",
"brand": {
"id": 123,
"identifier": "shoplive",
"name": "Shoplive",
"imageUrl": "https://image.shoplive.cloud/brand-image.png"
},
"tags": [ "food", "snack" ],
"productCount": 3,
"productBanner": {
"title": "Product Banner Title",
"imageUrl": "https://image.shoplive.cloud/product-banner-image.png",
"scheme": "https://www.shoplive.cloud/product"
},
"products": [ {
"productId": 54321,
"name": "Shoelive T-shirts",
"brand": "Shoplive Brand",
"url": "https://shoplivedemo.com/product/54321",
"sku": "sku001",
"imageUrl": "https://image.shoplive.cloud/product-image.png",
"currency": "KRW",
"showPrice": true,
"originalPrice": 3400.0,
"discountPrice": 2500.0,
"discountRate": 26.0,
"stockStatus": "IN_STOCK"
} ]
},
"activity": {
"viewCount": 2345,
"likeCount": 123,
"commentCount": 123,
"bookmarkCount": 123,
"shareCount": 321
},
"video": {
"duration": 3600,
"videoId": "1234",
"videoUrl": "https://resource.shoplive.cloud/video/shortsform/video.m3u8",
"previewVideoUrl": "https://resource.shoplive.cloud/video/shortsform/previewVideo.m3u8",
"screenshotUrl": "https://image.shoplive.cloud/shortform/screenshot.png"
}
}