Skip to main content
Required scopes: checkout_read, checkout_write
​
[CheckoutWidgetAssignedExperience!]!
required
Checkout experiences that show this widget.
​
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.