fulfillmentServiceCreate

mutation

Code examples for MUTATION: fulfillmentServiceCreate

Query Reference for MUTATION: fulfillmentServiceCreate

"mutation fulfillmentServiceCreate($callbackUrl: URL!, $name: String!) {\n  fulfillmentServiceCreate(callbackUrl: $callbackUrl, name: $name) {\n    fulfillmentService {\n      # FulfillmentService fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: fulfillmentServiceCreate

"{\n  \"callbackUrl\": \"https://example.myshopify.com\",\n  \"fulfillmentOrdersOptIn\": true,\n  \"inventoryManagement\": true,\n  \"name\": \"<your-name>\",\n  \"permitsSkuSharing\": true,\n  \"trackingSupport\": true\n}"

Schema Reference for MUTATION: fulfillmentServiceCreate

""

Display Examples for MUTATION: fulfillmentServiceCreate

[
  {
    "example": {
      "type_name": "fulfillmentservicecreate",
      "title": "Create a fulfillment service",
      "description": "A third party app creates a fulfillment service that uses the fulfillment order based workflow.",
      "query_string": "mutation fulfillmentServiceCreate($name: String!, $callbackUrl: URL!) {\n  fulfillmentServiceCreate(name: $name, callbackUrl: $callbackUrl) {\n    fulfillmentService {\n      id\n      serviceName\n      callbackUrl\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}",
      "variables": {
        "name": "example_fulfillment_service",
        "callbackUrl": "https://callback.org/"
      },
      "response": {
        "data": {
          "fulfillmentServiceCreate": {
            "fulfillmentService": {
              "id": "gid://shopify/FulfillmentService/1061774487?id=true",
              "serviceName": "example_fulfillment_service",
              "callbackUrl": "https://callback.org/"
            },
            "userErrors": []
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2024-04",
      "maximum_api_version": "unstable",
      "location": "/components/fulfillments/test/unit/graph_api/admin/mutations/fulfillment_service_create_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation fulfillmentServiceCreate($name: String!, $callbackUrl: URL!) { fulfillmentServiceCreate(name: $name, callbackUrl: $callbackUrl) { fulfillmentService { id serviceName callbackUrl } userErrors { field message } } }\",\n \"variables\": {\n    \"name\": \"example_fulfillment_service\",\n    \"callbackUrl\": \"https://callback.org/\"\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation fulfillmentServiceCreate($name: String!, $callbackUrl: URL!) {\n    fulfillmentServiceCreate(name: $name, callbackUrl: $callbackUrl) {\n      fulfillmentService {\n        id\n        serviceName\n        callbackUrl\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"name\": \"example_fulfillment_service\",\n      \"callbackUrl\": \"https://callback.org/\"\n    },\n  },\n);\n\nconst data = await response.json();\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  mutation fulfillmentServiceCreate($name: String!, $callbackUrl: URL!) {\n    fulfillmentServiceCreate(name: $name, callbackUrl: $callbackUrl) {\n      fulfillmentService {\n        id\n        serviceName\n        callbackUrl\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"name\": \"example_fulfillment_service\",\n  \"callbackUrl\": \"https://callback.org/\"\n}\n\nresponse = client.query(query: query, variables: variables)\n",
      "node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation fulfillmentServiceCreate($name: String!, $callbackUrl: URL!) {\n      fulfillmentServiceCreate(name: $name, callbackUrl: $callbackUrl) {\n        fulfillmentService {\n          id\n          serviceName\n          callbackUrl\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"name\": \"example_fulfillment_service\",\n      \"callbackUrl\": \"https://callback.org/\"\n    },\n  },\n});\n",
      "php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation fulfillmentServiceCreate($name: String!, $callbackUrl: URL!) {\n    fulfillmentServiceCreate(name: $name, callbackUrl: $callbackUrl) {\n      fulfillmentService {\n        id\n        serviceName\n        callbackUrl\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"name\" => \"example_fulfillment_service\",\n  \"callbackUrl\" => \"https://callback.org/\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "name",
          "description": "The name of the fulfillment service.",
          "type": {
            "kind": "SCALAR",
            "name": "String",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "String!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "name",
        "argValue": " \"example_fulfillment_service\"",
        "typeKind": "MUTATION"
      },
      {
        "arg": {
          "name": "callbackUrl",
          "description": "The URL to send requests for the fulfillment service. The following considerations apply:\n\n- Shopify queries the <code>callback_url/fetch_tracking_numbers</code> endpoint to retrieve tracking numbers\n    for orders, if `trackingSupport` is set to `true`.\n- Shopify queries the <code>callback_url/fetch_stock</code> endpoint to retrieve inventory levels,\n    if `inventoryManagement` is set to `true`.\n- Shopify uses the <code>callback_url/fulfillment_order_notification</code> endpoint to send\n    [fulfillment and cancellation requests](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#step-2-receive-fulfillment-requests-and-cancellations).",
          "type": {
            "kind": "SCALAR",
            "name": "URL",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "URL!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "callbackUrl",
        "argValue": " \"https://callback.org/\"",
        "typeKind": "MUTATION"
      }
    ]
  }
]