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

Fulfillment 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
orderId

string

Order ID (auto generated upon order creation).

trackingInfo

object

Fulfillment tracking information.

dateCreated

string

Fulfillment creation date and time.

fulfillmentId

string

ID of the newly created fulfillment.

buyerInfo

object

Buyer information.

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": "8234d6e7-d92f-4c0d-b973-8fadec29fa47",
4 "fulfillmentId": "ca4abdc6-ac46-430a-8db9-9c866fa11a50",
5 "dateCreated": "2019-12-10T15:03:30.800Z",
6 "buyerInfo": {
7 "id": "aa3159c6-5d5c-4b1c-bcf1-6b0d9e5a3897",
8 "type": "CONTACT",
9 "identityType": "CONTACT",
10 "firstName": "John",
11 "lastName": "Israeli",
12 "phone": "0123456789",
13 "email": "John.Israeli123@hotmail.com"
14 },
15 "fulfillmentStatus": "FULFILLED",
16 "trackingInfo": {
17 "trackingNumber": "1234-5678-9101-1121-3141-51",
18 "shippingProvider": "usps",
19 "trackingLink": "https://tools.usps.com/go/TrackConfirmAction.action?tLabels=1234-5678-9101-1121-3141-51"
20 }
21}