Choose a version:

fulfillmentOrderLineItemsPreparedForPickup

mutation

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

Mark line items associated with a fulfillment order as being ready for pickup by a customer.

Sends a Ready For Pickup notification to the customer to let them know that their order is ready to be picked up.

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?

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

Examples

Open in GraphiQL

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 data = await response.json();

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

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/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"
        }
      ]
    }
  }
}'

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 data = await response.json();

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"
          }
        ]
      }
    },
  },
});

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

}