Choose a version:

CheckoutProfile

object

Requires access to the checkout and accounts editor.

A checkout profile defines the branding settings and the UI extensions for a store's checkout. A checkout profile could be published or draft. A store might have at most one published checkout profile, which is used to render their live checkout. The store could also have multiple draft profiles that were created, previewed, and published using the admin checkout editor.

Anchor to FieldsFields

Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the checkout profile was created.
Anchor to editedAteditedAt •DateTime! non-null: The date and time when the checkout profile was last edited.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to isPublishedisPublished •Boolean! non-null: Whether the checkout profile is published or not.
Anchor to namename •String! non-null: The profile name.
Anchor to typOspPagesActivetypOspPagesActive •Boolean! non-null: Whether the checkout profile Thank You Page and Order Status Page are actively using extensibility or not.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time when the checkout profile was last updated.

Was this section helpful?

Anchor to QueriesQueries

Anchor to checkoutProfile checkoutProfile

•query

Returns a CheckoutProfile. Checkout profiles define the branding settings and UI extensions for a store's checkout experience. Stores can have one published profile that renders on their live checkout and multiple draft profiles for testing customizations in the checkout editor.

Anchor to idid •ID! required: The ID of the checkout profile.

Anchor to checkoutProfiles checkoutProfiles

•query

List of checkout profiles on a shop.

Arguments

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•CheckoutProfileSortKeys

Default:UPDATED_AT

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to queryquery

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to id •id: Filter by id range.
Anchor to is_published •boolean

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to Node Node •interface

Was this section helpful?