checkoutWidget

Required scopes: checkout_read

Arguments

ID!

required

The widget’s id.

Returns

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

query {
  checkoutWidget(id: "...") {
    createdAt
    global
    id
    name
    target
    type
    updatedAt
  }
}

Getting Started

Guides

Reference

checkoutWidget

Arguments

Returns

Example

​Arguments

​Returns

​Example

Arguments

Returns

Example