updateOrder( )


Updates an order.

The updateOrder() function returns a Promise that resolves when the specified order's information is updated.

Currently, the following fields can be updated:

  • order.buyerInfo.email
  • order.buyerLanguage
  • order.weightUnit
  • order.billingInfo.address
  • order.billingInfo.contactDetails
  • order.archived
  • order.attributionSource
  • order.seenByAHuman
  • order.recipientInfo.address
  • order.recipientInfo.contactDetails
  • order.shippingInfo.logistics.shippingDestination.address
  • order.shippingInfo.logistics.shippingDestination.contactDetails

To update a field's value, include the new value in the order object in the method parameters. To remove a field's value, pass null.

Note: Removing buyerInfo or contactDetails fields results in an error.

To update an order's payment status, use updatePaymentStatus( ).

Authentication

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage eCommerce - all permissions
Manage Stores - all permissions
Manage Orders
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
function updateOrder(
  _id: string,
  order: UpdateOrder,
  options: UpdateOrderOptions,
): Promise<Order>;
Method Parameters
_idstringRequired

Order ID.


orderUpdateOrderRequired

optionsUpdateOrderOptions
Returns
Return Type:Promise<Order>
JavaScript
import { orders } from "wix-ecom-backend"; async function updateOrder(id, order, options) { try { const result = await orders.updateOrder(id, order, options); return result; } catch (error) { console.error(error); // Handle the error } }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?