fulfillmentService - admin-graphql - QUERY

Version: 2024-01

Description:

Returns a FulfillmentService resource by ID.

Access Scopes

Arguments

• id: ID! - The ID of the FulfillmentService to return.

Returns

• 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](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#step-2-receive-fulfillment-requests-and-cancellations), if the fulfillment service has opted in to the fulfillment order based workflow for managing fulfillments (`fulfillmentOrdersOptIn` is set to `true`).
• fulfillmentOrdersOptIn: Boolean! Whether the fulfillment service uses the [fulfillment order based workflow](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments) for managing fulfillments. As the migration is now finished, the `fulfillmentOrdersOptIn` property is [deprecated]( https://shopify.dev/changelog/deprecation-of-the-fulfillmentservice-fulfillmentordersoptin-field) and is always set to `true` on correctly functioning fulfillment services.
• handle: String! Human-readable unique identifier for this fulfillment service.
• id: ID! The ID of the fulfillment service.
• inventoryManagement: Boolean! Whether the fulfillment service tracks product inventory and provides updates to Shopify.
• location: Location Location associated with the fulfillment service.
• permitsSkuSharing: Boolean! Whether the fulfillment service can stock inventory alongside other locations.
• productBased: Boolean! Whether the fulfillment service supports local deliveries.
• serviceName: String! The name of the fulfillment service as seen by merchants.
• shippingMethods: ShippingMethod! Shipping methods associated with the fulfillment service provider. Applies only to Fulfill By Amazon fulfillment service.
• type: FulfillmentServiceType! Type associated with the fulfillment service.

Examples

• Receive a single FulfillmentService

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query FulfillmentServiceShow($id: ID!) { fulfillmentService(id: $id) { id callbackUrl fulfillmentOrdersOptIn permitsSkuSharing handle inventoryManagement serviceName location { legacyResourceId } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/FulfillmentService/18961920\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query FulfillmentServiceShow($id: ID!) {\n      fulfillmentService(id: $id) {\n        id\n        callbackUrl\n        fulfillmentOrdersOptIn\n        permitsSkuSharing\n        handle\n        inventoryManagement\n        serviceName\n        location {\n          legacyResourceId\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/FulfillmentService/18961920\"\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query FulfillmentServiceShow($id: ID!) {\n    fulfillmentService(id: $id) {\n      id\n      callbackUrl\n      fulfillmentOrdersOptIn\n      permitsSkuSharing\n      handle\n      inventoryManagement\n      serviceName\n      location {\n        legacyResourceId\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/FulfillmentService/18961920\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query FulfillmentServiceShow($id: ID!) {\n    fulfillmentService(id: $id) {\n      id\n      callbackUrl\n      fulfillmentOrdersOptIn\n      permitsSkuSharing\n      handle\n      inventoryManagement\n      serviceName\n      location {\n        legacyResourceId\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/FulfillmentService/18961920\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query FulfillmentServiceShow($id: ID!) {\n    fulfillmentService(id: $id) {\n      id\n      callbackUrl\n      fulfillmentOrdersOptIn\n      permitsSkuSharing\n      handle\n      inventoryManagement\n      serviceName\n      location {\n        legacyResourceId\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/FulfillmentService/18961920\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query FulfillmentServiceShow($id: ID!) {\n  fulfillmentService(id: $id) {\n    id\n    callbackUrl\n    fulfillmentOrdersOptIn\n    permitsSkuSharing\n    handle\n    inventoryManagement\n    serviceName\n    location {\n      legacyResourceId\n    }\n  }\n}"
        

  input: {
    "id": "gid://shopify/FulfillmentService/18961920"
  }

  response: {
    "data": {
      "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"
        }
      }
    }
  }