fulfillmentOrderRejectFulfillmentRequest

mutation

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.

Arguments

Anchor to idid • ID!required: The ID of the fulfillment order associated with the fulfillment request.
Anchor to lineItemslineItems • [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 messagemessage • String: An optional reason for rejecting the fulfillment request.
Anchor to reasonreason • FulfillmentOrderRejectionReason: The reason for the fulfillment order rejection.

Was this section helpful?

Anchor to FulfillmentOrderRejectFulfillmentRequestPayload returnsFulfillmentOrderRejectFulfillmentRequestPayload returns

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

Was this section helpful?

Rejects a fulfillment request
fulfillmentOrderRejectFulfillmentRequest reference

Examples

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

const response = await admin.graphql(

`#graphql

mutation fulfillmentOrderRejectFulfillmentRequest($id: ID!, $message: String) {

fulfillmentOrderRejectFulfillmentRequest(id: $id, message: $message) {

fulfillmentOrder {

status

requestStatus

}

userErrors {

field

message

}

}`,

{

variables: {

"id": "gid://shopify/FulfillmentOrder/1046000786",

"message": "Can't fulfill due to no inventory on product"

);

const data = await response.json();

mutation fulfillmentOrderRejectFulfillmentRequest($id: ID!, $message: String) {
  fulfillmentOrderRejectFulfillmentRequest(id: $id, message: $message) {
    fulfillmentOrder {
      id
      status
      requestStatus
    }
    userErrors {
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation fulfillmentOrderRejectFulfillmentRequest($id: ID!, $message: String) { fulfillmentOrderRejectFulfillmentRequest(id: $id, message: $message) { fulfillmentOrder { id status requestStatus } userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/FulfillmentOrder/1046000786",
    "message": "Can'\''t fulfill due to no inventory on product"
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation fulfillmentOrderRejectFulfillmentRequest($id: ID!, $message: String) {
    fulfillmentOrderRejectFulfillmentRequest(id: $id, message: $message) {
      fulfillmentOrder {
        id
        status
        requestStatus
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/FulfillmentOrder/1046000786",
      "message": "Can't fulfill due to no inventory on product"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation fulfillmentOrderRejectFulfillmentRequest($id: ID!, $message: String) {
      fulfillmentOrderRejectFulfillmentRequest(id: $id, message: $message) {
        fulfillmentOrder {
          id
          status
          requestStatus
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/FulfillmentOrder/1046000786",
      "message": "Can't fulfill due to no inventory on product"
    },
  },
});

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
  mutation fulfillmentOrderRejectFulfillmentRequest($id: ID!, $message: String) {
    fulfillmentOrderRejectFulfillmentRequest(id: $id, message: $message) {
      fulfillmentOrder {
        id
        status
        requestStatus
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/FulfillmentOrder/1046000786",
  "message": "Can't fulfill due to no inventory on product"
}

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

Input variables

JSON

{

"id": "gid://shopify/FulfillmentOrder/1046000786",

"message": "Can't fulfill due to no inventory on product"

}

Response

JSON

{

"fulfillmentOrderRejectFulfillmentRequest": {

"fulfillmentOrder": {

"id": "gid://shopify/FulfillmentOrder/1046000786",

"status": "OPEN",

"requestStatus": "REJECTED"

"userErrors": []

}