changeStartDate( )

Change the start date of a draft order.

The changeStartDate() function returns a promise that resolves to a draft of the Order object with an updated startDate.

This function cannot be called on paid orders. When an order is paid for, it is no longer considered a draft and its start date cannot be changed.

The onOrderStartDateChanged() and onOrderUpdated() event handlers run when the start date of an order is changed.

The member must be logged in to change the start date of their order. Members cannot change the start date of other members' orders.

Method Declaration
Method Parameters

Draft order ID.


New start date and time to update the startDate at which the order will become active.

Return Type:Promise<Order>
Was this helpful?