Mutations

checkoutExperienceWidgetsSet

Replace the widgets a checkout experience shows, and return them. This changes checkout right away for an experience in the live checkout tree, so confirmLiveChange must be true or it fails with CHECKOUT_WIDGET_LIVE (409). Fails with CHECKOUT_WIDGETS_UNAVAILABLE (409) while availability.available is false, unless the list only removes widgets the experience already has. A shipping option widget fails with INVALID_CHECKOUT_WIDGET (400). Null when the experience or any widget is from another account or does not exist.

Required scopes: checkout_write

Arguments

CheckoutExperienceWidgetsSetInput!

required

The experience and its new widgets.

Show fields

ID!

required

The checkout experience’s id.

Boolean

Must be true: this write can reach shoppers right away.

Every widget the experience should show. It replaces the current list; an empty list removes them all. Shipping option widgets are not assigned here.

Returns

[CheckoutWidget!]

A block a store shows at checkout. It reaches shoppers when global is true or an experience uses it.

Show fields

[CheckoutWidgetAssignedExperience!]!

required

Checkout experiences that show this widget.

Show fields

ID!

required

The experience’s id.

String!

required

The experience’s name.

CheckoutWidgetConfig!

required

The widget’s settings.

DateTime!

required

When the widget was created.

Boolean!

required

Whether it shows in every checkout experience. A store has at most one per type. Always false for shipping option widgets.

ID!

required

The widget’s id.

String!

required

Merchant-facing name.

String!

required

Where it renders. For shipping option widgets, DETAILS_RENDER_AFTER or DETAILS_RENDER_EXPANDED. For others, a checkout block target such as INFORMATION1, or a dynamic target name.

CheckoutWidgetType!

required

What the widget does. It can’t change.

DateTime!

required

When the widget was last changed.

Example

mutation {
  checkoutExperienceWidgetsSet(input: { ... }) {
    createdAt
    global
    id
    name
    target
    type
    updatedAt
  }
}

Getting Started

Guides

Reference

checkoutExperienceWidgetsSet

Arguments

Returns

Example

​Arguments

​Returns

​Example

Arguments

Returns

Example