fulfillmentConstraintRuleCreate

Creates a fulfillment constraint rule and its metafield.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the fulfillmentConstraintRuleCreate action (under Fulfillment).
Fill in the fields below, then reference the result from later steps as {{fulfillmentconstraintrulecreate.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 FulfillmentConstraintRuleCreate($functionId: String, $functionHandle: String, $deliveryMethodTypes: [DeliveryMethodType!]!, $metafields: [MetafieldInput!]) {
  fulfillmentConstraintRuleCreate(
    functionId: $functionId
    functionHandle: $functionHandle
    deliveryMethodTypes: $deliveryMethodTypes
    metafields: $metafields
  ) {
    fulfillmentConstraintRule {
      deliveryMethodTypes
      function {
        apiType
        apiVersion
        app
        appBridge
        appKey
        description
        handle
        id
        inputQuery
        title
        useCreationUi
      }
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

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

functionIdstring

The identifier of the function providing the constraint rule.

functionHandlestring

The handle of the function providing the constraint rule.

deliveryMethodTypesarray<string>required

Associate the function with one or multiple delivery method types.

metafieldsarray<object>

Metafields to associate to the fulfillment constraint rule.

idstring

namespacestring

keystring

valuestring

typestring

json

{
  "deliveryMethodTypes": [
    "SHIPPING"
  ],
  "functionId": "string",
  "functionHandle": "string",
  "metafields": [
    {
      "id": "string",
      "namespace": "string",
      "key": "string",
      "value": "string",
      "type": "string"
    }
  ]
}

Response

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

fulfillmentConstraintRuleobject

deliveryMethodTypesarray<object>

functionobject11 fields

idstring

userErrorsarray<object>

codeobject

fieldobject

messageobject

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

Was this page helpful?