Skip to main content

useBuyerAttributes

The useBuyerAttributes hook fetches shopping preference signals for personalization. Returns genderAffinity (MALE, FEMALE, or NEUTRAL) and categoryAffinities (list of product taxonomy categories the user engages with). Use this data to customize product recommendations, filter content, or tailor messaging. This is privacy-sensitive data derived from the user's Shop activity, always handle respectfully and transparently in your UI.

Caution

This hook requires adding the following scopes to the manifest file:

profile

For more details, see manifest.json.

Anchor to useBuyerAttributes
useBuyerAttributes(
params
)

Anchor to useBuyerAttributes-parametersParameters

Anchor to params params

Anchor to useBuyerAttributes-returnsReturns

UseBuyerAttributesParams

fetchPolicy
```
DataHookFetchPolicy
```
skip
```
boolean
```

DataHookFetchPolicy

'cache-first' | 'network-only'

UseBuyerAttributesReturns

buyerAttributes
```
BuyerAttributes | null
```
error
```
Error | null
```
loading
```
boolean
```
refetch
```
() => Promise<void>
```

BuyerAttributes

categoryAffinities
```
TaxonomyCategory[]
```
genderAffinity
```
Gender
```

TaxonomyCategory

ancestors
```
TaxonomyCategory[]
```
id
```
string
```
name
```
string
```

Gender

'MALE' | 'FEMALE' | 'NEUTRAL'

Examples

tsx

import {useEffect} from 'react'

import {useBuyerAttributes} from '@shopify/shop-minis-react'

export default function MyComponent() {

const {buyerAttributes} = useBuyerAttributes()

useEffect(() => {

if (buyerAttributes) {

const {genderAffinity, categoryAffinities} = buyerAttributes

console.log({genderAffinity, categoryAffinities})

}

}, [buyerAttributes])

}

Examples

tsx

import {useEffect} from 'react'

import {useBuyerAttributes} from '@shopify/shop-minis-react'

export default function MyComponent() {
  const {buyerAttributes} = useBuyerAttributes()

  useEffect(() => {
    if (buyerAttributes) {
      const {genderAffinity, categoryAffinities} = buyerAttributes
      console.log({genderAffinity, categoryAffinities})
    }
  }, [buyerAttributes])
}

Was this page helpful?