List brands
Lists the brands the marketplace accepts.
List brands
- MockDevelopment only
- Mercado LivreNot supported
- MagaluPlanned
- AmazonPlanned
- TikTok ShopPlanned
- ShopeePlanned
Returns the brands the marketplace knows, one page at a time. Filter by categoryId or search by name with query. Use the id or name when filling the brand attribute required in Listing requirements.
Creating a new brand has no common model: it is a native operation.
Part of Publish listings. Synchronous read, no Job, as in List categories.
api_keyAuthorizationBearer <token>API key (mk_...)
id*stringIdentifier of the resource, as returned by the API.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuidpage?integerPage number, starting at 1. Defaults to 1. A page beyond pagination.totalPages is not an error: it returns empty data.
1 <= value <= 90071992547409911pageSize?integerItems per page, from 1 to 100. Defaults to 20.
1 <= value <= 10020categoryId?stringOnly brands of this category.
1 <= length <= 200query?stringOnly brands whose name matches this text.
1 <= length <= 200One page of brands, optionally of one category or matching query. pagination carries the totals.
application/json- response
One page of brands.
data*array<>The brands of this page, in the order the marketplace gives them.
pagination*Where this page sits in the whole listing: the totals and whether there are pages before and after it.
curl -X GET "https://example.com/v1/connections/3d1c8a52-7f0e-4b0a-8a65-9c1b2f6d7e01/brands"{ "data": [ { "id": "mock-brand-acme", "name": "Acme", "marketplaceData": {} } ], "pagination": { "page": 1, "pageSize": 20, "totalItems": 57, "totalPages": 3, "hasNext": true, "hasPrev": false }}