carrierServiceUpdate - admin-graphql - MUTATION

Version: 2025-01

Description:

Updates a carrier service. Only the app that creates a carrier service can update it.

Access Scopes

`write_shipping` access scope.

Arguments

• input: DeliveryCarrierServiceUpdateInput! - The input fields used to update a carrier service.

Returns

• carrierService: DeliveryCarrierService The updated carrier service.
• userErrors: CarrierServiceUpdateUserError! The list of errors that occurred from executing the mutation.

Examples

• Modify an existing CarrierService

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation CarrierServiceUpdate($input: DeliveryCarrierServiceUpdateInput!) { carrierServiceUpdate(input: $input) { carrierService { id name callbackUrl active } userErrors { field message } } }\",\n \"variables\": {\n    \"input\": {\n      \"id\": \"gid://shopify/DeliveryCarrierService/1036895102\",\n      \"name\": \"new test carrier service\",\n      \"callbackUrl\": \"https://new.example.com/\",\n      \"active\": true\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation CarrierServiceUpdate($input: DeliveryCarrierServiceUpdateInput!) {\n      carrierServiceUpdate(input: $input) {\n        carrierService {\n          id\n          name\n          callbackUrl\n          active\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"input\": {\n        \"id\": \"gid://shopify/DeliveryCarrierService/1036895102\",\n        \"name\": \"new test carrier service\",\n        \"callbackUrl\": \"https://new.example.com/\",\n        \"active\": true\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  mutation CarrierServiceUpdate($input: DeliveryCarrierServiceUpdateInput!) {\n    carrierServiceUpdate(input: $input) {\n      carrierService {\n        id\n        name\n        callbackUrl\n        active\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"input\": {\n    \"id\": \"gid://shopify/DeliveryCarrierService/1036895102\",\n    \"name\": \"new test carrier service\",\n    \"callbackUrl\": \"https://new.example.com/\",\n    \"active\": true\n  }\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  mutation CarrierServiceUpdate($input: DeliveryCarrierServiceUpdateInput!) {\n    carrierServiceUpdate(input: $input) {\n      carrierService {\n        id\n        name\n        callbackUrl\n        active\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"input\" => [\n    \"id\" => \"gid://shopify/DeliveryCarrierService/1036895102\",\n    \"name\" => \"new test carrier service\",\n    \"callbackUrl\" => \"https://new.example.com/\",\n    \"active\" => true,\n  ],\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  mutation CarrierServiceUpdate($input: DeliveryCarrierServiceUpdateInput!) {\n    carrierServiceUpdate(input: $input) {\n      carrierService {\n        id\n        name\n        callbackUrl\n        active\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"input\": {\n        \"id\": \"gid://shopify/DeliveryCarrierService/1036895102\",\n        \"name\": \"new test carrier service\",\n        \"callbackUrl\": \"https://new.example.com/\",\n        \"active\": true\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation CarrierServiceUpdate($input: DeliveryCarrierServiceUpdateInput!) {\n  carrierServiceUpdate(input: $input) {\n    carrierService {\n      id\n      name\n      callbackUrl\n      active\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "input": {
      "id": "gid://shopify/DeliveryCarrierService/1036895102",
      "name": "new test carrier service",
      "callbackUrl": "https://new.example.com/",
      "active": true
    }
  }

  response: {
    "data": {
      "carrierServiceUpdate": {
        "carrierService": {
          "id": "gid://shopify/DeliveryCarrierService/1036895102",
          "name": "new test carrier service",
          "callbackUrl": "https://new.example.com/",
          "active": true
        },
        "userErrors": []
      }
    }
  }