customerSearchBanner

DEPRECATED

Kept only for buyer-app versions released before the app read the storefront theme (D-116): they still call it. The Home CMS is retired (D-115/D-116); current apps read customerStorefrontPage. Remove once those versions are retired.

Requires a customer (portal or buyer app) session.

Returns the active SEARCH_BANNER for the organization, or null when admin has not authored one.

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 CustomerSearchBanner {
  customerSearchBanner {
    title
    href
    imageUrl
    kind
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query CustomerSearchBanner {\n  customerSearchBanner {\n    title\n    href\n    imageUrl\n    kind\n  }\n}"
}
EOF

Response:

{
  "data": {
    "customerSearchBanner": {
      "title": "string",
      "href": "string",
      "imageUrl": "string",
      "kind": "BRAND_PREMIX"
    }
  }
}

customerSearchBanner: InfoStripSection @deprecated

Type

InfoStripSection object

A static information banner at the top of the home screen, drawn as one image.