carrierService - admin-graphql - QUERY

Version: 2024-10

Description:

Returns a `DeliveryCarrierService` object by ID.

Access Scopes

Arguments

• id: ID! - The ID of the `DeliveryCarrierService` to return.

Returns

• active: Boolean! Whether the carrier service is active.
• availableServicesForCountries: DeliveryAvailableService! The list of services offered for given destinations.
• callbackUrl: URL The URL endpoint that Shopify needs to retrieve shipping rates.
• formattedName: String The properly formatted name of the shipping service provider, ready to display.
• icon: Image! The logo of the service provider.
• id: ID! A globally-unique ID.
• name: String The name of the shipping service provider.
• supportsServiceDiscovery: Boolean! Whether merchants are able to send dummy data to your service through the Shopify admin to see shipping rate examples.

Examples

• Receive a single CarrierService

          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 CarrierServiceShow($id: ID!) { carrierService(id: $id) { id name callbackUrl active supportsServiceDiscovery } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/DeliveryCarrierService/763770004\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query CarrierServiceShow($id: ID!) {\n      carrierService(id: $id) {\n        id\n        name\n        callbackUrl\n        active\n        supportsServiceDiscovery\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/DeliveryCarrierService/763770004\"\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 CarrierServiceShow($id: ID!) {\n    carrierService(id: $id) {\n      id\n      name\n      callbackUrl\n      active\n      supportsServiceDiscovery\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/DeliveryCarrierService/763770004\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query CarrierServiceShow($id: ID!) {\n    carrierService(id: $id) {\n      id\n      name\n      callbackUrl\n      active\n      supportsServiceDiscovery\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/DeliveryCarrierService/763770004\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query CarrierServiceShow($id: ID!) {\n    carrierService(id: $id) {\n      id\n      name\n      callbackUrl\n      active\n      supportsServiceDiscovery\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/DeliveryCarrierService/763770004\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query CarrierServiceShow($id: ID!) {\n  carrierService(id: $id) {\n    id\n    name\n    callbackUrl\n    active\n    supportsServiceDiscovery\n  }\n}"
        

  input: {
    "id": "gid://shopify/DeliveryCarrierService/763770004"
  }

  response: {
    "data": {
      "carrierService": {
        "id": "gid://shopify/DeliveryCarrierService/763770004",
        "name": "usps",
        "callbackUrl": null,
        "active": true,
        "supportsServiceDiscovery": true
      }
    }
  }