deliveryCustomizationCreate

mutation

Requires write_delivery_customizations access scope.

Creates a delivery customization.

Arguments

Anchor to deliveryCustomizationdeliveryCustomization • DeliveryCustomizationInput!required: The input data used to create the delivery customization.

Was this section helpful?

Anchor to DeliveryCustomizationCreatePayload returnsDeliveryCustomizationCreatePayload returns

Anchor to deliveryCustomizationdeliveryCustomization • DeliveryCustomization: Returns the created delivery customization.
Anchor to userErrorsuserErrors • [DeliveryCustomizationError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

1mutation deliveryCustomizationCreate($deliveryCustomization: DeliveryCustomizationInput!) {
2  deliveryCustomizationCreate(deliveryCustomization: $deliveryCustomization) {
3    deliveryCustomization {
4      # DeliveryCustomization fields
5    }
6    userErrors {
7      field
8      message
9    }
10  }
11}

Input

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

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

input DeliveryCustomizationInput {
  enabled: Boolean
  functionId: String
  metafields: [MetafieldInput!]
  title: String
}

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