Anchor to section titled 'undefined'

fulfillmentServiceUpdate
mutation

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

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 mutation.

Anchor to section titled 'Arguments'

Arguments

Anchor to callbackUrl
callbackUrl
URL

The URL to send requests for the fulfillment service. The following considerations apply:

  • 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.
Anchor to id
id
ID!
required

The id of the fulfillment service.

Anchor to inventoryManagement
inventoryManagement
Boolean

Whether the fulfillment service tracks product inventory and provides updates to Shopify.

Anchor to name
name
String

The name of the fulfillment service.

Anchor to trackingSupport
trackingSupport
Boolean

Whether the fulfillment service provides tracking numbers for packages.

Was this section helpful?
Anchor to section titled 'FulfillmentServiceUpdatePayload returns'

FulfillmentServiceUpdatePayload returns

Anchor to FulfillmentServiceUpdatePayload.fulfillmentService
fulfillmentService
FulfillmentService

The updated fulfillment service.

Anchor to FulfillmentServiceUpdatePayload.userErrors
userErrors
[UserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Hide code
DescriptionCopy
mutation fulfillmentServiceUpdate($id: ID!, $name: String!) {
  fulfillmentServiceUpdate(id: $id, name: $name) {
    fulfillmentService {
      id
      serviceName
    }
    userErrors {
      field
      message
    }
  }
}
curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-07/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"
  }
}'

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 data = await response.json();

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)

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"
    },
  },
});

use Shopify\Clients\Graphql;

$client = new Graphql("your-development-store.myshopify.com", $accessToken);
$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]);
Hide code
Input variables
Copy
{
  "id": "gid://shopify/FulfillmentService/198258461",
  "name": "My Updated Fulfillment Warehouse"
}
Hide code
Response
JSON
{
  "fulfillmentServiceUpdate": {
    "fulfillmentService": {
      "id": "gid://shopify/FulfillmentService/198258461?id=true",
      "serviceName": "My Updated Fulfillment Warehouse"
    },
    "userErrors": []
  }
}