Choose a version:

Anchor to fulfillmentOrderLineItemsPreparedForPickup

fulfillmentOrderLineItemsPreparedForPickup

mutation

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

Marks fulfillment order line items as ready for customer pickup. When executed, this mutation automatically sends a "Ready For Pickup" notification to the customer.

Use this mutation for local pickup orders after the items have been prepared and are available for the customer to collect. You can specify one or more fulfillment order objects by providing the fulfillment order IDs in the lineItemsByFulfillmentOrder field. This allows you to mark fulfillment order line items from different fulfillment orders as ready for pickup.

Anchor to Arguments

Arguments

Anchor to inputinput

•FulfillmentOrderLineItemsPreparedForPickupInput!

required

The input for marking fulfillment order line items as ready for pickup.

Was this section helpful?

Anchor to FulfillmentOrderLineItemsPreparedForPickupPayload returnsFulfillmentOrderLineItemsPreparedForPickupPayload returns

Anchor to userErrorsuserErrors •[FulfillmentOrderLineItemsPreparedForPickupUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Mark all line items associated with a fulfillment order as being ready for a customer to pick up

Description

Marks all line items associated with a fulfillment order as being ready to pick up and sends a 'Ready For Pickup' notification to the customer to let them know that their order is ready to be picked up.

Query

mutation fulfillmentOrderLineItemsPreparedForPickup($input: FulfillmentOrderLineItemsPreparedForPickupInput!) {
  fulfillmentOrderLineItemsPreparedForPickup(input: $input) {
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "input": {
    "lineItemsByFulfillmentOrder": [
      {
        "fulfillmentOrderId": "gid://shopify/FulfillmentOrder/1046000776"
      }
    ]
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation fulfillmentOrderLineItemsPreparedForPickup($input: FulfillmentOrderLineItemsPreparedForPickupInput!) { fulfillmentOrderLineItemsPreparedForPickup(input: $input) { userErrors { field message } } }",
 "variables": {
    "input": {
      "lineItemsByFulfillmentOrder": [
        {
          "fulfillmentOrderId": "gid://shopify/FulfillmentOrder/1046000776"
        }
      ]
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation fulfillmentOrderLineItemsPreparedForPickup($input: FulfillmentOrderLineItemsPreparedForPickupInput!) {
    fulfillmentOrderLineItemsPreparedForPickup(input: $input) {
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "input": {
            "lineItemsByFulfillmentOrder": [
                {
                    "fulfillmentOrderId": "gid://shopify/FulfillmentOrder/1046000776"
                }
            ]
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

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 fulfillmentOrderLineItemsPreparedForPickup($input: FulfillmentOrderLineItemsPreparedForPickupInput!) {
    fulfillmentOrderLineItemsPreparedForPickup(input: $input) {
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "input": {
    "lineItemsByFulfillmentOrder": [
      {
        "fulfillmentOrderId": "gid://shopify/FulfillmentOrder/1046000776"
      }
    ]
  }
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation fulfillmentOrderLineItemsPreparedForPickup($input: FulfillmentOrderLineItemsPreparedForPickupInput!) {
      fulfillmentOrderLineItemsPreparedForPickup(input: $input) {
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "input": {
            "lineItemsByFulfillmentOrder": [
                {
                    "fulfillmentOrderId": "gid://shopify/FulfillmentOrder/1046000776"
                }
            ]
        }
    },
  },
});

Response

{
  "fulfillmentOrderLineItemsPreparedForPickup": {
    "userErrors": []
  }
}

fulfillmentOrderLineItemsPreparedForPickup reference

Examples

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

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

const response = await admin.graphql(

`#graphql

mutation fulfillmentOrderLineItemsPreparedForPickup($input: FulfillmentOrderLineItemsPreparedForPickupInput!) {

fulfillmentOrderLineItemsPreparedForPickup(input: $input) {

userErrors {

field

message

}

}`,

{

variables: {

"input": {

"lineItemsByFulfillmentOrder": [

{

"fulfillmentOrderId": "gid://shopify/FulfillmentOrder/1046000776"

}

]

}

);

const json = await response.json();

return json.data;

}

GQL

mutation fulfillmentOrderLineItemsPreparedForPickup($input: FulfillmentOrderLineItemsPreparedForPickupInput!) {
  fulfillmentOrderLineItemsPreparedForPickup(input: $input) {
    userErrors {
      field
      message
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation fulfillmentOrderLineItemsPreparedForPickup($input: FulfillmentOrderLineItemsPreparedForPickupInput!) { fulfillmentOrderLineItemsPreparedForPickup(input: $input) { userErrors { field message } } }",
 "variables": {
    "input": {
      "lineItemsByFulfillmentOrder": [
        {
          "fulfillmentOrderId": "gid://shopify/FulfillmentOrder/1046000776"
        }
      ]
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation fulfillmentOrderLineItemsPreparedForPickup($input: FulfillmentOrderLineItemsPreparedForPickupInput!) {
    fulfillmentOrderLineItemsPreparedForPickup(input: $input) {
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "input": {
            "lineItemsByFulfillmentOrder": [
                {
                    "fulfillmentOrderId": "gid://shopify/FulfillmentOrder/1046000776"
                }
            ]
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation fulfillmentOrderLineItemsPreparedForPickup($input: FulfillmentOrderLineItemsPreparedForPickupInput!) {
      fulfillmentOrderLineItemsPreparedForPickup(input: $input) {
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "input": {
            "lineItemsByFulfillmentOrder": [
                {
                    "fulfillmentOrderId": "gid://shopify/FulfillmentOrder/1046000776"
                }
            ]
        }
    },
  },
});

Ruby

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 fulfillmentOrderLineItemsPreparedForPickup($input: FulfillmentOrderLineItemsPreparedForPickupInput!) {
    fulfillmentOrderLineItemsPreparedForPickup(input: $input) {
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "input": {
    "lineItemsByFulfillmentOrder": [
      {
        "fulfillmentOrderId": "gid://shopify/FulfillmentOrder/1046000776"
      }
    ]
  }
}

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

Input variables

JSON

{

"input": {

"lineItemsByFulfillmentOrder": [

{

"fulfillmentOrderId": "gid://shopify/FulfillmentOrder/1046000776"

}

]

}

Response

JSON

{

"fulfillmentOrderLineItemsPreparedForPickup": {

"userErrors": []

}