fulfillmentOrderSplit

Splits FulfillmentOrder objects by moving the specified LineItem objects and quantities into a new fulfillment order.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the fulfillmentOrderSplit action (under Fulfillment).
Fill in the fields below, then reference the result from later steps as {{fulfillmentordersplit.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

mutation FulfillmentOrderSplit($fulfillmentOrderSplits: [FulfillmentOrderSplitInput!]!) {
  fulfillmentOrderSplit(fulfillmentOrderSplits: $fulfillmentOrderSplits) {
    fulfillmentOrderSplits {
      fulfillmentOrder {
        assignedLocation
        channelId
        createdAt
        deliveryMethod
        destination
        fulfillAt
        fulfillBy
        fulfillmentHolds
        id
        internationalDuties
        order
        orderId
        orderName
        orderProcessedAt
        remainingLineItemsWeight
        requestStatus
        status
        supportedActions
        updatedAt
      }
      remainingFulfillmentOrder {
        assignedLocation
        channelId
        createdAt
        deliveryMethod
        destination
        fulfillAt
        fulfillBy
        fulfillmentHolds
        id
        internationalDuties
        order
        orderId
        orderName
        orderProcessedAt
        remainingLineItemsWeight
        requestStatus
        status
        supportedActions
        updatedAt
      }
      replacementFulfillmentOrder {
        assignedLocation
        channelId
        createdAt
        deliveryMethod
        destination
        fulfillAt
        fulfillBy
        fulfillmentHolds
        id
        internationalDuties
        order
        orderId
        orderName
        orderProcessedAt
        remainingLineItemsWeight
        requestStatus
        status
        supportedActions
        updatedAt
      }
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

fulfillmentOrderSplitsarray<object>required

The fulfillment orders, line items and quantities to be split into new fulfillment orders.

fulfillmentOrderLineItemsarray<string>required

fulfillmentOrderIdstringrequired

json

{
  "fulfillmentOrderSplits": [
    {
      "fulfillmentOrderLineItems": [
        "string"
      ],
      "fulfillmentOrderId": "string"
    }
  ]
}

Response

Read the result with {{fulfillmentordersplit.response.data.data.fulfillmentOrderSplit}}. If the API returns errors, the step fails and they are at {{fulfillmentordersplit.response.data.errors}}.

fulfillmentOrderSplitsarray<object>

fulfillmentOrderobject

remainingFulfillmentOrderobject

replacementFulfillmentOrderobject

userErrorsarray<object>

codeobject

fieldobject

messageobject

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?