Contents x
    Retrieve a brand
      • Print
      Contents

      Retrieve a brand

        • Print
        Article summary

        Get
        /v2/{accessKey}/brand/{brandId}
        Header parameters
        Authorization
        stringRequired

        Authorization: Bearer

        Path parameters
        accessKey
        stringRequired

        Customer access key

        brandId
        stringRequired

        BrandId to retrieve

        Query parameters
        keyword
        string

        Keyword to search frin name, identifier, and description of brands

        sortAscending
        boolean

        Sort the result of the query

        Defaultfalse
        page
        integer (int32)

        Parameter for pagination. Default is 1.

        Default1
        count
        integer (int32)

        Specify the number of the result in one page (max : 20)

        Default10
        Responses
        200

        200

        Expand All
        object
        results
        Array of object
        object
        brandId
        string
        Example100
        name
        string
        ExampleSHOPLIVE_BRAND_1
        identifier
        string
        ExampleSHOPLIVE_BRAND_IDENTIFIER
        description
        string
        Examplethis is a sample brand
        imageUrl
        string
        Examplehttps://shoplive.cloud/sample.jpg
        imageWidth
        integer
        Default0
        Example320
        imageHeight
        integer
        Default0
        Example200
        createdAt
        string
        Example32528912
        updatedAt
        string
        Example32528912
        4XX

        4XX

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