fulfillmentOrderClose

mutation

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

Marks an in-progress fulfillment order as incomplete, indicating the fulfillment service is unable to ship any remaining items, and closes the fulfillment request.

This mutation can only be called for fulfillment orders that meet the following criteria:

Assigned to a fulfillment service location,
The fulfillment request has been accepted,
The fulfillment order status is IN_PROGRESS.

This mutation can only be called by the fulfillment service app that accepted the fulfillment request. Calling this mutation returns the control of the fulfillment order to the merchant, allowing them to move the fulfillment order line items to another location and fulfill from there, remove and refund the line items, or to request fulfillment from the same fulfillment service again.

Closing a fulfillment order is explained in the fulfillment service guide.

Arguments

Anchor to idid • ID!required: The ID of the fulfillment order to mark as incomplete.
Anchor to messagemessage • String: An optional reason for marking the fulfillment order as incomplete.

Was this section helpful?

Anchor to FulfillmentOrderClosePayload returnsFulfillmentOrderClosePayload returns

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

Was this section helpful?

Marks a fulfillment order as incomplete
fulfillmentOrderClose reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation fulfillmentOrderClose($id: ID!, $message: String) {
6    fulfillmentOrderClose(id: $id, message: $message) {
7      fulfillmentOrder {
8        id
9        status
10        requestStatus
11      }
12      userErrors {
13        field
14        message
15      }
16    }
17  }`,
18  {
19    variables: {
20      "id": "gid://shopify/FulfillmentOrder/1046000779",
21      "message": "Out of Stock"
22    },
23  },
24);
25
26const data = await response.json();
27

mutation fulfillmentOrderClose($id: ID!, $message: String) {
  fulfillmentOrderClose(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 fulfillmentOrderClose($id: ID!, $message: String) { fulfillmentOrderClose(id: $id, message: $message) { fulfillmentOrder { id status requestStatus } userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/FulfillmentOrder/1046000779",
    "message": "Out of Stock"
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation fulfillmentOrderClose($id: ID!, $message: String) {
    fulfillmentOrderClose(id: $id, message: $message) {
      fulfillmentOrder {
        id
        status
        requestStatus
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/FulfillmentOrder/1046000779",
      "message": "Out of Stock"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation fulfillmentOrderClose($id: ID!, $message: String) {
      fulfillmentOrderClose(id: $id, message: $message) {
        fulfillmentOrder {
          id
          status
          requestStatus
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/FulfillmentOrder/1046000779",
      "message": "Out of Stock"
    },
  },
});

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

variables = {
  "id": "gid://shopify/FulfillmentOrder/1046000779",
  "message": "Out of Stock"
}

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

Input variables

JSON

1{
2  "id": "gid://shopify/FulfillmentOrder/1046000779",
3  "message": "Out of Stock"
4}

Response

JSON

1{
2  "fulfillmentOrderClose": {
3    "fulfillmentOrder": {
4      "id": "gid://shopify/FulfillmentOrder/1046000779",
5      "status": "INCOMPLETE",
6      "requestStatus": "CLOSED"
7    },
8    "userErrors": []
9  }
10}