GET and POST https://makelocalads.com/api/v1/brands,
PATCH and DELETE https://makelocalads.com/api/v1/brands/{brand_id}
Permissions: list with products:read, create with products:create,
update with products:update, delete with products:delete
Open in LocalAds
The brands and products of your workspace, on the app’s home screen.
List brands
product_count, its number of products (variants and
deleted products are not counted).
Use the returned id as brand_id when creating a product, or when listing
products and templates.
Sort and filter
Sorting and filtering happen on the server, so common questions take one request:
An unknown value returns
400 invalid_request.
Create a brand
If the brand you need is not in the list, create it. This is the first call for a website LocalAds has not seen before.Input fields
string
required
The brand’s name, 1 to 200 characters.
string
The brand’s own site, as a URL. LocalAds uses it to fetch the logo, and to
keep one brand per website.
array
ISO 3166-1 alpha-2 country codes where the brand sells, up to 50. Defaults
to an empty list.
Complete JSON schema
Complete JSON schema
One brand per website
Posting a second brand for a domain that already has one returns409 brand_website_exists with the existing brand’s name, so retrying a
setup script does not litter the account with duplicates. Send an
Idempotency-Key to make a network retry safe as well; see
Idempotent requests.
Update a brand
Rename a brand or change its website or selling countries. Only the fields you send change;selling_countries replaces the whole list. A new website
refreshes the brand’s logo, and "website_url": null removes it.
400 invalid_request.
Delete a brand
204 No Content. Afterwards the brand and its
products return 404 brand_not_found and 404 product_not_found.
You do not need to send brand_id when retrieving a resource by its ID.
Photoshoot creation also omits it: LocalAds derives the brand from the
selected product, and requires a template to belong to that same brand.