Anchor to section titled 'undefined'fulfillment
fulfillment
mutation
2024-07
Requires write 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.
Anchor to section titled 'Arguments'
Arguments
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?
Code examples for MUTATION: fulfillmentOrderLineItemsPreparedForPickup
Query Reference for MUTATION: fulfillmentOrderLineItemsPreparedForPickup
"mutation fulfillmentOrderLineItemsPreparedForPickup($input: FulfillmentOrderLineItemsPreparedForPickupInput!) {\n fulfillmentOrderLineItemsPreparedForPickup(input: $input) {\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: fulfillmentOrderLineItemsPreparedForPickup
"{\n \"input\": {\n \"lineItemsByFulfillmentOrder\": [\n {\n \"fulfillmentOrderId\": \"gid://shopify/<objectName>/10079785100\"\n }\n ]\n }\n}"Schema Reference for MUTATION: fulfillmentOrderLineItemsPreparedForPickup
"input FulfillmentOrderLineItemsPreparedForPickupInput {\n lineItemsByFulfillmentOrder: [PreparedFulfillmentOrderLineItemsInput!]!\n}\n\ninput PreparedFulfillmentOrderLineItemsInput {\n fulfillmentOrderId: ID!\n}\n"Display Examples for MUTATION: fulfillmentOrderLineItemsPreparedForPickup
[
{
"example": {
"type_name": "fulfillmentorderlineitemspreparedforpickup",
"title": "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_string": "mutation fulfillmentOrderLineItemsPreparedForPickup($input: FulfillmentOrderLineItemsPreparedForPickupInput!) {\n fulfillmentOrderLineItemsPreparedForPickup(input: $input) {\n userErrors {\n field\n message\n }\n }\n}",
"variables": {
"input": {
"lineItemsByFulfillmentOrder": [
{
"fulfillmentOrderId": "gid://shopify/FulfillmentOrder/1046000776"
}
]
}
},
"response": {
"data": {
"fulfillmentOrderLineItemsPreparedForPickup": {
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/fulfillments/test/unit/graph_api/admin/mutations/fulfillment_order_line_items_prepared_for_pickup_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/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",
"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",
"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",
"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",
"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"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "input",
"description": "The input for marking fulfillment order line items as ready for pickup.",
"type": {
"kind": "INPUT_OBJECT",
"name": "FulfillmentOrderLineItemsPreparedForPickupInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "FulfillmentOrderLineItemsPreparedForPickupInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "input",
"argValue": " {\"lineItemsByFulfillmentOrder\":[{\"fulfillmentOrderId\":\"gid://shopify/FulfillmentOrder/1046000776\"}]}",
"typeKind": "MUTATION"
}
]
}
]