Anchor to section titled 'undefined'

deliveryCustomizationUpdate
mutation

Requires write_delivery_customizations access scope.

Updates a delivery customization.

Anchor to section titled 'Arguments'

Arguments

Anchor to deliveryCustomization
deliveryCustomization
DeliveryCustomizationInput!
required

The input data used to update the delivery customization.

Anchor to id
id
ID!
required

The global ID of the delivery customization.

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

DeliveryCustomizationUpdatePayload returns

Anchor to DeliveryCustomizationUpdatePayload.deliveryCustomization
deliveryCustomization
DeliveryCustomization

Returns the updated delivery customization.

Anchor to DeliveryCustomizationUpdatePayload.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 deliveryCustomizationUpdate($deliveryCustomization: DeliveryCustomizationInput!, $id: ID!) {
  deliveryCustomizationUpdate(deliveryCustomization: $deliveryCustomization, id: $id) {
    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>"
  },
  "id": "gid://shopify/<objectName>/10079785100"
}
input DeliveryCustomizationInput {
  enabled: Boolean
  functionId: String
  metafields: [MetafieldInput!]
  title: String
}

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