A brand is a manufacturer or label. Brands are their own records, not a text attribute: each has an id, a name, a slug, a status and custom fields, starting with a rich-text Description. A product points at at most one brand by brandId, so renaming a brand never breaks the link.
In the admin
Brands live under Catalog → Brands.
- Under Add a brand, type the name and click Add. The slug is generated from the name and you land on the brand’s page.
- Under Identity, edit Name, Slug and Status, then click Save. Under Fields, write the description.
- To brand a product, open it and choose the Brand in Key details, then click Save changes.
The brands list shows each brand’s product count. Delete brand (or the trash icon on the list) warns how many products will become unbranded before deleting.
With the API
| Method | Path | What it does |
|---|---|---|
| GET | /v1/brands | List with status, q (name search), slug, sorting and paging |
| POST | /v1/brands | Create |
| GET / PATCH / DELETE | /v1/brands/{id} | Read, update, delete |
curl -X POST https://api.minipim.com/v1/brands \
-H "Authorization: Bearer pim_…" \
-H "Content-Type: application/json" \
-d '{ "name": "Orbus Exhibit & Display" }'
Assign a brand with PATCH /v1/products/{id} and { "brandId": "…" }; send null to remove it. Filter products by brand with GET /v1/products?brandId=…. Add ?withProductCounts=true to the brand list to get a productCount per brand. Full reference: api.minipim.com/docs.
Rules and limits
nameis required.slugis derived from the name when omitted.statusdefaults toactive.- Names are unique per organization ignoring case, and slugs are unique too. A clash returns 409.
GET /v1/brandspages like other lists:limitdefaults to 50, max 200, and the response carrieshasMore.productCountcounts products of every status.- Deleting a brand never deletes products. Their
brandIdis set to null. If the brand still has products,DELETEreturns 422 unless you pass?force=true. Thebrand.deletedevent reports how many products were unbranded. GET /v1/products?brand=matches the brand’s name, ignoring case. PreferbrandId, which survives renames.- Custom fields are validated against the organization’s brand family. Fields beyond Description are added through the API, like category fields (see Categories).
- PATCH merges
attributesper code, like products. - A
brandrequirement in channel readiness is satisfied by the product’sbrandId. - The BigCommerce connector imports brands and links products to them.
- Writes emit
brand.created,brand.updatedandbrand.deleted.
See also
- Products — How minipim products work: family, slug, attribute payload and tags, plus creating, editing, duplicating and deleting them in the admin or via the API.
- Categories — Build a minipim category tree, nest and reorder categories, give them a status and custom fields, assign products, and query a whole subtree through the API.
- Attribute families — Attribute families define which attributes a minipim product carries: attaching attributes, requirement overrides, ordering, moving products, deletion.
- Channels and readiness — Channels are where your catalog is sold. Set per-channel required attributes, read readiness scores, and learn how channel-specific values and deletes work.