# carrierServices - admin-graphql - QUERY Version: 2024-10 ## Description Retrieve a list of CarrierServices. ### Access Scopes `read_shipping` access scope. ## Arguments * [after](/docs/api/admin-graphql/2024-10/scalars/String): String - The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * [before](/docs/api/admin-graphql/2024-10/scalars/String): String - The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * [first](/docs/api/admin-graphql/2024-10/scalars/Int): Int - The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * [last](/docs/api/admin-graphql/2024-10/scalars/Int): Int - The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * [query](/docs/api/admin-graphql/2024-10/scalars/String): String - A filter made up of terms, connectives, modifiers, and comparators. | name | type | description | acceptable_values | default_value | example_use | | ---- | ---- | ---- | ---- | ---- | ---- | | active | boolean | | id | id | Filter by `id` range. | | | - `id:1234`
- `id:>=1234`
- `id:<=1234` | You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax). * [reverse](/docs/api/admin-graphql/2024-10/scalars/Boolean): Boolean - Reverse the order of the underlying list. * [sortKey](/docs/api/admin-graphql/2024-10/enums/CarrierServiceSortKeys): CarrierServiceSortKeys - 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](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations). ## Returns * [edges](/docs/api/admin-graphql/2024-10/objects/DeliveryCarrierServiceEdge): DeliveryCarrierServiceEdge! The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. * [nodes](/docs/api/admin-graphql/2024-10/objects/DeliveryCarrierService): DeliveryCarrierService! 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. * [pageInfo](/docs/api/admin-graphql/2024-10/objects/PageInfo): PageInfo! An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. ## Examples ### Retrieve a list of CarrierServices Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query CarrierServiceList { carrierServices(first: 10, query: \\\"active:true\\\") { edges { node { id name callbackUrl active supportsServiceDiscovery } } } }\"\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: `query CarrierServiceList {\n carrierServices(first: 10, query: \"active:true\") {\n edges {\n node {\n id\n name\n callbackUrl\n active\n supportsServiceDiscovery\n }\n }\n }\n }`,\n});\n" Ruby example: "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n query CarrierServiceList {\n carrierServices(first: 10, query: \"active:true\") {\n edges {\n node {\n id\n name\n callbackUrl\n active\n supportsServiceDiscovery\n }\n }\n }\n }\nQUERY\n\nresponse = client.query(query: query)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n query CarrierServiceList {\n carrierServices(first: 10, query: \"active:true\") {\n edges {\n node {\n id\n name\n callbackUrl\n active\n supportsServiceDiscovery\n }\n }\n }\n }`,\n);\n\nconst data = await response.json();\n" Graphql query: "query CarrierServiceList {\n carrierServices(first: 10, query: \"active:true\") {\n edges {\n node {\n id\n name\n callbackUrl\n active\n supportsServiceDiscovery\n }\n }\n }\n}" #### Graphql Input null #### Graphql Response { "data": { "carrierServices": { "edges": [ { "node": { "id": "gid://shopify/DeliveryCarrierService/1036895101", "name": "test name", "callbackUrl": null, "active": true, "supportsServiceDiscovery": false } } ] } } }