Order Paid


Deprecation Notice:

This webhook has been replaced with eCommerce Order Payment Status Updated Event and will be removed on September 4, 2024.

Triggered when an order is paid.

Permissions
Manage Stores - all permissions
Read Stores - all read permissions
Manage Orders
Read Orders
Manage Restaurants - all permissions
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
orderOrder

Paid order data.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "data": { "eventType": "OrderPaid", "instanceId": "<app-instance-id>", "data": "<stringified-JSON>", // The identity field is sent as a stringified JSON "identity": { "identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP "anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR "memberId": "<memberId>", // in case of MEMBER "wixUserId": "<wixUserId>", // in case of WIX_USER "appId": "<appId>" // in case of APP } } }

Order Paid
JSON
{ "order": { "id": "fedb19f5-bd4c-4bfc-b2d1-212538319611", "number": 10096, "dateCreated": "2020-03-18T16:47:59.222Z", "currency": "USD", "weightUnit": "LB", "totals": { "subtotal": "10", "shipping": "3", "tax": "3", "discount": "1", "total": "15", "weight": "30", "quantity": 2 }, "billingInfo": { "paymentMethod": "PayPal", "externalTransactionId": "tx_1806", "paymentProviderTransactionId": "tx_1806", "address": { "fullName": { "firstName": "John", "lastName": "Smith" }, "country": "US", "city": "New York", "zipCode": "92544", "phone": "+972 555234555", "email": "Ivanushka@example.com" }, "paidDate": "2020-03-18T16:47:59.244Z" }, "shippingInfo": { "deliveryOption": "Express", "estimatedDeliveryTime": "Today", "shippingRegion": "East coast", "shipmentDetails": { "address": { "fullName": { "firstName": "John", "lastName": "Smith" }, "country": "US", "city": "New York", "zipCode": "92544", "phone": "+972 555234555", "email": "Ivanushka@example.com" }, "discount": "0", "tax": "1", "priceData": { "taxIncludedInPrice": false, "price": "3" } } }, "read": false, "archived": false, "paymentStatus": "PAID", "fulfillmentStatus": "NOT_FULFILLED", "lineItems": [ { "index": 1, "quantity": 2, "name": "my product", "productId": "a1f9d337-f831-4529-31e6-67db8fd4e1aa", "lineItemType": "PHYSICAL", "options": [], "customTextFields": [], "weight": "15", "sku": "12345678", "discount": "1", "tax": "1", "priceData": { "taxIncludedInPrice": false, "price": "5", "totalPrice": "10" } } ], "activities": [ { "type": "ORDER_PLACED", "timestamp": "2020-03-18T16:47:59.222Z" }, { "type": "ORDER_PAID", "timestamp": "2020-03-18T16:47:59.244Z" } ], "fulfillments": [], "discount": { "value": "1" }, "buyerLanguage": "en", "channelInfo": { "type": "WEB" }, "enteredBy": { "id": "e85274cf-047a-4989-baff-dac5e0c3971d", "identityType": "USER" }, "lastUpdated": "2020-03-18T16:47:59.244Z" } }
Did this help?