customerSegments query

data-variant=info

data-slots=text

This query was created for the Storefront Compatibility Package and is now available on Adobe Commerce 2.4.9.

The customerSegments query provides the encoded ID of customer segments assigned to the logged-in customer or guest shopper.

To retrieve customer segments for a customer, we recommend you use customer tokens in the header of your GraphQL calls. However, in case of guest information, token should not be passed.

Syntax

{ customerSegments(cartId: String!) {[CustomerSegmentStorefront!] } }

Example usage

The following call returns encoded ID of customer group for logged-in customer or guest. Provide the customer's token in the header section of the query in case of logged-in customer.

Request:

{
    customerSegments(cartId: "jkdldskfdjsdkdsljds==") {
        uid
    }
}

Response:

{
  "data": {
    "customerSegments": [
      {
        "uid": "Nq=="
      }
    ]
  }
}