deliveryCustomizationUpdate

mutation

Requires write_delivery_customizations access scope.

Updates a delivery customization.

Arguments

Anchor to deliveryCustomizationdeliveryCustomization • DeliveryCustomizationInput!required: The input data used to update the delivery customization.
Anchor to idid • ID!required: The global ID of the delivery customization.

Was this section helpful?

Anchor to DeliveryCustomizationUpdatePayload returnsDeliveryCustomizationUpdatePayload returns

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

Was this section helpful?

Mutation Reference

mutation deliveryCustomizationUpdate($deliveryCustomization: DeliveryCustomizationInput!, $id: ID!) {

deliveryCustomizationUpdate(deliveryCustomization: $deliveryCustomization, id: $id) {

deliveryCustomization {

# DeliveryCustomization fields

}

userErrors {

field

message

}

Input

{

"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"

}

{
  "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
}