List all product brands

GET/v1/api/store/{team_slug}/get_all_product_brands

v1Operation ID v1_public_product_brands_index

Returns every brand name in use: the brands of all supplier catalogs YoPrint carries, plus the brands of your own products (deleted ones included). For autocomplete. The answer is {"data": [...]} with no success or status fields, and may contain null.

Permission

Any member of the team.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team

Request body

This operation takes no request body.

Response

200The names, in no set order. Only data: no success or status.

• dataarray of stringsrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

Notes

• The catalog part covers every supplier, not only the ones your team connected.

Related

• GETList all size names/v1/api/store/{team_slug}/get_all_product_sizes

Example request

curl

curl 'https://secure.yoprint.com/v1/api/store/your-team/get_all_product_brands' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": [
    "Example Brand",
    "Northwind"
  ]
}