Anchor to section titled 'undefined'

deliveryCustomizationCreate
mutation

Requires write_delivery_customizations access scope.

Creates a delivery customization.

Anchor to section titled 'Arguments'

Arguments

Anchor to deliveryCustomization
deliveryCustomization
DeliveryCustomizationInput!
required

The input data used to create the delivery customization.

Was this section helpful?
Anchor to section titled 'DeliveryCustomizationCreatePayload returns'

DeliveryCustomizationCreatePayload returns

Anchor to DeliveryCustomizationCreatePayload.deliveryCustomization
deliveryCustomization
DeliveryCustomization

Returns the created delivery customization.

Anchor to DeliveryCustomizationCreatePayload.userErrors
userErrors
[DeliveryCustomizationError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation deliveryCustomizationCreate($deliveryCustomization: DeliveryCustomizationInput!) {
  deliveryCustomizationCreate(deliveryCustomization: $deliveryCustomization) {
    deliveryCustomization {
      # DeliveryCustomization fields
    }
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "deliveryCustomization": {
    "enabled": true,
    "functionId": "<your-functionId>",
    "metafields": [
      {
        "description": "<your-description>",
        "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 {
  description: String
  id: ID
  key: String
  namespace: String
  type: String
  value: String
}