fulfillmentOrderLineItemsPreparedForPickup - admin-graphql - MUTATION

Version: 2024-01

Description:

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.

Access Scopes

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

Arguments

• input: FulfillmentOrderLineItemsPreparedForPickupInput! - The input for marking fulfillment order line items as ready for pickup.

Returns

• userErrors: FulfillmentOrderLineItemsPreparedForPickupUserError! The list of errors that occurred from executing the mutation.

Examples

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

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation fulfillmentOrderLineItemsPreparedForPickup($input: FulfillmentOrderLineItemsPreparedForPickupInput!) { fulfillmentOrderLineItemsPreparedForPickup(input: $input) { userErrors { field message } } }\",\n \"variables\": {\n    \"input\": {\n      \"lineItemsByFulfillmentOrder\": [\n        {\n          \"fulfillmentOrderId\": \"gid://shopify/FulfillmentOrder/1046000776\"\n        }\n      ]\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation fulfillmentOrderLineItemsPreparedForPickup($input: FulfillmentOrderLineItemsPreparedForPickupInput!) {\n      fulfillmentOrderLineItemsPreparedForPickup(input: $input) {\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"input\": {\n        \"lineItemsByFulfillmentOrder\": [\n          {\n            \"fulfillmentOrderId\": \"gid://shopify/FulfillmentOrder/1046000776\"\n          }\n        ]\n      }\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation fulfillmentOrderLineItemsPreparedForPickup($input: FulfillmentOrderLineItemsPreparedForPickupInput!) {\n    fulfillmentOrderLineItemsPreparedForPickup(input: $input) {\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"input\": {\n    \"lineItemsByFulfillmentOrder\": [{\"fulfillmentOrderId\"=>\"gid://shopify/FulfillmentOrder/1046000776\"}]\n  }\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation fulfillmentOrderLineItemsPreparedForPickup($input: FulfillmentOrderLineItemsPreparedForPickupInput!) {\n    fulfillmentOrderLineItemsPreparedForPickup(input: $input) {\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"input\" => [\n    \"lineItemsByFulfillmentOrder\" => [{\"fulfillmentOrderId\"=>\"gid://shopify/FulfillmentOrder/1046000776\"}],\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation fulfillmentOrderLineItemsPreparedForPickup($input: FulfillmentOrderLineItemsPreparedForPickupInput!) {\n    fulfillmentOrderLineItemsPreparedForPickup(input: $input) {\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"input\": {\n        \"lineItemsByFulfillmentOrder\": [\n          {\n            \"fulfillmentOrderId\": \"gid://shopify/FulfillmentOrder/1046000776\"\n          }\n        ]\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation fulfillmentOrderLineItemsPreparedForPickup($input: FulfillmentOrderLineItemsPreparedForPickupInput!) {\n  fulfillmentOrderLineItemsPreparedForPickup(input: $input) {\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

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

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