fulfillmentConstraintRuleCreate

mutation

Requires write_fulfillment_constraint_rules access scope.

Creates a fulfillment constraint rule and its metafield.

Arguments

Anchor to functionIdfunctionId • String!required: The identifier of the function providing the constraint rule.
Anchor to metafieldsmetafields • [MetafieldInput!]Default:[]: Metafields to associate to the fulfillment constraint rule.

Was this section helpful?

Anchor to FulfillmentConstraintRuleCreatePayload returnsFulfillmentConstraintRuleCreatePayload returns

Anchor to fulfillmentConstraintRulefulfillmentConstraintRule • FulfillmentConstraintRule: The newly created fulfillment constraint rule.
Anchor to userErrorsuserErrors • [FulfillmentConstraintRuleCreateUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

1mutation fulfillmentConstraintRuleCreate($functionId: String!, $metafields: [MetafieldInput!]) {
2  fulfillmentConstraintRuleCreate(functionId: $functionId, metafields: $metafields) {
3    fulfillmentConstraintRule {
4      # FulfillmentConstraintRule fields
5    }
6    userErrors {
7      field
8      message
9    }
10  }
11}

Input

1{
2  "functionId": "<your-functionId>",
3  "metafields": [
4    {
5      "id": "gid://shopify/<objectName>/10079785100",
6      "key": "<your-key>",
7      "namespace": "<your-namespace>",
8      "type": "<your-type>",
9      "value": "<your-value>"
10    }
11  ]
12}

{
  "functionId": "<your-functionId>",
  "metafields": [
    {
      "id": "gid://shopify/<objectName>/10079785100",
      "key": "<your-key>",
      "namespace": "<your-namespace>",
      "type": "<your-type>",
      "value": "<your-value>"
    }
  ]
}

input MetafieldInput {
  description: String
  id: ID
  key: String
  namespace: String
  type: String
  value: String
}