checkout_read
Returns
required
The store’s checkout widgets, and whether it can add more.
Show fields
Show fields
required
Whether the store can add checkout widgets.
Show fields
Show fields
Boolean!
required
False means creating, duplicating, assigning and turning a widget global fail with CHECKOUT_WIDGETS_UNAVAILABLE (409).
What blocks it. Empty when available.
required
Widgets, oldest first. Cursors are positional, so a widget can shift if widgets are created or deleted while you page.
Show fields
Show fields
ArgumentsFields
String
Return widgets after this cursor.
String
Return widgets before this cursor.
Int
Page size.
Int
Page size, paging backward.
required
The list of edges (each a node plus its pagination
cursor).Show fields
Show fields
String!
required
Opaque cursor for this item; pass to
after/before to page from here.required
The item at this edge.
required
The nodes in this page, without the edge/cursor wrapper — a convenience over
edges.Show fields
Show fields
Checkout experiences that show this widget.
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.
Pagination metadata for the current page.
Show fields
Show fields
String
Cursor of the last edge in this page; pass to
after to page forward.Boolean!
required
Whether more items exist after this page (drives forward pagination with
first/after).Boolean!
required
Whether more items exist before this page (drives backward pagination with
last/before).String
Cursor of the first edge in this page; pass to
before to page backward.Example
query {
checkoutWidgets {
widgets {
nodes {
createdAt
global
id
name
target
type
updatedAt
}
pageInfo { hasNextPage endCursor }
}
}
}