Order API
OrderStatus2
A enum representing the status of a customer's order.
You do not have to use all of these statuses. It's okay if the orders are created in the completed status, or start confirmed and then transition to completed, unconfirmed to completed
Values
unconfirmedThe order has been placed, but is pending a final confirmation or payment. For all analytical and most behavioural purposes it does not truly exist yet.
If a discount code or any other consumable or time-limited offer has been used in this order, the corresponding amount of points, discount or reward is locked in for this customer.
Depending on the shop configuration on Bubblehouse, the customer might or might not see, and might or might not be able to spend the loyalty points accrued for this order while it is in the
unconfirmedstate.confirmedThe order has been confirmed and paid, but has not been fully processed or shipped yet.
Depending on the shop configuration on Bubblehouse, the customer might or might not see, and might or might not be able to spend the loyalty points accrued for this order while it is in the
confirmedstate.completedThe order has been fully processed and shipped.
The customer will see and will be able to spend the loyalty points accrued for this order. Depending on the shop configuration on Bubblehouse, they might be able to see and spend the points earlier.
The customer can still request a full or partial refund for this order. After a full refund, the order should transition to
canceledstate; after a partial refund, it should stay indonestate.canceledThe order has been canceled or refunded.
If a discount code or any other consumable has been used in this order, the corresponding amount of points (or another similar resource like ownership of a limited-use achievement) is returned to the user.
deletedThe system should act as if this order has never been placed.
This status is a variation of
canceled. In other words, when deleting an order, it is always canceled first.Unlike canceled orders, deleted orders do not show up in any statistics and are not considered existing at all. For example, if all orders of a given customer are deleted, they can be referred by another customer again, as if they never made any orders.