fulfillmentOrderRejectFulfillmentRequest
mutation

Choose a version:

Requires write_assigned_fulfillment_orders access scope. Also: The user must have fulfill_and_ship_orders permission.

Rejects a fulfillment request sent to a fulfillment service for a fulfillment order.

Anchor to section titled 'Arguments'

Arguments

Anchor to id id ID! required: The ID of the fulfillment order associated with the fulfillment request.
Anchor to lineItems lineItems [IncomingRequestLineItemInput!]: An optional array of line item rejection details. If none are provided, all line items will be assumed to be unfulfillable.

Note: After the fulfillment request has been rejected, none of the line items will be able to be fulfilled. This field documents which line items specifically were unable to be fulfilled and why.
Anchor to message message String: An optional reason for rejecting the fulfillment request.
Anchor to reason reason FulfillmentOrderRejectionReason: The reason for the fulfillment order rejection.

Was this section helpful?

Anchor to section titled 'FulfillmentOrderRejectFulfillmentRequestPayload returns'

FulfillmentOrderRejectFulfillmentRequestPayload returns

Anchor to FulfillmentOrderRejectFulfillmentRequestPayload.fulfillmentOrder fulfillmentOrder FulfillmentOrder: The fulfillment order whose fulfillment request was rejected.
Anchor to FulfillmentOrderRejectFulfillmentRequestPayload.userErrors userErrors [UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: fulfillmentOrderRejectFulfillmentRequest

Query Reference for MUTATION: fulfillmentOrderRejectFulfillmentRequest

"mutation fulfillmentOrderRejectFulfillmentRequest($id: ID!) {\n  fulfillmentOrderRejectFulfillmentRequest(id: $id) {\n    fulfillmentOrder {\n      # FulfillmentOrder fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: fulfillmentOrderRejectFulfillmentRequest

"{\n  \"id\": \"gid://shopify/<objectName>/10079785100\",\n  \"lineItems\": [\n    {\n      \"fulfillmentOrderLineItemId\": \"gid://shopify/<objectName>/10079785100\",\n      \"message\": \"<your-message>\"\n    }\n  ],\n  \"message\": \"<your-message>\",\n  \"reason\": \"INCORRECT_ADDRESS\"\n}"

Schema Reference for MUTATION: fulfillmentOrderRejectFulfillmentRequest

"input IncomingRequestLineItemInput {\n  fulfillmentOrderLineItemId: ID!\n  message: String\n}\n"

Display Examples for MUTATION: fulfillmentOrderRejectFulfillmentRequest

[
  {
    "example": {
      "type_name": "fulfillmentorderrejectfulfillmentrequest",
      "title": "Reject a fulfillment request",
      "description": "A fulfillment service rejects a fulfillment request for a fulfillment order.",
      "query_string": "mutation fulfillmentOrderRejectFulfillmentRequest($id: ID!, $message: String) {\n  fulfillmentOrderRejectFulfillmentRequest(id: $id, message: $message) {\n    fulfillmentOrder {\n      id\n      status\n      requestStatus\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}",
      "variables": {
        "id": "gid://shopify/FulfillmentOrder/1046000792",
        "message": "Can't fulfill due to no inventory on product"
      },
      "response": {
        "data": {
          "fulfillmentOrderRejectFulfillmentRequest": {
            "fulfillmentOrder": {
              "id": "gid://shopify/FulfillmentOrder/1046000792",
              "status": "OPEN",
              "requestStatus": "REJECTED"
            },
            "userErrors": []
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/fulfillments/test/unit/graph_api/admin/mutations/fulfillment_order_reject_fulfillment_request_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation fulfillmentOrderRejectFulfillmentRequest($id: ID!, $message: String) { fulfillmentOrderRejectFulfillmentRequest(id: $id, message: $message) { fulfillmentOrder { id status requestStatus } userErrors { field message } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/FulfillmentOrder/1046000792\",\n    \"message\": \"Can'\\''t fulfill due to no inventory on product\"\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation fulfillmentOrderRejectFulfillmentRequest($id: ID!, $message: String) {\n    fulfillmentOrderRejectFulfillmentRequest(id: $id, message: $message) {\n      fulfillmentOrder {\n        id\n        status\n        requestStatus\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/FulfillmentOrder/1046000792\",\n      \"message\": \"Can't fulfill due to no inventory on product\"\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 fulfillmentOrderRejectFulfillmentRequest($id: ID!, $message: String) {\n    fulfillmentOrderRejectFulfillmentRequest(id: $id, message: $message) {\n      fulfillmentOrder {\n        id\n        status\n        requestStatus\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/FulfillmentOrder/1046000792\",\n  \"message\": \"Can't fulfill due to no inventory on product\"\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 fulfillmentOrderRejectFulfillmentRequest($id: ID!, $message: String) {\n      fulfillmentOrderRejectFulfillmentRequest(id: $id, message: $message) {\n        fulfillmentOrder {\n          id\n          status\n          requestStatus\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/FulfillmentOrder/1046000792\",\n      \"message\": \"Can't fulfill due to no inventory on product\"\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 fulfillmentOrderRejectFulfillmentRequest($id: ID!, $message: String) {\n    fulfillmentOrderRejectFulfillmentRequest(id: $id, message: $message) {\n      fulfillmentOrder {\n        id\n        status\n        requestStatus\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/FulfillmentOrder/1046000792\",\n  \"message\" => \"Can't fulfill due to no inventory on product\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "id",
          "description": "The ID of the fulfillment order associated with the fulfillment request.",
          "type": {
            "kind": "SCALAR",
            "name": "ID",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "ID!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "id",
        "argValue": " \"gid://shopify/FulfillmentOrder/1046000792\"",
        "typeKind": "MUTATION"
      },
      {
        "arg": {
          "name": "message",
          "description": "An optional reason for rejecting the fulfillment request.",
          "type": {
            "kind": "SCALAR",
            "name": "String",
            "list": false,
            "non_null": false
          },
          "defaultValue": null,
          "typeSignature": "String",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "message",
        "argValue": " \"Can't fulfill due to no inventory on product\"",
        "typeKind": "MUTATION"
      }
    ]
  }
]

fulfillmentOrderRejectFulfillmentRequestmutation

Arguments

FulfillmentOrderRejectFulfillmentRequestPayload returns

fulfillmentOrderRejectFulfillmentRequest
mutation