PATCH

Update Order

Updates an order's properties.

Currently, only the following fields can be updated:

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

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

Notes:

  • Removing buyerInfo or contactDetails results in an error.
  • To modify pricing or line items, use the Draft Orders API.

To update an order's payment status, use Update Payment Status.

Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Manage Orders
Learn more about app permissions.
Method Declaration
Copy
Errors
428Failed Precondition

There are 2 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Event TriggersThis method triggers the following events:
Order Updated
Did this help?