Contents x
    Search shortform objects
      • Print
      Contents

      Search shortform objects

        • Print
        Article summary

        Get
        /v2/{accessKey}/shortform

        When using the Shortform search API, consider the followings to improve your search experience:
        \

        • Even if multiple products are set in a single Shortform, only the most recently set product is returned in the search API result.
        • When using the API for the preview screen of a shortform, it is recommended to use the previewVideoUrl property. The videoUrl contains the original video, which has a higher resolution and requires a larger amount of data for playback.
        • You can set the search condition as either AND or OR when searching with multiple tags. (e.g., &tags=tag1,tag2,tag3&tagSearchOperator=AND|OR)
        • When querying the results from the API, you can decide which column to use as the sorting criterion among sortOrder, createdAt, and updatedAt. The sorting order can be specified using the sortAscending parameter.
        • In the search API, only the viewCount information is provided in the current Activity object. To retrieve the likeCount, commentCount, bookmarkCount, and shareCount, you need to use the "Retrieve a shortform API"
        Header parameters
        Authorization
        stringRequired

        Authorization: Bearer

        Path parameters
        accessKey
        stringRequired

        Customer access key

        Query parameters
        from
        string

        Search shortforms between FROM and TO of createdAt date range (format: YYYY-MM-DD'T'HH:mm:ss'Z', e.g. 2022-05-20T08:00:00Z)

        to
        string

        Search shortforms between FROM and TO of createdAt date range (format: YYYY-MM-DD'T'HH:mm:ss'Z', e.g. 2022-05-20T08:00:00Z)

        status
        string

        Status flag of the visibility of a shortform

        Valid values[ "OPEN", "HIDDEN", "SCHEDULED" ]
        title
        string

        Title of the shortform

        description
        string

        Description of the shortform

        brand
        string

        Brand information set for the shortform

        tags
        string

        Comma separated tags for search. Pleas use tagSearchOperator to specify AND or OR query.

        skus
        string

        Comma separated skus for search. Providing multiple skus to work with OR condition.

        tagSearchOperator
        string

        Please specify search operator when searching by tags

        Valid values[ "AND", "OR" ]
        page
        integer (int32)

        Parameter for pagination. Default is 1.

        Default1
        count
        integer (int32)

        Specify the number of the result in one page (min: 1 and max : 30)

        Default10
        sortColumn
        string

        Please use this field if you need to specify the column for sorting

        Valid values[ "sortOrder", "createdAt", "updatedAt" ]
        sortAscending
        boolean

        Sort the result of the query

        Defaultfalse
        Responses
        200

        200

        Result
        "{\n    \"shortformId\" : \"123456789012345678\",\n    \"createdAt\" : \"2023-12-25T08:00:00Z\", \n    \"updatedAt\" : \"2023-12-26T08:00:00Z\",\n    \"status\" : \"OPEN\",\n    \"details\" : {\n      \"title\" : \"Shortform Title\",\n      \"description\" : \"This is a sample description\",\n      \"brand\" : {\n        \"id\" : 123,\n        \"identifier\" : \"shoplive\", \n        \"name\" : \"Shoplive\",\n        \"imageUrl\" : \"https://image.shoplive.cloud/brand-image.png\"\n      },\n      \"tags\" : [ \"food\", \"snack\" ],\n      \"productCount\" : 3,\n      \"productBanner\" : {\n        \"title\" : \"Product Banner Title\",\n        \"imageUrl\" : \"https://image.shoplive.cloud/product-banner-image.png\",\n        \"scheme\": \"https://www.shoplive.cloud/product\" \n      },\n      \"products\" : [ {\n        \"productId\" : 54321,\n        \"name\" : \"Shoelive T-shirts\",\n        \"brand\" : \"Shoplive Brand\",\n        \"url\" : \"https://shoplivedemo.com/product/54321\",\n        \"sku\" : \"sku001\",\n        \"imageUrl\" : \"https://image.shoplive.cloud/product-image.png\",\n        \"currency\" : \"KRW\",\n        \"showPrice\" : true,\n        \"originalPrice\" : 3400.0,\n        \"discountPrice\" : 2500.0,\n        \"discountRate\" : 26.0,\n        \"stockStatus\" : \"IN_STOCK\"\n      } ]\n    },\n    \"activity\" : {\n      \"viewCount\" : 2345\n    },\n    \"video\" : [ {\n      \"duration\" : 3600,\n      \"videoId\" : \"1234\",\n      \"videoUrl\" : \"https://resource.shoplive.cloud/video/shortsform/video.m3u8\",\n      \"previewVideoUrl\" : \"https://resource.shoplive.cloud/video/shortsform/previewVideo.m3u8\",\n      \"screenshotUrl\" : \"https://image.shoplive.cloud/shortform/screenshot.png\"\n    } ],\n}"
        4XX

        4XX

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