fulfillmentServiceUpdate - admin-graphql - MUTATION

Version: 2024-07

Description:

Updates a fulfillment service. If you are using API version `2023-10` or later, and you need to update the location managed by the fulfillment service (for example, to change the address of a fulfillment service), use the [LocationEdit](https://shopify.dev/api/admin-graphql/latest/mutations/locationEdit) mutation.

Access Scopes

`write_fulfillments` access scope. Also: The user must have fulfill_and_ship_orders permission.

Arguments

• callbackUrl: URL - The URL to send requests for the fulfillment service. The following considerations apply: - Shopify queries the <code>callback_url/fetch_tracking_numbers</code> endpoint to retrieve tracking numbers for orders, if `trackingSupport` is set to `true`. - Shopify queries the <code>callback_url/fetch_stock</code> endpoint to retrieve inventory levels, if `inventoryManagement` is set to `true`. - Shopify uses the <code>callback_url/fulfillment_order_notification</code> endpoint to send [fulfillment and cancellation requests](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#step-2-receive-fulfillment-requests-and-cancellations).
• fulfillmentOrdersOptIn: Boolean - Whether the fulfillment service uses the [fulfillment order based workflow]( https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments ) for managing fulfillments. [As of 2022-07 API version](https://shopify.dev/changelog/legacy-fulfillment-api-deprecation), the fulfillment order based workflow is the only way to manage fulfillments, and `true` is the only valid value for `fulfillmentOrdersOptIn`.
• id: ID! - The id of the fulfillment service.
• inventoryManagement: Boolean - Whether the fulfillment service tracks product inventory and provides updates to Shopify.
• name: String - The name of the fulfillment service.
• permitsSkuSharing: Boolean - Whether the fulfillment service can stock inventory alongside other locations.
• trackingSupport: Boolean - Whether the fulfillment service provides tracking numbers for packages.

Returns

• fulfillmentService: FulfillmentService The updated fulfillment service.
• userErrors: UserError! The list of errors that occurred from executing the mutation.

Examples

• Modify an existing FulfillmentService

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation fulfillmentServiceUpdate($id: ID!, $name: String!) { fulfillmentServiceUpdate(id: $id, name: $name) { fulfillmentService { id serviceName } userErrors { field message } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/FulfillmentService/198258461\",\n    \"name\": \"My Updated Fulfillment Warehouse\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation fulfillmentServiceUpdate($id: ID!, $name: String!) {\n      fulfillmentServiceUpdate(id: $id, name: $name) {\n        fulfillmentService {\n          id\n          serviceName\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/FulfillmentService/198258461\",\n      \"name\": \"My Updated Fulfillment Warehouse\"\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 fulfillmentServiceUpdate($id: ID!, $name: String!) {\n    fulfillmentServiceUpdate(id: $id, name: $name) {\n      fulfillmentService {\n        id\n        serviceName\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/FulfillmentService/198258461\",\n  \"name\": \"My Updated Fulfillment Warehouse\"\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 fulfillmentServiceUpdate($id: ID!, $name: String!) {\n    fulfillmentServiceUpdate(id: $id, name: $name) {\n      fulfillmentService {\n        id\n        serviceName\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/FulfillmentService/198258461\",\n  \"name\" => \"My Updated Fulfillment Warehouse\",\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 fulfillmentServiceUpdate($id: ID!, $name: String!) {\n    fulfillmentServiceUpdate(id: $id, name: $name) {\n      fulfillmentService {\n        id\n        serviceName\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/FulfillmentService/198258461\",\n      \"name\": \"My Updated Fulfillment Warehouse\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation fulfillmentServiceUpdate($id: ID!, $name: String!) {\n  fulfillmentServiceUpdate(id: $id, name: $name) {\n    fulfillmentService {\n      id\n      serviceName\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "id": "gid://shopify/FulfillmentService/198258461",
    "name": "My Updated Fulfillment Warehouse"
  }

  response: {
    "data": {
      "fulfillmentServiceUpdate": {
        "fulfillmentService": {
          "id": "gid://shopify/FulfillmentService/198258461?id=true",
          "serviceName": "My Updated Fulfillment Warehouse"
        },
        "userErrors": []
      }
    }
  }