Choose a version:

deliveryCustomizationCreate

mutation

Requires write_delivery_customizations access scope.

Creates a delivery customization.

Anchor to Arguments

Arguments

Anchor to deliveryCustomizationdeliveryCustomization

•DeliveryCustomizationInput!

required

The input data used to create the delivery customization.

Show input fields

Was this section helpful?

Anchor to DeliveryCustomizationCreatePayload returnsDeliveryCustomizationCreatePayload returns

Anchor to deliveryCustomizationdeliveryCustomization •DeliveryCustomization: Returns the created delivery customization.

Show fields
Anchor to userErrorsuserErrors •[DeliveryCustomizationError!]! non-null: The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

Examples

deliveryCustomizationCreate reference

Mutation Reference

mutation deliveryCustomizationCreate($deliveryCustomization: DeliveryCustomizationInput!) {

deliveryCustomizationCreate(deliveryCustomization: $deliveryCustomization) {

deliveryCustomization {

# DeliveryCustomization fields

}

userErrors {

field

message

}

Input

{

"deliveryCustomization": {

"enabled": true,

"functionHandle": "<your-functionHandle>",

"metafields": [

{

"id": "gid://shopify/Metafield/10079785100",

"key": "<your-key>",

"namespace": "<your-namespace>",

"type": "<your-type>",

"value": "<your-value>"

}

"title": "<your-title>"

}

Variables

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

Schema

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

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