README.md

Brands

The Brands API allows you to organize products into hierarchical groups. Where a shoe product might be in the category Shoes, the individual product might also be in the brand Nike.

The Brand object

{% tabs %} {% tab title="Attributes" %}

Attribute	Type	Description
id	string	The unique identifier for this brand
type	string	The type represents the object being returned
name	string	The name of the brand
slug	string	A unique slug for the brand
description	string	A description for the brand
status	string	live or draft depending on the brand status
meta	object	The meta object
relationships	object	The relationships object
{% endtab %}

{% tab title="Sample Response" %}

{
  "data": {
    "id": "9185d4ff-a484-408b-8c1a-d4de1ca20736",
    "type": "brand",
    "name": "Cool Clothing",
    "slug": "cool-clothing",
    "description": "Cool clothing make cool clothes!",
    "status": "live",
    "meta": {
      "timestamps": {
        "created_at": "2018-04-05T08:48:39+00:00",
        "updated_at": "2018-04-27T13:47:36+00:00"
      }
    }
  }
}

{% endtab %} {% endtabs %}

The meta object

Attribute	Type	Description
meta.timestamps	object	Timestamps for this brand
meta.timestamps.created_at	string	The creation date of this brand
meta.timestamps.updated_at	string	The updated date of this brand

The relationships object

Attribute	Type	Description
relationships.products	array[object]	An array of products for this brand
relationships.products.data	array[object]	An array of relationships from this brand to products resources
relationships.products.data.type	string	Always product
relationships.products.data.id	string	The unique identifier of the related product