Search.../
  1. Home
  2. Getting Started
  3. Overview
Generate a test token to explore our APIs

Order Created Webhook

Permissions

This webhook requires the Manage Orders or the Read Orders permission scope.

Event 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

NAME
TYPE
DESCRIPTION
read

boolean

Whether the order was read by the store owner

number

integer

ID displayed in the owner's store (auto generated)

paymentStatus

string

Supported values: UNSPECIFIED_PAYMENT_STATUS, NOT_PAID, PAID, PARTIALLY_REFUNDED, FULLY_REFUNDED, PENDING.

Order payment status

orderId

string

Order ID (auto generated upon order creation)

archived

boolean

Order archive status

weightUnit

string

Supported values: UNSPECIFIED_WEIGHT_UNIT, KG, LB.

Weight unit used in this store

dateCreated

string

Order creation date

buyerInfo

object

Customer information

currency

string

Currency used for pricing in this store

totals

object

Totals for order's line items

fulfillmentStatus

string

Supported values: NOT_FULFILLED, FULFILLED, CANCELED, PARTIALLY_FULFILLED.

Order fulfillment status

Was this helpful?

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

Event Body

json

1{
2 "data": {
3 "eventType": "<event-type>",
4 "instanceId": "<app-instance-id>",
5 "data": "<stringified-JSON>"
6 }
7}

The parsed data will include:

Sample Data

json

1
2{
3 "orderId": "afc47c2d-4fbf-450d-9f20-478e54b46b89",
4 "number": "10001",
5 "dateCreated": "2019-08-28T08:30:42.074Z",
6 "buyerInfo": {
7 "id": "d52512dc-131f-4062-abf3-a653552bbbd2",
8 "type": "CONTACT",
9 "identityType": "CONTACT",
10 "firstName": "Eric",
11 "lastName": "Ben",
12 "phone": "055223399",
13 "email": "test123@wix.com"
14 },
15 "currency": "USD",
16 "weightUnit": "KG",
17 "totals": {
18 "subtotal": "1",
19 "shipping": "2",
20 "tax": "3",
21 "discount": "0",
22 "total": "5",
23 "weight": "0",
24 "quantity": 2
25 },
26 "read": true,
27 "paymentStatus": "PAID",
28 "fulfillmentStatus": "FULFILLED"
29}