PATCH

Update Order Email


Deprecated

This method has been replaced with Update Order, and will be removed on September 4, 2024.

Deprecation Notice:

This endpoint has been replaced with eCommerce Update Order and will be removed on September 4, 2024.

Updates the email address of a specified order's billing info. If shipping was selected as the delivery method, shipping info email will also be updated.

Authentication

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

Permissions
Manage Stores - all permissions
Manage Orders
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
PATCH
https://www.wixapis.com/stores/v2/orders/{orderId}/updateEmail

Path Params
orderIdstringRequired

Order ID.

Body Params
emailstringmaxLength 100format EMAIL

New email address for billing and shipping info.

Response Object
orderOrder

Updated order data.

Update Order Email Example 1
Request
cURL
curl -X PATCH 'https://www.wixapis.com/stores/v2/orders/4b070345-5813-49b6-b0ad-2125e5ca5b50/updateEmail' \ --data-binary '{ "orderId":"4b070345-5813-49b6-b0ad-2125e5ca5b50", "email":"JohnSmith@example.com" }' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "jsonrpc": "2.0", "id": 4, "result": { "order": { "id": "4b070345-5813-49b6-b0ad-2125e5ca5b50", "number": 10124, "dateCreated": "2020-08-26T11:43:42.028Z", "buyerInfo": { "id": "ebb9e43a-29b9-4c3f-b117-2a3a9e85ce09", "type": "MEMBER", "identityType": "MEMBER", "firstName": "Naor", "lastName": "Lipa", "phone": "545442147", "email": "Ivanushka@example.com" }, "currency": "USD", "weightUnit": "LB", "totals": { "subtotal": "248.0", "shipping": "15.0", "tax": "6.79", "discount": "0.0", "total": "269.79", "weight": "1000.0", "quantity": 3 }, "billingInfo": { "paymentMethod": "Stripe", "externalTransactionId": "pi_1HKN2aEQJH0qyaWeKASeZehh", "paymentProviderTransactionId": "pi_1HKN2aEQJH0qyaWeKASeZehh", "paymentGatewayTransactionId": "3b2a27a0-7723-4e67-bbc0-f10fc749f16b", "address": { "fullName": { "firstName": "Naor", "lastName": "Lipa" }, "country": "IN", "subdivision": "IN-WB", "city": "Kolkata", "zipCode": "700091", "phone": "545442147", "email": "Ivanushka@example.com", "addressLine1": "SDF Building, GP Block, Sector V, Bidhannagar, Kolkata, West Bengal 700091, India" }, "paidDate": "2020-08-26T11:43:45.563Z" }, "shippingInfo": { "deliveryOption": "standard", "estimatedDeliveryTime": "10-20", "shippingRegion": "Region 3", "shipmentDetails": { "address": { "fullName": { "firstName": "John", "lastName": "Smith" }, "country": "US", "city": "New York", "zipCode": "92544", "phone": "+972 555234555", "email": "Ivanushka@example.com" }, "discount": "0.0", "tax": "0.39", "priceData": { "price": "15.0" } } }, "read": true, "paymentStatus": "PAID", "lineItems": [ { "index": 1, "quantity": 2, "price": "84.0", "name": "Women's hoodies Black Pink kpop", "translatedName": "Women's hoodies Black Pink kpop", "productId": "cecada02-47c2-4f4c-b15a-4258a2fa758b", "totalPrice": "168.0", "lineItemType": "PHYSICAL", "options": [ { "option": "Color", "selection": "Gray" }, { "option": "Size", "selection": "L" } ], "mediaItem": { "mediaType": "IMAGE", "url": "https://static.wixstatic.com/media/9a1bff_cd5b6c34f83c4d01a8814b713ee9a750~mv2.jpg/v1/fit/w_800,h_800,q_90/file.jpg", "width": 800, "height": 800, "mediaId": "9a1bff_cd5b6c34f83c4d01a8814b713ee9a750~mv2.jpg", "id": "9a1bff_cd5b6c34f83c4d01a8814b713ee9a750~mv2.jpg" }, "sku": "14:691;5:361385-32954066607", "variantId": "00000000-0000-005f-0005-a48308e4493f", "fulfillerId": "f4ef9627-612a-4b63-b8bd-edb7831dcc92", "discount": "0.0", "tax": "0.0", "taxGroupId": "1cabe02f-1a30-4952-920f-36977f3259ef", "priceData": { "price": "84.0", "totalPrice": "168.0" } }, { "index": 2, "quantity": 1, "price": "80.0", "name": "Boring turtle", "translatedName": "Boring turtle", "productId": "762c3bc6-c4f8-fb4d-456e-24beb6f052aa", "totalPrice": "80.0", "lineItemType": "PHYSICAL", "options": [ { "option": "Color", "selection": "White" } ], "weight": "1000.0", "mediaItem": { "mediaType": "IMAGE", "url": "https://static.wixstatic.com/media/nsplsh_6c4f375f7665657935776b~mv2_d_6016_4016_s_4_2.jpg/v1/fit/w_6016,h_4016,q_90/file.jpg", "width": 6016, "height": 4016, "mediaId": "nsplsh_6c4f375f7665657935776b~mv2_d_6016_4016_s_4_2.jpg", "id": "nsplsh_6c4f375f7665657935776b~mv2_d_6016_4016_s_4_2.jpg" }, "variantId": "00000000-0000-0000-0000-000000000000", "fulfillerId": "0dae62fd-c36e-48db-a151-1f4b3d924d62", "discount": "0.0", "tax": "6.4", "priceData": { "price": "80.0", "totalPrice": "80.0" } } ], "activities": [ { "type": "ORDER_PLACED", "timestamp": "2020-08-26T11:43:42.028Z" }, { "type": "ORDER_PAID", "timestamp": "2020-08-26T11:43:45.563Z" }, { "type": "INVOICE_WAS_SET", "timestamp": "2020-08-30T08:28:35.633Z" }, { "type": "EMAIL_EDITED", "timestamp": "2020-09-01T16:19:33.386Z" } ], "invoiceInfo": { "id": "93518b17-b10a-45ca-87fe-a1e9c02b402a", "source": "WIX" }, "cartId": "7e27f5a6-ebab-449f-8a40-d88f8a65f683", "buyerLanguage": "en", "channelInfo": { "type": "WEB" }, "enteredBy": { "id": "ebb9e43a-29b9-4c3f-b117-2a3a9e85ce09", "identityType": "MEMBER" }, "lastUpdated": "2020-09-01T16:19:33.386Z", "numericId": "10124" } } }
Errors

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

Did this help?