storefront

Brand detail: descriptions + visible custom fields (by slug)

get/api/v1/storefront/brands/{slug}

Request

  • Base URL: https://api.foundryims.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.foundryims.com/api/v1/storefront/brands/{slug}
  • Auth: HTTP bearer

Path parameters

slugstring required

Response

idstring required
namestring required
slugstring nullable required
description1string nullable required

Rich-text (HTML) description.

description2string nullable required

Rich-text (HTML) description.

metaTitlestring required

Resolved SEO <title>; falls back to the brand name when unset.

metaDescriptionstring required

Resolved SEO meta description; falls back to an excerpt of description1 when unset.

Example response

{
  "slug": "acme-co",
  "customFields": [
    {
      "key": "cooling_capacity",
      "label": "Cooling Capacity",
      "unit": "BTU/h",
      "type": "number",
      "group": "Performance",
      "displayOrder": 10
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.