checkoutProfiles

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 id • id: Filter by id range.
Anchor to is_published • boolean

reverse

•

BooleanDefault:false

Reverse the order of the underlying list.

sortKey

•

CheckoutProfileSortKeysDefault:UPDATED_AT

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges • [CheckoutProfileEdge!]!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 • [CheckoutProfile!]!non-null: A list of nodes that are contained in CheckoutProfileEdge. 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?

Reference checkout profiles

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

query checkoutProfiles {
  checkoutProfiles(first: 10) {
    nodes {
      id
      isPublished
    }
  }
}

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 checkoutProfiles { checkoutProfiles(first: 10) { nodes { id isPublished } } }"
}'

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

const response = await admin.graphql(
  `#graphql
  query checkoutProfiles {
    checkoutProfiles(first: 10) {
      nodes {
        id
        isPublished
      }
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query checkoutProfiles {
    checkoutProfiles(first: 10) {
      nodes {
        id
        isPublished
      }
    }
  }`,
});

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 checkoutProfiles {
    checkoutProfiles(first: 10) {
      nodes {
        id
        isPublished
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

1{
2  "checkoutProfiles": {
3    "nodes": [
4      {
5        "id": "gid://shopify/CheckoutProfile/890967685",
6        "isPublished": true
7      }
8    ]
9  }
10}