paymentCustomizationCreate
mutation

Choose a version:

Requires write_payment_customizations access scope.

Creates a payment customization.

Anchor to section titled 'Arguments'

Arguments

Anchor to paymentCustomization paymentCustomization PaymentCustomizationInput! required: The input data used to create the payment customization.

Was this section helpful?

Anchor to section titled 'PaymentCustomizationCreatePayload returns'

PaymentCustomizationCreatePayload returns

Anchor to PaymentCustomizationCreatePayload.paymentCustomization paymentCustomization PaymentCustomization: Returns the created payment customization.
Anchor to PaymentCustomizationCreatePayload.userErrors userErrors [PaymentCustomizationError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: paymentCustomizationCreate

Query Reference for MUTATION: paymentCustomizationCreate

"mutation paymentCustomizationCreate($paymentCustomization: PaymentCustomizationInput!) {\n  paymentCustomizationCreate(paymentCustomization: $paymentCustomization) {\n    paymentCustomization {\n      # PaymentCustomization fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: paymentCustomizationCreate

"{\n  \"paymentCustomization\": {\n    \"enabled\": true,\n    \"functionId\": \"<your-functionId>\",\n    \"metafields\": [\n      {\n        \"description\": \"<your-description>\",\n        \"id\": \"gid://shopify/<objectName>/10079785100\",\n        \"key\": \"<your-key>\",\n        \"namespace\": \"<your-namespace>\",\n        \"type\": \"<your-type>\",\n        \"value\": \"<your-value>\"\n      }\n    ],\n    \"title\": \"<your-title>\"\n  }\n}"

Schema Reference for MUTATION: paymentCustomizationCreate

"input PaymentCustomizationInput {\n  enabled: Boolean\n  functionId: String\n  metafields: [MetafieldInput!]\n  title: String\n}\n\ninput MetafieldInput {\n  description: String\n  id: ID\n  key: String\n  namespace: String\n  type: String\n  value: String\n}\n"

Display Examples for MUTATION: paymentCustomizationCreate

[]

paymentCustomizationCreatemutation

Arguments

PaymentCustomizationCreatePayload returns

paymentCustomizationCreate
mutation