Skip to content

Get Brands List

Overview

GET /api/v2/brands

An endpoint which returns all Brands, and optionally with associated Products, consolidated products, locations, and integrations, for all active merchants & products which are visible to the current user.

Request

Query parameters

Consolidated

Key: consolidated

Values: boolean

Example: ?consolidated=1

If given, limits the results to only include / exclude consolidated brands. If not given, all brands, consolidated or otherwise, are returned.

Embedded Entities

The endpoint supports embedding related entities - for a detailed overview of how this works, please read the API Overview.

Relation Entity Description
products Product The list of products specific to a brand
consolidated_products Product The list of consolidated products a brand will accept
stores Store The list of stores for this brand

Format of response

This endpoint returns one or more full Brand entities which are active and have active Products.

Examples

Get all brands

GET /api/v2/brands

{
    "data": [
        {
            "id": "a_brand_id",
            "consolidated": 0,
            "products": [
                "a_product_id",
            ],
            "consolidated_products": [
                "a_consolidated_product_id"
            ],
            ...
        },
        {
            "id": "another_brand_id",
            "consolidated": 0,
            "products": [
                "another_product_id",
            ],
            "consolidated_products": [
                "a_consolidated_product_id"
            ],
            ...
        },
        {
            "id": "a_consolidated_brand_id",
            "consolidated": 1,
            "products": [
                "a_consolidated_product_id"
            ],
            "consolidated_products": [ ],
            ...
        }
    ]
}

Get all brands, with products and consolidated products

GET /api/v2/brands?embed[]=products&embed[]=consolidated_products

{
    "data": [
        {
            "id": "a_brand_id",
            "consolidated": 0,
            "products": [
                "a_product_id"
            ],
            "consolidated_products": [
                "a_consolidated_product_id"
            ],
            ...
        },
        {
            "id": "another_brand_id",
            "consolidated": 0,
            "products": [
                "another_product_id"
            ],
            "consolidated_products": [
                "a_consolidated_product_id"
            ],
            ...
        },
        {
            "id": "a_consolidated_brand_id",
            "consolidated": 1,
            "products": [
                "a_consolidated_product_id"
            ],
            "consolidated_products": [ ],
            ...
        }
    ],
    "embedded": {
        "products": [
            {
                "id": "a_product_id",
                "brand_id": "a_brand_id",
                ...
            },
            {
                "id": "another_product_id",
                "brand_id": "another_brand_id",
                ...
            },
            {
                "id": "a_consolidated_product_id",
                "brand_id": "a_consolidated_brand_id",
                ...
            }
        ]
    }
}

Get only consolidated brands

GET /api/v2/brands?consolidated=1

{
    "data": [
        {
            "id": "a_consolidated_brand_id",
            "consolidated": 1,
            "products": [
                "a_consolidated_product_id"
            ],
            "consolidated_products": [ ],
            ...
        }
    ]
}