segmentValueSuggestions

The list of suggested values corresponding to a particular filter for a segment. A segment is a group of members, such as customers, that meet specific criteria.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the segmentValueSuggestions action (under Segment).
Fill in the fields below, then reference the result from later steps as {{segmentvaluesuggestions.response.data}}.

Query

This is the query the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

query SegmentValueSuggestions($search: String!, $filterQueryName: String, $functionParameterQueryName: String, $first: Int, $after: String, $last: Int, $before: String) {
  segmentValueSuggestions(
    search: $search
    filterQueryName: $filterQueryName
    functionParameterQueryName: $functionParameterQueryName
    first: $first
    after: $after
    last: $last
    before: $before
  ) {
    edges {
      cursor
      node {
        localizedValue
        queryName
      }
    }
    nodes {
      localizedValue
      queryName
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

searchstringrequired

Returns the elements of a list by keyword or term.

filterQueryNamestring

Returns the elements of a list by filter handle.

functionParameterQueryNamestring

Returns the elements of a list by filter parameter name.

firstnumber

The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

afterstring

The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

lastnumber

The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

beforestring

The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

json

{
  "search": "string",
  "filterQueryName": "string",
  "functionParameterQueryName": "string",
  "first": 0,
  "after": "string",
  "last": 0,
  "before": "string"
}

Response

Read the result with {{segmentvaluesuggestions.response.data.data.segmentValueSuggestions}}. If the API returns errors, the step fails and they are at {{segmentvaluesuggestions.response.data.errors}}.

edgesarray<object>

cursorobject

nodeobject

nodesarray<object>

localizedValueobject

queryNameobject

pageInfoobject

endCursorstring

hasNextPageboolean

hasPreviousPageboolean

startCursorstring

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?