Anchor to section titled 'undefined'fulfillment
fulfillment
mutation
2024-07
Requires write access scope or write access scope. Also: The user must have fulfill_and_ship_orders permission.
Splits a fulfillment order or orders based on line item inputs and quantities.
Anchor to section titled 'Arguments'
Arguments
The fulfillment orders, line items and quantities to be split into new fulfillment orders.
Was this section helpful?
Anchor to section titled 'FulfillmentOrderSplitPayload returns'
FulfillmentOrderSplitPayload returns
The result of the fulfillment order splits.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: fulfillmentOrderSplit
Query Reference for MUTATION: fulfillmentOrderSplit
"mutation fulfillmentOrderSplit($fulfillmentOrderSplits: [FulfillmentOrderSplitInput!]!) {\n fulfillmentOrderSplit(fulfillmentOrderSplits: $fulfillmentOrderSplits) {\n fulfillmentOrderSplits {\n # FulfillmentOrderSplitResult fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: fulfillmentOrderSplit
"{\n \"fulfillmentOrderSplits\": [\n {\n \"fulfillmentOrderId\": \"gid://shopify/<objectName>/10079785100\",\n \"fulfillmentOrderLineItems\": [\n {\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"quantity\": 1\n }\n ]\n }\n ]\n}"Schema Reference for MUTATION: fulfillmentOrderSplit
"input FulfillmentOrderSplitInput {\n fulfillmentOrderId: ID!\n fulfillmentOrderLineItems: [FulfillmentOrderLineItemInput!]!\n}\n\ninput FulfillmentOrderLineItemInput {\n id: ID!\n quantity: Int!\n}\n"Display Examples for MUTATION: fulfillmentOrderSplit
[
{
"example": {
"type_name": "fulfillmentordersplit",
"title": "Split a single fulfillment order",
"description": "A merchant or order management app splits one or more fulfillment orders into multiple fulfillment orders, by specifying line items and quantities to split.",
"query_string": "mutation fulfillmentOrderSplit($fulfillmentOrderSplits: [FulfillmentOrderSplitInput!]!) {\n fulfillmentOrderSplit(fulfillmentOrderSplits: $fulfillmentOrderSplits) {\n fulfillmentOrderSplits {\n fulfillmentOrder {\n id\n lineItems(first: 10) {\n edges {\n cursor\n node {\n id\n totalQuantity\n }\n }\n }\n }\n remainingFulfillmentOrder {\n id\n lineItems(first: 10) {\n edges {\n cursor\n node {\n id\n totalQuantity\n }\n }\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n}",
"variables": {
"fulfillmentOrderSplits": [
{
"fulfillmentOrderId": "gid://shopify/FulfillmentOrder/1046000796",
"fulfillmentOrderLineItems": [
{
"id": "gid://shopify/FulfillmentOrderLineItem/1058737504",
"quantity": 2
}
]
}
]
},
"response": {
"data": {
"fulfillmentOrderSplit": {
"fulfillmentOrderSplits": [
{
"fulfillmentOrder": {
"id": "gid://shopify/FulfillmentOrder/1046000796",
"lineItems": {
"edges": [
{
"cursor": "eyJsYXN0X2lkIjoxMDU4NzM3NTAzLCJsYXN0X3ZhbHVlIjoxMDU4NzM3NTAzfQ==",
"node": {
"id": "gid://shopify/FulfillmentOrderLineItem/1058737503",
"totalQuantity": 1
}
}
]
}
},
"remainingFulfillmentOrder": {
"id": "gid://shopify/FulfillmentOrder/1046000797",
"lineItems": {
"edges": [
{
"cursor": "eyJsYXN0X2lkIjoxMDU4NzM3NTA0LCJsYXN0X3ZhbHVlIjoxMDU4NzM3NTA0fQ==",
"node": {
"id": "gid://shopify/FulfillmentOrderLineItem/1058737504",
"totalQuantity": 2
}
}
]
}
}
}
],
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/fulfillments/test/unit/graph_api/admin/mutations/fulfillment_order_split_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 fulfillmentOrderSplit($fulfillmentOrderSplits: [FulfillmentOrderSplitInput!]!) { fulfillmentOrderSplit(fulfillmentOrderSplits: $fulfillmentOrderSplits) { fulfillmentOrderSplits { fulfillmentOrder { id lineItems(first: 10) { edges { cursor node { id totalQuantity } } } } remainingFulfillmentOrder { id lineItems(first: 10) { edges { cursor node { id totalQuantity } } } } } userErrors { field message } } }\",\n \"variables\": {\n \"fulfillmentOrderSplits\": [\n {\n \"fulfillmentOrderId\": \"gid://shopify/FulfillmentOrder/1046000796\",\n \"fulfillmentOrderLineItems\": [\n {\n \"id\": \"gid://shopify/FulfillmentOrderLineItem/1058737504\",\n \"quantity\": 2\n }\n ]\n }\n ]\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation fulfillmentOrderSplit($fulfillmentOrderSplits: [FulfillmentOrderSplitInput!]!) {\n fulfillmentOrderSplit(fulfillmentOrderSplits: $fulfillmentOrderSplits) {\n fulfillmentOrderSplits {\n fulfillmentOrder {\n id\n lineItems(first: 10) {\n edges {\n cursor\n node {\n id\n totalQuantity\n }\n }\n }\n }\n remainingFulfillmentOrder {\n id\n lineItems(first: 10) {\n edges {\n cursor\n node {\n id\n totalQuantity\n }\n }\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"fulfillmentOrderSplits\": [\n {\n \"fulfillmentOrderId\": \"gid://shopify/FulfillmentOrder/1046000796\",\n \"fulfillmentOrderLineItems\": [\n {\n \"id\": \"gid://shopify/FulfillmentOrderLineItem/1058737504\",\n \"quantity\": 2\n }\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 fulfillmentOrderSplit($fulfillmentOrderSplits: [FulfillmentOrderSplitInput!]!) {\n fulfillmentOrderSplit(fulfillmentOrderSplits: $fulfillmentOrderSplits) {\n fulfillmentOrderSplits {\n fulfillmentOrder {\n id\n lineItems(first: 10) {\n edges {\n cursor\n node {\n id\n totalQuantity\n }\n }\n }\n }\n remainingFulfillmentOrder {\n id\n lineItems(first: 10) {\n edges {\n cursor\n node {\n id\n totalQuantity\n }\n }\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"fulfillmentOrderSplits\": [{\"fulfillmentOrderId\"=>\"gid://shopify/FulfillmentOrder/1046000796\", \"fulfillmentOrderLineItems\"=>[{\"id\"=>\"gid://shopify/FulfillmentOrderLineItem/1058737504\", \"quantity\"=>2}]}]\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 fulfillmentOrderSplit($fulfillmentOrderSplits: [FulfillmentOrderSplitInput!]!) {\n fulfillmentOrderSplit(fulfillmentOrderSplits: $fulfillmentOrderSplits) {\n fulfillmentOrderSplits {\n fulfillmentOrder {\n id\n lineItems(first: 10) {\n edges {\n cursor\n node {\n id\n totalQuantity\n }\n }\n }\n }\n remainingFulfillmentOrder {\n id\n lineItems(first: 10) {\n edges {\n cursor\n node {\n id\n totalQuantity\n }\n }\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"fulfillmentOrderSplits\": [\n {\n \"fulfillmentOrderId\": \"gid://shopify/FulfillmentOrder/1046000796\",\n \"fulfillmentOrderLineItems\": [\n {\n \"id\": \"gid://shopify/FulfillmentOrderLineItem/1058737504\",\n \"quantity\": 2\n }\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 fulfillmentOrderSplit($fulfillmentOrderSplits: [FulfillmentOrderSplitInput!]!) {\n fulfillmentOrderSplit(fulfillmentOrderSplits: $fulfillmentOrderSplits) {\n fulfillmentOrderSplits {\n fulfillmentOrder {\n id\n lineItems(first: 10) {\n edges {\n cursor\n node {\n id\n totalQuantity\n }\n }\n }\n }\n remainingFulfillmentOrder {\n id\n lineItems(first: 10) {\n edges {\n cursor\n node {\n id\n totalQuantity\n }\n }\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"fulfillmentOrderSplits\" => [{\"fulfillmentOrderId\"=>\"gid://shopify/FulfillmentOrder/1046000796\", \"fulfillmentOrderLineItems\"=>[{\"id\"=>\"gid://shopify/FulfillmentOrderLineItem/1058737504\", \"quantity\"=>2}]}],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "fulfillmentOrderSplits",
"description": "The fulfillment orders, line items and quantities to be split into new fulfillment orders.",
"type": {
"kind": "INPUT_OBJECT",
"name": "FulfillmentOrderSplitInput",
"list": true,
"non_null": true
},
"defaultValue": null,
"typeSignature": "[FulfillmentOrderSplitInput!]!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "fulfillmentOrderSplits",
"argValue": " [{\"fulfillmentOrderId\":\"gid://shopify/FulfillmentOrder/1046000796\",\"fulfillmentOrderLineItems\":[{\"id\":\"gid://shopify/FulfillmentOrderLineItem/1058737504\",\"quantity\":2}]}]",
"typeKind": "MUTATION"
}
]
}
]