paymentCustomizationUpdate

mutation

Requires write_payment_customizations access scope.

Updates a payment customization.

Arguments

Anchor to idid • ID!required: The global ID of the payment customization.
Anchor to paymentCustomizationpaymentCustomization • PaymentCustomizationInput!required: The input data used to update the payment customization.

Was this section helpful?

Anchor to PaymentCustomizationUpdatePayload returnsPaymentCustomizationUpdatePayload returns

Anchor to paymentCustomizationpaymentCustomization • PaymentCustomization: Returns the updated payment customization.
Anchor to userErrorsuserErrors • [PaymentCustomizationError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

1mutation paymentCustomizationUpdate($id: ID!, $paymentCustomization: PaymentCustomizationInput!) {
2  paymentCustomizationUpdate(id: $id, paymentCustomization: $paymentCustomization) {
3    paymentCustomization {
4      # PaymentCustomization fields
5    }
6    userErrors {
7      field
8      message
9    }
10  }
11}

Input

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

{
  "id": "gid://shopify/<objectName>/10079785100",
  "paymentCustomization": {
    "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 PaymentCustomizationInput {
  enabled: Boolean
  functionId: String
  metafields: [MetafieldInput!]
  title: String
}

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