fulfillmentServiceUpdate

Updates the FulfillmentService configuration, including its name, callback URL, and operational settings.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the fulfillmentServiceUpdate action (under Fulfillment).
Fill in the fields below, then reference the result from later steps as {{fulfillmentserviceupdate.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

mutation FulfillmentServiceUpdate($id: ID!, $name: String, $callbackUrl: URL, $trackingSupport: Boolean, $fulfillmentOrdersOptIn: Boolean, $inventoryManagement: Boolean, $requiresShippingMethod: Boolean) {
  fulfillmentServiceUpdate(
    id: $id
    name: $name
    callbackUrl: $callbackUrl
    trackingSupport: $trackingSupport
    fulfillmentOrdersOptIn: $fulfillmentOrdersOptIn
    inventoryManagement: $inventoryManagement
    requiresShippingMethod: $requiresShippingMethod
  ) {
    fulfillmentService {
      callbackUrl
      fulfillmentOrdersOptIn
      handle
      id
      inventoryManagement
      location {
        activatable
        address
        addressVerified
        createdAt
        deactivatable
        deactivatedAt
        deletable
        fulfillmentService
        fulfillsOnlineOrders
        hasActiveInventory
        hasUnfulfilledOrders
        id
        isActive
        isFulfillmentService
        isPrimary
        legacyResourceId
        localPickupSettingsV2
        name
        shipsInventory
        suggestedAddresses
        updatedAt
      }
      requiresShippingMethod
      serviceName
      trackingSupport
      type
    }
    userErrors {
      field
      message
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

idstringrequired

The id of the fulfillment service.

namestring

The name of the fulfillment service.

callbackUrlstring

The URL to send requests for the fulfillment service. If `callbackUrl` is provided: - 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). 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](https://shopify.dev/apps/build/orders-fulfillment/fulfillment-service-apps/build-for-fulfillment-services). - For managing inventory quantities, see our docs on [managing inventory quantities and states](https://shopify.dev/apps/build/orders-fulfillment/inventory-management-apps/manage-quantities-states).

trackingSupportboolean

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](https://shopify.dev/apps/build/orders-fulfillment/fulfillment-service-apps/build-for-fulfillment-services).

fulfillmentOrdersOptInboolean

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

inventoryManagementboolean

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](https://shopify.dev/apps/build/orders-fulfillment/inventory-management-apps/manage-quantities-states).

requiresShippingMethodboolean

Whether the fulfillment service requires products to be physically shipped.

json

{
  "id": "string",
  "name": "string",
  "callbackUrl": "string",
  "trackingSupport": false,
  "fulfillmentOrdersOptIn": false,
  "inventoryManagement": false,
  "requiresShippingMethod": false
}

Response

Read the result with {{fulfillmentserviceupdate.response.data.data.fulfillmentServiceUpdate}}. If the API returns errors, the step fails and they are at {{fulfillmentserviceupdate.response.data.errors}}.

fulfillmentServiceobject

callbackUrlstring

fulfillmentOrdersOptInboolean

handlestring

idstring

inventoryManagementboolean

locationobject21 fields

requiresShippingMethodboolean

serviceNamestring

trackingSupportboolean

typestring

One ofGIFT_CARDMANUALTHIRD_PARTY

userErrorsarray<object>

fieldobject

messageobject

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?