Anchor to section titled 'undefined'fulfillment
fulfillment
mutation
2024-10latest
Requires write access scope. Also: The user must have fulfill_and_ship_orders permission.
Accepts a fulfillment request sent to a fulfillment service for a fulfillment order.
Anchor to section titled 'Arguments'
Arguments
The ID of the fulfillment order associated with the fulfillment request.
- Anchor to messagemessage
An optional reason for accepting the fulfillment request.
Was this section helpful?
Anchor to section titled 'FulfillmentOrderAcceptFulfillmentRequestPayload returns'
FulfillmentOrderAcceptFulfillmentRequestPayload returns
The fulfillment order whose fulfillment request was accepted.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: fulfillmentOrderAcceptFulfillmentRequest
Query Reference for MUTATION: fulfillmentOrderAcceptFulfillmentRequest
"mutation fulfillmentOrderAcceptFulfillmentRequest($id: ID!) {\n fulfillmentOrderAcceptFulfillmentRequest(id: $id) {\n fulfillmentOrder {\n # FulfillmentOrder fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: fulfillmentOrderAcceptFulfillmentRequest
"{\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"message\": \"<your-message>\"\n}"Schema Reference for MUTATION: fulfillmentOrderAcceptFulfillmentRequest
""
Display Examples for MUTATION: fulfillmentOrderAcceptFulfillmentRequest
[
{
"example": {
"type_name": "fulfillmentorderacceptfulfillmentrequest",
"title": "Accept a fulfillment request",
"description": "A fulfillment service accepts a fulfillment request for a fulfillment order.",
"query_string": "mutation fulfillmentOrderAcceptFulfillmentRequest($id: ID!, $message: String) {\n fulfillmentOrderAcceptFulfillmentRequest(id: $id, message: $message) {\n fulfillmentOrder {\n id\n status\n requestStatus\n }\n userErrors {\n field\n message\n }\n }\n}",
"variables": {
"id": "gid://shopify/FulfillmentOrder/1046000798",
"message": "Fragile"
},
"response": {
"data": {
"fulfillmentOrderAcceptFulfillmentRequest": {
"fulfillmentOrder": {
"id": "gid://shopify/FulfillmentOrder/1046000798",
"status": "IN_PROGRESS",
"requestStatus": "ACCEPTED"
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/fulfillments/test/unit/graph_api/admin/mutations/fulfillment_order_accept_fulfillment_request_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 fulfillmentOrderAcceptFulfillmentRequest($id: ID!, $message: String) { fulfillmentOrderAcceptFulfillmentRequest(id: $id, message: $message) { fulfillmentOrder { id status requestStatus } userErrors { field message } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/FulfillmentOrder/1046000798\",\n \"message\": \"Fragile\"\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation fulfillmentOrderAcceptFulfillmentRequest($id: ID!, $message: String) {\n fulfillmentOrderAcceptFulfillmentRequest(id: $id, message: $message) {\n fulfillmentOrder {\n id\n status\n requestStatus\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/FulfillmentOrder/1046000798\",\n \"message\": \"Fragile\"\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 fulfillmentOrderAcceptFulfillmentRequest($id: ID!, $message: String) {\n fulfillmentOrderAcceptFulfillmentRequest(id: $id, message: $message) {\n fulfillmentOrder {\n id\n status\n requestStatus\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/FulfillmentOrder/1046000798\",\n \"message\": \"Fragile\"\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 fulfillmentOrderAcceptFulfillmentRequest($id: ID!, $message: String) {\n fulfillmentOrderAcceptFulfillmentRequest(id: $id, message: $message) {\n fulfillmentOrder {\n id\n status\n requestStatus\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/FulfillmentOrder/1046000798\",\n \"message\": \"Fragile\"\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 fulfillmentOrderAcceptFulfillmentRequest($id: ID!, $message: String) {\n fulfillmentOrderAcceptFulfillmentRequest(id: $id, message: $message) {\n fulfillmentOrder {\n id\n status\n requestStatus\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"id\" => \"gid://shopify/FulfillmentOrder/1046000798\",\n \"message\" => \"Fragile\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "id",
"description": "The ID of the fulfillment order associated with the fulfillment request.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "id",
"argValue": " \"gid://shopify/FulfillmentOrder/1046000798\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "message",
"description": "An optional reason for accepting the fulfillment request.",
"type": {
"kind": "SCALAR",
"name": "String",
"list": false,
"non_null": false
},
"defaultValue": null,
"typeSignature": "String",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "message",
"argValue": " \"Fragile\"",
"typeKind": "MUTATION"
}
]
}
]