Application Load
IOrderCreateFailure
The physical TypeScript declaration from the Nuxt starter, with linked types and field comments.
IOrderCreateFailureRecovery details accompanying an order creation error.
interfaces/orionplace/orders/IOrderActions.tsexport interface IOrderCreateFailure {
// True means checkout was rebuilt after a stock, price, promo or delivery
// change. Reload cart_guest_get and review the returned quantities, options,
// delivery and totals before another attempt. False does not override a
// supplied cart_delivery_id.
reboot?: boolean;
// True when a stock operation is temporarily busy. Wait before a deliberate
// retry; this error contains no created-order ID.
retryable?: boolean;
// False when this account cannot place orders. Show the returned error;
// changing cart items does not grant ordering permission.
orders_allowed?: false;
// True when the attached promo fails validation or gives no eligible
// discount. The promo is removed during checkout rebuild; reload the cart and
// review prices before applying another code or retrying.
promo_error?: boolean;
// True when the store temporarily stops orders. Show the supplied message and
// wait until ordering is available again.
orders_temporary_disabled?: boolean;
// Available account balance in USD when balance payment cannot cover the
// cart. It is the available balance, not the missing amount. Refresh
// cart/profile, then fund the balance or choose another eligible payment
// method.
balance_usd?: number | string;
// Minimum permitted order total in USD when the current total is below it.
// Adjust the cart and reload its totals before another attempt.
min_usd?: number | string;
// Cart shipment-item ID for a fulfillment or required-option error. Match
// product_items[].dlf_id in the current checkout response. With reboot,
// reload first because rebuilt IDs can change.
dlf_item?: number;
// Cart option-group ID for missing required text/file or an option-product
// failure. Match product_items[].option_group[].id and correct that group.
option_group?: number;
// Cart option-record ID for an unavailable selected option product. Match
// option_group[].options[].id after refreshing the cart.
option?: number;
// Cart delivery-group ID when a pickup destination is missing. Match
// cart_data[].delivery_from_id and select a pickup point.
dlf?: number;
// Cart delivery-group ID when delivery recalculation failed. Its saved
// delivery choice is cleared; reload the cart and choose delivery again for
// that group, even when reboot is false.
cart_delivery_id?: number;
}