carrierServices

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

reverse

•

BooleanDefault:false

Reverse the order of the underlying list.

sortKey

•

CarrierServiceSortKeysDefault:ID

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 • [DeliveryCarrierServiceEdge!]!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 • [DeliveryCarrierService!]!non-null: A list of nodes that are contained in DeliveryCarrierServiceEdge. 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?

Retrieve a list of CarrierServices

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  query CarrierServiceList {
6    carrierServices(first: 10, query: "active:true") {
7      edges {
8        node {
9          id
10          name
11          callbackUrl
12          active
13          supportsServiceDiscovery
14        }
15      }
16    }
17  }`,
18);
19
20const data = await response.json();
21

query CarrierServiceList {
  carrierServices(first: 10, query: "active:true") {
    edges {
      node {
        id
        name
        callbackUrl
        active
        supportsServiceDiscovery
      }
    }
  }
}

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 CarrierServiceList { carrierServices(first: 10, query: \"active:true\") { edges { node { id name callbackUrl active supportsServiceDiscovery } } } }"
}'

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

const response = await admin.graphql(
  `#graphql
  query CarrierServiceList {
    carrierServices(first: 10, query: "active:true") {
      edges {
        node {
          id
          name
          callbackUrl
          active
          supportsServiceDiscovery
        }
      }
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query CarrierServiceList {
    carrierServices(first: 10, query: "active:true") {
      edges {
        node {
          id
          name
          callbackUrl
          active
          supportsServiceDiscovery
        }
      }
    }
  }`,
});

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 CarrierServiceList {
    carrierServices(first: 10, query: "active:true") {
      edges {
        node {
          id
          name
          callbackUrl
          active
          supportsServiceDiscovery
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

1{
2  "carrierServices": {
3    "edges": [
4      {
5        "node": {
6          "id": "gid://shopify/DeliveryCarrierService/1036895101",
7          "name": "test name",
8          "callbackUrl": null,
9          "active": true,
10          "supportsServiceDiscovery": false
11        }
12      }
13    ]
14  }
15}