segments

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default • string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to id • id: Filter by id range.
Anchor to name • string

reverse

•

BooleanDefault:false

Reverse the order of the underlying list.

sortKey

•

SegmentSortKeysDefault:CREATION_DATE

Sort the underlying list by the given key.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges • [SegmentEdge!]!non-null: The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
Anchor to nodesnodes • [Segment!]!non-null: A list of nodes that are contained in SegmentEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.
Anchor to pageInfopageInfo • PageInfo!non-null: An object that’s used to retrieve cursor information about the current page.

Was this section helpful?

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  query {
6    segments(first: 3) {
7      edges {
8        node {
9          id
10        }
11      }
12    }
13  }`,
14);
15
16const data = await response.json();
17

query {
  segments(first: 3) {
    edges {
      node {
        id
      }
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { segments(first: 3) { edges { node { id } } } }"
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  query {
    segments(first: 3) {
      edges {
        node {
          id
        }
      }
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    segments(first: 3) {
      edges {
        node {
          id
        }
      }
    }
  }`,
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    segments(first: 3) {
      edges {
        node {
          id
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

1{
2  "segments": {
3    "edges": [
4      {
5        "node": {
6          "id": "gid://shopify/Segment/210588551"
7        }
8      },
9      {
10        "node": {
11          "id": "gid://shopify/Segment/250599805"
12        }
13      },
14      {
15        "node": {
16          "id": "gid://shopify/Segment/631221407"
17        }
18      }
19    ]
20  }
21}