Skip to content

Get a Single Category

Overview

GET /api/v2/product-tags/categories/{id}

This endpoint will return data for a specified Category.

Request

URL parameters

ID

Values: id

The id of the category being requested

Embedded Entities

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

Relation Entity Description
products Product The products associated with the Category
products.brand Brand The brand associated with the Product

Examples

Get a Category

GET /api/v2/product-tags/categories/a_category_id

{
    "data": {
        "id": "a_category_id",
        "name": "a_category_name",
        "image_url": "a_image_url",
        "type": "Category",
        "featured": 1,
        "products": [
            "a_product_id"
        ]
    },
}

Get a Category with Products

GET /api/v2/product-tags/categories/a_category_id?embed[]=products

{
    "data": {
        "id": "id",
        "name": "lunch",
        "image_url": "",
        "type": "Category",
        "featured": 1,
        "products": [
            "a_product_id"
        ]
    },
    "embedded": {
        "products": [
            {
                "id": "a_product_id",
                "price": "3.00"
                ...
            },
            {
                ...
            }
        ]
    }
}