checkout_write
Arguments
required
The widget to create.
Show fields
Show fields
required
The widget’s settings.
Show fields
Show fields
A content block.
A failed discount rescue.
A fulfillment cutoff.
An image block.
A low-profile product upsell.
A product reviews widget.
Shipping option content.
A shipping option image.
A shipping option upsell.
A threshold upsell.
Boolean
Set to true to confirm a write that changes what shoppers see at checkout right away.
Boolean
Show it in every checkout experience. A store can have one per type. Not for shipping option widgets. Defaults to false.
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.
Returns
required
A block a store shows at checkout. It reaches shoppers when
global is true or an experience uses it.Show fields
Show fields
required
The widget’s settings.
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.
required
What the widget does. It can’t change.
Example
mutation {
checkoutWidgetCreate(input: { ... }) {
createdAt
global
id
name
target
type
updatedAt
}
}