publicBrands

Public: no authentication required.

Lists a seller's brands for the public storefront. Needs no sign-in. An unknown subdomain gives an empty list.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query PublicBrands($subdomain: String!) {
  publicBrands(subdomain: $subdomain) {
    id
    code
    name
    description
    logoUrl
    productCount
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query PublicBrands($subdomain: String!) {\n  publicBrands(subdomain: $subdomain) {\n    id\n    code\n    name\n    description\n    logoUrl\n    productCount\n  }\n}",
  "variables": {
    "subdomain": "string"
  }
}
EOF

Variables:

{
  "subdomain": "string"
}

Response:

{
  "data": {
    "publicBrands": [
      {
        "id": "id",
        "code": "string",
        "name": "string",
        "description": "string",
        "logoUrl": "string",
        "productCount": 0
      }
    ]
  }
}

publicBrands(
  categoryId: ID
  subdomain: String!
): [CustomerBrand!]!

Arguments

publicBrands.categoryId ● ID scalar

Only brands with products in this category or beneath it.

publicBrands.subdomain ● String! non-null scalar

The seller's storefront subdomain.

Type

CustomerBrand object

A brand a customer can shop.