Choose a version:

fulfillmentService

query

Returns a FulfillmentService resource by ID.

Arguments

Anchor to idid • ID!required: The ID of the FulfillmentService to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

FulfillmentService

•

FulfillmentService

A Fulfillment Service is a third party warehouse that prepares and ships orders on behalf of the store owner. Fulfillment services charge a fee to package and ship items and update product inventory levels. Some well known fulfillment services with Shopify integrations include: Amazon, Shipwire, and Rakuten. When an app registers a new FulfillmentService on a store, Shopify automatically creates a Location that's associated to the fulfillment service. To learn more about fulfillment services, refer to Manage fulfillments as a fulfillment service app guide.

Mutations

You can work with the FulfillmentService object with the fulfillmentServiceCreate, fulfillmentServiceUpdate, and fulfillmentServiceDelete mutations.

Hosted endpoints

Fulfillment service providers integrate with Shopify by providing Shopify with a set of hosted endpoints that Shopify can query on certain conditions. These endpoints must have a common prefix, and this prefix should be supplied in the callbackUrl parameter in the fulfillmentServiceCreate mutation.

Shopify sends POST requests to the <callbackUrl>/fulfillment_order_notification endpoint to notify the fulfillment service about fulfillment requests and fulfillment cancellation requests.

For more information, refer to Receive fulfillment requests and cancellations.

Shopify sends GET requests to the <callbackUrl>/fetch_tracking_numbers endpoint to retrieve tracking numbers for orders if trackingSupport is set to true.

For more information, refer to Enable tracking support.

Fulfillment services can also update tracking information using the fulfillmentTrackingInfoUpdate mutation, rather than waiting for Shopify to ask for tracking numbers.

Shopify sends GET requests to the <callbackUrl>/fetch_stock endpoint to retrieve on hand inventory levels for the fulfillment service location if inventoryManagement is set to true.

For more information, refer to Sharing inventory levels with Shopify.

To make sure you have everything set up correctly, you can test the callbackUrl-prefixed endpoints in your development store.

Resources and webhooks

There are a variety of objects and webhooks that enable a fulfillment service to work. To exchange fulfillment information with Shopify, fulfillment services use the FulfillmentOrder, Fulfillment and Order objects and related mutations. To act on fulfillment process events that happen on the Shopify side, besides awaiting calls to callbackUrl-prefixed endpoints, fulfillment services can subscribe to the fulfillment order and order webhooks.

callbackUrl• URL: The callback URL that the fulfillment service has registered for requests. The following considerations apply:

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

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

Shopify uses the <callbackUrl>/fulfillment_order_notification endpoint to send fulfillment and cancellation requests.
handle• String! non-null: Human-readable unique identifier for this fulfillment service.
id• ID! non-null: The ID of the fulfillment service.
inventoryManagement• Boolean! non-null: Whether the fulfillment service tracks product inventory and provides updates to Shopify.
location• Location: Location associated with the fulfillment service.
permitsSkuSharing• Boolean! non-null: Whether the fulfillment service can stock inventory alongside other locations.
serviceName• String! non-null: The name of the fulfillment service as seen by merchants.
trackingSupport• Boolean! non-null: Whether the fulfillment service implemented the /fetch_tracking_numbers endpoint.
type• FulfillmentServiceType! non-null: Type associated with the fulfillment service.
fulfillmentOrdersOptIn• Boolean! non-nullDeprecated: Whether the fulfillment service uses the fulfillment order based workflow for managing fulfillments.

As the migration is now finished, the fulfillmentOrdersOptIn property is deprecated and is always set to true on correctly functioning fulfillment services. Migration period ended. All correctly functioning fulfillment services have fulfillmentOrdersOptIn set to true.

Was this section helpful?

Receive a single FulfillmentService

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

query FulfillmentServiceShow($id: ID!) {

fulfillmentService(id: $id) {

callbackUrl

fulfillmentOrdersOptIn

permitsSkuSharing

handle

inventoryManagement

serviceName

location {

legacyResourceId

}

}`,

{

variables: {

"id": "gid://shopify/FulfillmentService/18961920"

);

const data = await response.json();

query FulfillmentServiceShow($id: ID!) {
  fulfillmentService(id: $id) {
    id
    callbackUrl
    fulfillmentOrdersOptIn
    permitsSkuSharing
    handle
    inventoryManagement
    serviceName
    location {
      legacyResourceId
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query FulfillmentServiceShow($id: ID!) { fulfillmentService(id: $id) { id callbackUrl fulfillmentOrdersOptIn permitsSkuSharing handle inventoryManagement serviceName location { legacyResourceId } } }",
 "variables": {
    "id": "gid://shopify/FulfillmentService/18961920"
  }
}'

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

const response = await admin.graphql(
  `#graphql
  query FulfillmentServiceShow($id: ID!) {
    fulfillmentService(id: $id) {
      id
      callbackUrl
      fulfillmentOrdersOptIn
      permitsSkuSharing
      handle
      inventoryManagement
      serviceName
      location {
        legacyResourceId
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/FulfillmentService/18961920"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query FulfillmentServiceShow($id: ID!) {
      fulfillmentService(id: $id) {
        id
        callbackUrl
        fulfillmentOrdersOptIn
        permitsSkuSharing
        handle
        inventoryManagement
        serviceName
        location {
          legacyResourceId
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/FulfillmentService/18961920"
    },
  },
});

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
  query FulfillmentServiceShow($id: ID!) {
    fulfillmentService(id: $id) {
      id
      callbackUrl
      fulfillmentOrdersOptIn
      permitsSkuSharing
      handle
      inventoryManagement
      serviceName
      location {
        legacyResourceId
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/FulfillmentService/18961920"
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"id": "gid://shopify/FulfillmentService/18961920"

}

Response

JSON

{

"fulfillmentService": {

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

"callbackUrl": "http://shipwire.com",

"fulfillmentOrdersOptIn": true,

"permitsSkuSharing": true,

"handle": "shipwire",

"inventoryManagement": false,

"serviceName": "Shipwire",

"location": {

"legacyResourceId": "215093630"

}