fulfillment Orders Set Fulfillment Deadlinemutation
Requires write
access scope, write
access scope or write
access scope. Also: The user must have fulfill_and_ship_orders permission.
Sets the latest date and time by which the fulfillment orders need to be fulfilled.
Arguments
The new fulfillment deadline of the fulfillment orders.
The IDs of the fulfillment orders for which the deadline is being set.
FulfillmentOrdersSetFulfillmentDeadlinePayload returns
Whether the fulfillment deadline was successfully set.
The list of errors that occurred from executing the mutation.
Code examples for MUTATION: fulfillmentOrdersSetFulfillmentDeadline
Query Reference for MUTATION: fulfillmentOrdersSetFulfillmentDeadline
"mutation fulfillmentOrdersSetFulfillmentDeadline($fulfillmentDeadline: DateTime!, $fulfillmentOrderIds: [ID!]!) {\n fulfillmentOrdersSetFulfillmentDeadline(fulfillmentDeadline: $fulfillmentDeadline, fulfillmentOrderIds: $fulfillmentOrderIds) {\n success\n userErrors {\n field\n message\n }\n }\n}"
Input Reference for MUTATION: fulfillmentOrdersSetFulfillmentDeadline
"{\n \"fulfillmentDeadline\": \"2019-09-07T15:50:00Z\",\n \"fulfillmentOrderIds\": [\n \"gid://shopify/<objectName>/10079785100\"\n ]\n}"
Schema Reference for MUTATION: fulfillmentOrdersSetFulfillmentDeadline
""
Display Examples for MUTATION: fulfillmentOrdersSetFulfillmentDeadline
[ { "example": { "type_name": "fulfillmentorderssetfulfillmentdeadline", "title": "Set the fulfillment deadline for a list of fulfillment orders", "description": "The merchant or an order management app set the date and time, by which the fulfillment orders have to be fulfilled", "query_string": "mutation fulfillmentOrdersSetFulfillmentDeadline($fulfillmentDeadline: DateTime!, $fulfillmentOrderIds: [ID!]!) {\n fulfillmentOrdersSetFulfillmentDeadline(fulfillmentDeadline: $fulfillmentDeadline, fulfillmentOrderIds: $fulfillmentOrderIds) {\n success\n userErrors {\n field\n message\n }\n }\n}", "variables": { "fulfillmentDeadline": "2024-09-17T01:10:09Z", "fulfillmentOrderIds": [ "gid://shopify/FulfillmentOrder/234125762", "gid://shopify/FulfillmentOrder/564786110" ] }, "response": { "data": { "fulfillmentOrdersSetFulfillmentDeadline": { "success": true, "userErrors": [] } } }, "api_name": "admin", "minimum_api_version": "2023-10", "maximum_api_version": "unstable", "location": "/components/fulfillments/test/unit/graph_api/admin/mutations/fulfillment_orders_set_fulfillment_deadline_test.rb", "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation fulfillmentOrdersSetFulfillmentDeadline($fulfillmentDeadline: DateTime!, $fulfillmentOrderIds: [ID!]!) { fulfillmentOrdersSetFulfillmentDeadline(fulfillmentDeadline: $fulfillmentDeadline, fulfillmentOrderIds: $fulfillmentOrderIds) { success userErrors { field message } } }\",\n \"variables\": {\n \"fulfillmentDeadline\": \"2024-09-17T01:10:09Z\",\n \"fulfillmentOrderIds\": [\n \"gid://shopify/FulfillmentOrder/234125762\",\n \"gid://shopify/FulfillmentOrder/564786110\"\n ]\n }\n}'\n", "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation fulfillmentOrdersSetFulfillmentDeadline($fulfillmentDeadline: DateTime!, $fulfillmentOrderIds: [ID!]!) {\n fulfillmentOrdersSetFulfillmentDeadline(fulfillmentDeadline: $fulfillmentDeadline, fulfillmentOrderIds: $fulfillmentOrderIds) {\n success\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"fulfillmentDeadline\": \"2024-09-17T01:10:09Z\",\n \"fulfillmentOrderIds\": [\n \"gid://shopify/FulfillmentOrder/234125762\",\n \"gid://shopify/FulfillmentOrder/564786110\"\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 fulfillmentOrdersSetFulfillmentDeadline($fulfillmentDeadline: DateTime!, $fulfillmentOrderIds: [ID!]!) {\n fulfillmentOrdersSetFulfillmentDeadline(fulfillmentDeadline: $fulfillmentDeadline, fulfillmentOrderIds: $fulfillmentOrderIds) {\n success\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"fulfillmentDeadline\": \"2024-09-17T01:10:09Z\",\n \"fulfillmentOrderIds\": [\"gid://shopify/FulfillmentOrder/234125762\", \"gid://shopify/FulfillmentOrder/564786110\"]\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 fulfillmentOrdersSetFulfillmentDeadline($fulfillmentDeadline: DateTime!, $fulfillmentOrderIds: [ID!]!) {\n fulfillmentOrdersSetFulfillmentDeadline(fulfillmentDeadline: $fulfillmentDeadline, fulfillmentOrderIds: $fulfillmentOrderIds) {\n success\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"fulfillmentDeadline\": \"2024-09-17T01:10:09Z\",\n \"fulfillmentOrderIds\": [\n \"gid://shopify/FulfillmentOrder/234125762\",\n \"gid://shopify/FulfillmentOrder/564786110\"\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 fulfillmentOrdersSetFulfillmentDeadline($fulfillmentDeadline: DateTime!, $fulfillmentOrderIds: [ID!]!) {\n fulfillmentOrdersSetFulfillmentDeadline(fulfillmentDeadline: $fulfillmentDeadline, fulfillmentOrderIds: $fulfillmentOrderIds) {\n success\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"fulfillmentDeadline\" => \"2024-09-17T01:10:09Z\",\n \"fulfillmentOrderIds\" => [\"gid://shopify/FulfillmentOrder/234125762\", \"gid://shopify/FulfillmentOrder/564786110\"],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n" }, "titleStringKey": "variables", "inputVariableEntries": [ { "arg": { "name": "fulfillmentDeadline", "description": "The new fulfillment deadline of the fulfillment orders.", "type": { "kind": "SCALAR", "name": "DateTime", "list": false, "non_null": true }, "defaultValue": null, "typeSignature": "DateTime!", "isDeprecated": false, "deprecationReason": null, "kind": "ARGUMENT" }, "key": "fulfillmentDeadline", "argValue": " \"2024-09-17T01:10:09Z\"", "typeKind": "MUTATION" }, { "arg": { "name": "fulfillmentOrderIds", "description": "The IDs of the fulfillment orders for which the deadline is being set.", "type": { "kind": "SCALAR", "name": "ID", "list": true, "non_null": true }, "defaultValue": null, "typeSignature": "[ID!]!", "isDeprecated": false, "deprecationReason": null, "kind": "ARGUMENT" }, "key": "fulfillmentOrderIds", "argValue": " [\"gid://shopify/FulfillmentOrder/234125762\",\"gid://shopify/FulfillmentOrder/564786110\"]", "typeKind": "MUTATION" } ] } ]