fulfillmentOrderRejectFulfillmentRequest - admin-graphql - MUTATION

Version: 2024-10

Description:

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

Access Scopes

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

Arguments

• id: ID! - The ID of the fulfillment order associated with the fulfillment request.
• 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.
• message: String - An optional reason for rejecting the fulfillment request.
• reason: FulfillmentOrderRejectionReason - The reason for the fulfillment order rejection.

Returns

• fulfillmentOrder: FulfillmentOrder The fulfillment order whose fulfillment request was rejected.
• userErrors: UserError! The list of errors that occurred from executing the mutation.

Examples

• Reject a fulfillment request

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/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"
          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"
          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"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = << \"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"
          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"
          Graphql 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}"
        

  input: {
    "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": []
      }
    }
  }