POST

Bulk Update Orders


Updates properties of up to 100 orders.

Currently, only 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
  • order.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.

Note: Removing (passing null to) buyerInfo or contactDetails results in an error.

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

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage eCommerce - all permissions
Manage Stores - all permissions
Manage Orders
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/ecom/v1/bulk/orders/update

Body Params
ordersArray <MaskedOrder>RequiredminItems 1maxItems 100

Orders to update.


returnEntityboolean

Whether to return the full order entities.

Default: false

Response Object
resultsArray <BulkOrderResult>minItems 1maxItems 100

Bulk action results.


bulkActionMetadataBulkActionMetadata

Bulk action metadata.

Bulk updates archived status for 2 orders.

Request
cURL
curl -X POST \ 'https://www.wixapis.com/ecom/v1/bulk/orders/update' \ -H 'Content-type: application/json' \ -H 'Authorization: <AUTH>' \ --data-binary '{ "orders": [ { "order": { "id": "efc0f204-d83a-4391-b576-e9cf816f6bc9", "archived": true } }, { "order": { "id": "6bfb7f73-3269-41d6-b396-64f6bb5947ff", "archived": true } } ], "returnEntity": false }'
Response
JSON
{ "results": [ { "itemMetadata": { "id": "efc0f204-d83a-4391-b576-e9cf816f6bc9", "originalIndex": 0, "success": true } }, { "itemMetadata": { "id": "6bfb7f73-3269-41d6-b396-64f6bb5947ff", "originalIndex": 1, "success": true } } ], "bulkActionMetadata": { "totalSuccesses": 2, "totalFailures": 0, "undetailedFailures": 0 } }
Errors

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

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