Anchor to section titled 'undefined'

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.


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


Was this section helpful?
Anchor to section titled 'FulfillmentOrderLineItemsPreparedForPickupPayload returns'

FulfillmentOrderLineItemsPreparedForPickupPayload returns


The list of errors that occurred from executing the mutation.


Was this section helpful?

Examples

Hide code
DescriptionCopy
mutation fulfillmentOrderLineItemsPreparedForPickup($input: FulfillmentOrderLineItemsPreparedForPickupInput!) {
  fulfillmentOrderLineItemsPreparedForPickup(input: $input) {
    userErrors {
      field
      message
    }
  }
}
curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-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();
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)
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"
          }
        ]
      }
    },
  },
});
use Shopify\Clients\Graphql;

$client = new Graphql("your-development-store.myshopify.com", $accessToken);
$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]);
Hide code
Input variables
Copy
{
  "input": {
    "lineItemsByFulfillmentOrder": [
      {
        "fulfillmentOrderId": "gid://shopify/FulfillmentOrder/1046000776"
      }
    ]
  }
}
Hide code
Response
JSON
{
  "fulfillmentOrderLineItemsPreparedForPickup": {
    "userErrors": []
  }
}