Shortform object

    Shortform object


    Article Summary

    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

    FieldTypeDescription
    shortformIdString!Unique ID assigned to each Shortform generated by the Shoplive system.
    createdAtString!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)
    updatedAtString!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)
    statusString!Status flag of the visibility of a shortform
    (OPEN | HIDDEN | SCHEDULED)
    detailsdetailsThe details of each shortform include the following properties.
    - title
    - description
    - brand
    - tags
    - productCount
    - productBanner
    - products
    activityactivityThe activity information associated with each shortform includes the following properties.
    - viewCount
    - likeCount
    - commentCount
    - bookmarkCount
    - shareCount
    videovideoThe 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.

    FieldTypeDescription
    titleString!Title of the shortform
    descriptionString?Description of the shortform
    brandbrandBrand information set for the shortform
    tagsList?Tag information set for the shortform (Max 5 tags can be set)
    productCountInteger!Number of products set in the shortform
    productBannerproductBannerProduct banner information set in the shortform
    productsproductsInformation 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.

    FieldTypeDescription
    viewCountInteger!Number of users who have watched the shortform
    likeCountInteger?Number of times the shortform has been liked (not available in the Search API)
    commentCountInteger?Number of comments on the shortform (not available in the Search API)
    bookmarkCountInteger?Number of times the shortform has been bookmarked (not available in the Search API)
    shareCountInteger?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.

    FieldTypeDescription
    durationInteger!Total playback duration of the shortform video (in milliseconds).
    videoIdString!Unique video ID (string) of the shortform video managed by Shoplive.
    videoUrlString!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.
    previewUrlString!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.
    screenshotUrlString!URL for displaying the thumbnail image of the short form video.



    Brand object

    FieldTypeDescription
    idString!Brand ID
    identifierString!Unique string for brand identification
    nameString!Brand Name
    imageUrlString!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.

    FieldTypeDescription
    titleString!Product Banner Title
    imageUrlString?Product Banner Image URL
    schemeString?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.

    FieldTypeDescription
    productIdString!The unique product ID managed by the Shoplive system.
    nameString!Product Title
    brandString?Brand Information of the Product
    urlString!Product Detail Page URL
    skuString?Product SKU Information
    imageUrlString?Product Image URL
    currencyString!Currency information of the Product
    showPriceBoolean!Flag to indicate if the Product Price should be displayed (true | false)
    originalPriceDouble!Original Price of the Product
    discountPriceDouble?Discounted Price of the Product
    discountRateDouble?Discount Percentage of the Product Price
    stockStatusString!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" } , }