bulkUpdateOrders( )

Updates up to 100 orders.

The bulkUpdateOrders() function returns a Promise that resolves when the specified orders' 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 orders.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
Method Parameters
ordersArray<MaskedOrder>Required

Orders to update.

optionsBulkUpdateOrdersOptions
Returns
Return Type:Promise<BulkUpdateOrdersResponse>
Was this helpful?
Yes
No