Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IShoppingCartCheckoutStepStatus

A step is the logical grouping of the status of one requirement It is governed by the getRequiredData response and existence of the step usually indicates required-ness. A formal required boolean was added for the future possibility to return optionally required steps

export
interface

IShoppingCartCheckoutStepStatus

Hierarchy

  • IShoppingCartCheckoutStepStatus

Index

Properties

name

The name of the step. (ie placeOrder, payOrder, etc)

possible

possible: boolean

Indicates it is possible to perform the steps action Meaning all requirements and prerequisites are met from getRequiredDataForOrder and if the order status is sane

Optional possibleAfterPayment

possibleAfterPayment: undefined | false | true

Optional indicator for certain steps (ie. placeOrder) which indicates the step will be possible once payment has completed This is used as a trigger for the front-end to ensure all requirements other they payment have been met

required

required: boolean

Indicates this step is required for the current order

valid

valid: boolean

Indicates all requirements are met for this step