Choose a version:

fulfillmentServiceUpdate

mutation

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

Updates a fulfillment service.

If you need to update the location managed by the fulfillment service (for example, to change the address of a fulfillment service), use the LocationEdit mutation.

Anchor to Arguments

Arguments

Anchor to callbackUrlcallbackUrl •URL: The URL to send requests for the fulfillment service.

If callbackUrl is provided:

Shopify queries the callback_url/fetch_tracking_numbers endpoint to retrieve tracking numbers for orders, if trackingSupport is set to true.

Shopify queries the callback_url/fetch_stock endpoint to retrieve inventory levels, if inventoryManagement is set to true.

Shopify uses the callback_url/fulfillment_order_notification endpoint to send fulfillment and cancellation requests.

Otherwise, if no callbackUrl is provided you need to submit this information via the api:

For submitting tracking info and handling fulfillment requests, see our docs on building for fulfillment services.

For managing inventory quantities, see our docs on managing inventory quantities and states.
Anchor to idid •ID! required: The id of the fulfillment service.
Anchor to inventoryManagementinventoryManagement •Boolean: Whether the fulfillment service manages product inventory and provides updates to Shopify.

If callbackUrl is provided, Shopify will periodically fetch inventory levels via the callback endpoint.

If no callbackUrl is provided you need to submit this information via the api, see our docs on managing inventory quantities and states.
Anchor to namename •String: The name of the fulfillment service.
Anchor to requiresShippingMethodrequiresShippingMethod •Boolean Default:true: Whether the fulfillment service requires products to be physically shipped.
Anchor to trackingSupporttrackingSupport •Boolean: Whether the fulfillment service provides tracking numbers for packages.

If callbackUrl is provided, Shopify will periodically fetch tracking numbers via the callback endpoint.

If no callbackUrl is provided you need to submit this information via the api, see our docs on building for fulfillment services.
Anchor to permitsSkuSharingpermitsSkuSharing •Boolean Deprecated

Was this section helpful?

Anchor to FulfillmentServiceUpdatePayload returnsFulfillmentServiceUpdatePayload returns

Anchor to fulfillmentServicefulfillmentService •FulfillmentService: The updated fulfillment service.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Modify an existing FulfillmentService

Description

A fulfillment service app updates the name of its fulfillment service.

Query

mutation fulfillmentServiceUpdate($id: ID!, $name: String!) { fulfillmentServiceUpdate(id: $id, name: $name) { fulfillmentService { id serviceName } userErrors { field message } } }

Variables

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

cURL

curl -X POST \ https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \ -H 'Content-Type: application/json' \ -H 'X-Shopify-Access-Token: {access_token}' \ -d '{ "query": "mutation fulfillmentServiceUpdate($id: ID!, $name: String!) { fulfillmentServiceUpdate(id: $id, name: $name) { fulfillmentService { id serviceName } userErrors { field message } } }", "variables": { "id": "gid://shopify/FulfillmentService/198258461", "name": "My Updated Fulfillment Warehouse" } }'

React Router

import { authenticate } from "../shopify.server"; export const loader = async ({request}) => { const { admin } = await authenticate.admin(request); const response = await admin.graphql( `#graphql mutation fulfillmentServiceUpdate($id: ID!, $name: String!) { fulfillmentServiceUpdate(id: $id, name: $name) { fulfillmentService { id serviceName } userErrors { field message } } }`, { variables: { "id": "gid://shopify/FulfillmentService/198258461", "name": "My Updated Fulfillment Warehouse" }, }, ); const json = await response.json(); return json.data; }

Ruby

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 mutation fulfillmentServiceUpdate($id: ID!, $name: String!) { fulfillmentServiceUpdate(id: $id, name: $name) { fulfillmentService { id serviceName } userErrors { field message } } } QUERY variables = { "id": "gid://shopify/FulfillmentService/198258461", "name": "My Updated Fulfillment Warehouse" } response = client.query(query: query, variables: variables)

Node.js

const client = new shopify.clients.Graphql({session}); const data = await client.query({ data: { "query": `mutation fulfillmentServiceUpdate($id: ID!, $name: String!) { fulfillmentServiceUpdate(id: $id, name: $name) { fulfillmentService { id serviceName } userErrors { field message } } }`, "variables": { "id": "gid://shopify/FulfillmentService/198258461", "name": "My Updated Fulfillment Warehouse" }, }, });

Response

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

fulfillmentServiceUpdate reference

Examples

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

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

const response = await admin.graphql(

`#graphql

mutation fulfillmentServiceUpdate($id: ID!, $name: String!) {

fulfillmentServiceUpdate(id: $id, name: $name) {

fulfillmentService {

serviceName

}

userErrors {

field

message

}

}`,

{

variables: {

"id": "gid://shopify/FulfillmentService/198258461",

"name": "My Updated Fulfillment Warehouse"

);

const json = await response.json();

return json.data;

}

GQL

mutation fulfillmentServiceUpdate($id: ID!, $name: String!) { fulfillmentServiceUpdate(id: $id, name: $name) { fulfillmentService { id serviceName } userErrors { field message } } }

cURL

curl -X POST \ https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \ -H 'Content-Type: application/json' \ -H 'X-Shopify-Access-Token: {access_token}' \ -d '{ "query": "mutation fulfillmentServiceUpdate($id: ID!, $name: String!) { fulfillmentServiceUpdate(id: $id, name: $name) { fulfillmentService { id serviceName } userErrors { field message } } }", "variables": { "id": "gid://shopify/FulfillmentService/198258461", "name": "My Updated Fulfillment Warehouse" } }'

React Router

import { authenticate } from "../shopify.server"; export const loader = async ({request}) => { const { admin } = await authenticate.admin(request); const response = await admin.graphql( `#graphql mutation fulfillmentServiceUpdate($id: ID!, $name: String!) { fulfillmentServiceUpdate(id: $id, name: $name) { fulfillmentService { id serviceName } userErrors { field message } } }`, { variables: { "id": "gid://shopify/FulfillmentService/198258461", "name": "My Updated Fulfillment Warehouse" }, }, ); const json = await response.json(); return json.data; }

Node.js

const client = new shopify.clients.Graphql({session}); const data = await client.query({ data: { "query": `mutation fulfillmentServiceUpdate($id: ID!, $name: String!) { fulfillmentServiceUpdate(id: $id, name: $name) { fulfillmentService { id serviceName } userErrors { field message } } }`, "variables": { "id": "gid://shopify/FulfillmentService/198258461", "name": "My Updated Fulfillment Warehouse" }, }, });

Ruby

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 mutation fulfillmentServiceUpdate($id: ID!, $name: String!) { fulfillmentServiceUpdate(id: $id, name: $name) { fulfillmentService { id serviceName } userErrors { field message } } } QUERY variables = { "id": "gid://shopify/FulfillmentService/198258461", "name": "My Updated Fulfillment Warehouse" } response = client.query(query: query, variables: variables)

Input variables

JSON

{

"id": "gid://shopify/FulfillmentService/198258461",

"name": "My Updated Fulfillment Warehouse"

}

Response

JSON

{

"fulfillmentServiceUpdate": {

"fulfillmentService": {

"id": "gid://shopify/FulfillmentService/198258461?id=true",

"serviceName": "My Updated Fulfillment Warehouse"

"userErrors": []

}