Skip to main content
Anchor to FulfillmentServiceUpdatePayload

FulfillmentServiceUpdatePayload

payload

Return type for fulfillmentServiceUpdate mutation.

Anchor to FieldsFields

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?

Anchor to Mutations with this payloadMutations with this payload

Anchor to fulfillmentServiceUpdatefulfillmentServiceUpdate
•mutation

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

The mutation modifies how the fulfillment service handles inventory tracking, shipping requirements, and package tracking support.

Note

To update the physical address or other location details of the fulfillment service, use the locationEdit mutation instead.

Learn more about editing fulfillment service locations.

Arguments

Anchor to idid
•ID!
required

The id of the fulfillment service.

Anchor to namename
•String

The name of the fulfillment service.

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:

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 fulfillmentOrdersOptInfulfillmentOrdersOptIn
•Boolean
Deprecated
Anchor to permitsSkuSharingpermitsSkuSharing
•Boolean
Deprecated
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 requiresShippingMethodrequiresShippingMethod
•Boolean
Default:true

Whether the fulfillment service requires products to be physically shipped.

Was this section helpful?