Choose a version:

checkoutProfile

query

Requires access to the checkout and accounts editor.

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 Arguments

Arguments

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

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to CheckoutProfileCheckoutProfile

•CheckoutProfile

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 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?