v2 > Services > BrandsGet

get one or more brands in Origin. The get result is organized in pages.

  • URL

    /connect/v2/brands/get

  • Method:

    GET

  • URL Params

Param Type Required Description Domain of value
locale string Yes An Origin supported locale 'de', 'es_MX', 'en', 'fr' or 'zh_CN'
pageNumber number Yes The page number the search result will start from Positive integer greater than 0
pageSize number Yes The maximum number of result by page Integer between 1 and 100

  • Sample URL

    /connect/v2/brands/get?locale=en&pageNumber=1&pageSize=10

  • Request :

    The request has no body.

  • Response :

Field Type Presence Description Domain of value
status object Always The execution status A status object
status.state string Always The state of execution 'SUCCESS' or 'ERROR'
status.code string On error The general error code and message See Errors reference
status.messages[] array of string On error List of error causes A validation message or other causes
result object On success The execution result A result object
result.entityType string On success The type of entity this result is about 'BRAND'
result.searchInfo object On success Informations about the search result pages A searchInfo object
result.searchInfo.numberOfElements object On success The total number of elements found A positive integer
result.searchInfo.numberOfPages object On success The total number of pages NumberOfElements / pageSize
result.data[] array of object On success The actual search result : a list of brands Array of brand object
result.data[].locale string On success An Origin supported locale 'de', 'es_MX', 'en', 'fr' or 'zh_CN'
result.data[].originId string On success The brand unique origin ID A UUID
result.data[].externalId string On success The brand unique ID in your system Any string
result.data[].name string On success The brand name Any string
result.data[].description string On success The brand description Any string
result.data[].isMainBrand string On success Flag to indicate whether the current Brand is the Main Brand A boolean value
result.data[].website string On success The brand website A valid public facing URL
result.data[].logoUrl object On success The brand logo URL A logoUrl object
result.data[].logoUrl.originalUrl string On success The brand logo original URL A public facing URL
result.data[].logoUrl.referenceUrl string On success The brand logo reference URL A public facing URL
connectRequest object Always The exact request sent that produced this response A BrandsGet request

  • Sample Response (Success):

    HTTP Code : 200

{
    "status": {
        "state": "SUCCESS"
    },
    "result": {
        "entityType": "BRAND",
        "searchInfo": {
            "numberOfElements": "1",
            "numberOfPages": "1"
        },
        "data": [
            {
                "locale": "en",
                "originId": "93bcbf18-51fb-11e8-8716-8c16451835eb",
                "externalId": "00006060-8ebf-4a0f-94a5-de7c949a1a28",
                "name": "XYZ Modular Furniture",
                "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut tincidunt orci eget lacus dignissim bibendum.",
                "isMainBrand": "true",
                "website": "https://www.xyzmodfurniture.tld",
                "logoUrl": {
                    "originalUrl": "https://www.xyzmodfurniture.tld/public/img/xyzmod/XYZ-asset-image-0-4444.jpeg",
                    "referenceUrl": "https://origin.build/equinox/storage/public/XYZ-asset-image-0-4444.jpeg"
                }
            }
        ]
    },
    "connectRequest": {
        "locale": "en",
        "pageNumber": "1",
        "pageSize": "100"
    }
}

  • Sample Response (Error):

    HTTP Code : 400, 500

{
    "status": {
        "state": "ERROR",
        "code": "CE00001 - Connect request failed validation. Refer to provided messages for details.",
        "messages": [
            "Request has invalid value '0' for field pageNumber. Allowed value(s) : [positive integer not equal zero]"
        ]
    },
    "connectRequest": {
        "locale": "en",
        "pageNumber": "0",
        "pageSize": "1",
    }
}

results matching ""

    No results matching ""