New eComm Order

Payload

The payload of this webhook request is an object.
orderIdstringOptional

The order ID. Will usually be 6 hex characters, but can also be 9 hex characters if the site has a very large number of Orders. Randomly assigned.

statusenumOptional

The status of the Order

commentstringOptional

A comment string for this Order, which is editable by API user (not used by Webflow).

orderCommentstringOptional

A comment that the customer left when making their Order

acceptedOndatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The ISO8601 timestamp that an Order was placed.

fulfilledOndatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

When an Order is marked as ‘fulfilled’, this field represents the timestamp of the fulfillment in ISO8601 format. Otherwise, it is null.

refundedOndatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

When an Order is marked as ‘refunded’, this field represents the timestamp of the fulfillment in ISO8601 format. Otherwise, it is null.

disputedOndatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

When an Order is marked as ‘disputed’, this field represents the timestamp of the fulfillment in ISO8601 format. Otherwise, it is null.

disputeUpdatedOndatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

If an Order has been disputed by the customer, this key will be set to the ISO8601 timestamp of the last update received. If the Order is not disputed, the key will be null.

disputeLastStatusenumOptional

If an order was disputed by the customer, then this key will be set with the dispute’s status.

customerPaidobjectOptional

The total paid by the customer

netAmountobjectOptional

The net amount after application fees

applicationFeeobjectOptional

The application fee assessed by the platform

allAddresseslist of objectsOptional

All addresses provided by the customer during the ordering flow.

shippingAddressobjectOptional

The shipping address

billingAddressobjectOptional

The billing address

shippingProviderstringOptional

A string editable by the API user to note the shipping provider used (not used by Webflow).

shippingTrackingstringOptional

A string editable by the API user to note the shipping tracking number for the order (not used by Webflow).

shippingTrackingURLstringOptional
customerInfoobjectOptional

An object with the keys fullName and email.

purchasedItemslist of objectsOptional

An array of all things that the Customer purchased.

purchasedItemsCountdoubleOptional

The sum of all ‘count’ fields in ‘purchasedItems’.

stripeDetailsobjectOptional

An object with various Stripe IDs, useful for linking into the stripe dashboard.

stripeCardobjectOptional

Details on the card used to fulfill this order, if this order was finalized with Stripe.

paypalDetailsobjectOptional
customDatalist of maps from strings to anyOptional

An array of additional inputs for custom order data gathering. Each object in the array represents an input with a name, and a textInput, textArea, or checkbox value.

metadataobjectOptional
isCustomerDeletedbooleanOptionalDefaults to false

A boolean indicating whether the customer has been deleted from the site.

isShippingRequiredbooleanOptionalDefaults to false

A boolean indicating whether the order contains one or more purchased items that require shipping.

hasDownloadsbooleanOptionalDefaults to false

A boolean indicating whether the order contains one or more purchased items that are downloadable.

paymentProcessorstringOptional

A string indicating the payment processor used for this order.

totalsobjectOptional

An object describing various pricing totals

downloadFileslist of objectsOptional

An array of downloadable file objects.

Response

200
any
Return a 200 status to indicate that the data was received successfully.
Payload
1{
2  "orderId": "fc7-128",
3  "status": "refunded",
4  "comment": "Customer requested gift wrapping and a personalized note saying: Happy Birthday, Ford! 🎉 Please ensure the item is packed with extra bubble wrap for safe transit.",
5  "orderComment": "Please gift wrap with a personal note saying \"Happy Birthday, Ford! 🎉",
6  "acceptedOn": "2024-03-29T21:29:21Z",
7  "fulfilledOn": "2024-03-29T21:29:21Z",
8  "refundedOn": "2024-04-08T18:25:04Z",
9  "disputedOn": "2024-03-29T21:29:21Z",
10  "disputeUpdatedOn": "2024-03-29T21:29:21Z",
11  "disputeLastStatus": "charge_refunded",
12  "customerPaid": {
13    "unit": "USD",
14    "value": "5892",
15    "string": " 118.73 USD"
16  },
17  "netAmount": {
18    "unit": "USD",
19    "value": "5892",
20    "string": " 112.62 USD"
21  },
22  "applicationFee": {
23    "unit": "USD",
24    "value": "5892",
25    "string": " 2.37 USD"
26  },
27  "allAddresses": [
28    {
29      "type": "billing",
30      "addressee": "Arthur Dent",
31      "line1": "20 W 34th St",
32      "line2": "Empire State Building",
33      "city": "New York",
34      "state": "New York",
35      "country": "US",
36      "postalCode": "10118"
37    },
38    {
39      "type": "shipping",
40      "addressee": "Arthur Dent",
41      "line1": "20 W 34th St",
42      "line2": "Empire State Building",
43      "city": "New York",
44      "state": "New York",
45      "country": "US",
46      "postalCode": "10118"
47    }
48  ],
49  "shippingAddress": {
50    "type": "shipping",
51    "japanType": "kanji",
52    "addressee": "Arthur Dent",
53    "line1": "20 W 34th St",
54    "line2": "Empire State Building",
55    "city": "New York",
56    "state": "New York",
57    "country": "US",
58    "postalCode": "10118"
59  },
60  "billingAddress": {
61    "type": "billing",
62    "addressee": "Arthur Dent",
63    "line1": "20 W 34th St",
64    "line2": "Empire State Building",
65    "city": "New York",
66    "state": "New York",
67    "country": "US",
68    "postalCode": "10118"
69  },
70  "shippingProvider": "Shipping Company, Co.",
71  "shippingTracking": "tr00000000001",
72  "shippingTrackingURL": "https://www.shippingcompany.com/tracking/tr00000000001",
73  "customerInfo": {
74    "fullName": "Arthur Dent",
75    "email": "arthur.dent@example.com"
76  },
77  "purchasedItems": [
78    {
79      "count": 1,
80      "rowTotal": {
81        "unit": "USD",
82        "value": "5892",
83        "string": " 55.61 USD"
84      },
85      "productId": "66072fb61b89448912e26791",
86      "productName": "Luxurious Fresh Ball",
87      "productSlug": "luxurious-fresh-ball",
88      "variantId": "66072fb71b89448912e2683f",
89      "variantName": "Luxurious Fresh Ball Generic: Bronze, Practical: Plastic",
90      "variantSlug": "luxurious-fresh-ball-generic-bronze-practical-plastic",
91      "variantSKU": "luxurious-fresh-ball-generic-bronze-practical-plastic",
92      "variantImage": {
93        "url": "https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2672c_image14.jpeg"
94      },
95      "variantPrice": {
96        "unit": "USD",
97        "value": "5892",
98        "string": " 55.61 USD"
99      },
100      "weight": 11,
101      "width": 82,
102      "height": 70,
103      "length": 9
104    },
105    {
106      "count": 1,
107      "rowTotal": {
108        "unit": "USD",
109        "value": "5892",
110        "string": " 53.44 USD"
111      },
112      "productId": "66072fb61b89448912e26799",
113      "productName": "Recycled Steel Gloves",
114      "productSlug": "recycled-steel-gloves",
115      "variantId": "66072fb91b89448912e26ab9",
116      "variantName": "Recycled Steel Gloves Electronic: Granite, Handcrafted: grey",
117      "variantSlug": "recycled-steel-gloves-electronic-granite-handcrafted-grey",
118      "variantSKU": "recycled-steel-gloves-electronic-granite-handcrafted-grey",
119      "variantImage": {
120        "url": "https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2671e_image2.jpeg"
121      },
122      "variantPrice": {
123        "unit": "USD",
124        "value": "5892",
125        "string": " 53.44 USD"
126      },
127      "weight": 38,
128      "width": 76,
129      "height": 85,
130      "length": 40
131    }
132  ],
133  "purchasedItemsCount": 2,
134  "stripeDetails": {
135    "paymentMethod": "pm_1OzmzBJYFi4lcbXWHKNdXU7j",
136    "paymentIntentId": "pi_3OzmzDJYFi4lcbXW1hTBW6ft",
137    "customerId": "cus_PpRsNHwWdUoRKR",
138    "chargeId": "ch_3OzmzDJYFi4lcbXW1ndkkrH2",
139    "refundId": "re_3OzmzDJYFi4lcbXW1kFAmlBk",
140    "refundReason": "fraudulent"
141  },
142  "stripeCard": {
143    "last4": "4242",
144    "brand": "Visa",
145    "ownerName": "Arthur Dent",
146    "expires": {
147      "year": 2024,
148      "month": 4
149    }
150  },
151  "customData": [
152    {
153      "key": "value"
154    }
155  ],
156  "metadata": {
157    "isBuyNow": false
158  },
159  "isCustomerDeleted": false,
160  "isShippingRequired": true,
161  "hasDownloads": false,
162  "paymentProcessor": "stripe",
163  "totals": {
164    "subtotal": {
165      "unit": "USD",
166      "value": "5892",
167      "string": " 109.05 USD"
168    },
169    "extras": [
170      {
171        "type": "tax",
172        "name": "State Taxes",
173        "description": "NY Taxes (4.00%)",
174        "price": {
175          "unit": "USD",
176          "value": "5892",
177          "string": " 4.36 USD"
178        }
179      },
180      {
181        "type": "tax",
182        "name": "City Taxes",
183        "description": "NEW YORK Taxes (4.88%)",
184        "price": {
185          "unit": "USD",
186          "value": "5892",
187          "string": " 5.32 USD"
188        }
189      },
190      {
191        "type": "shipping",
192        "name": "Flat",
193        "description": "",
194        "price": {
195          "unit": "USD",
196          "value": "5892",
197          "string": " 0.00 USD"
198        }
199      }
200    ],
201    "total": {
202      "unit": "USD",
203      "value": "5892",
204      "string": " 118.73 USD"
205    }
206  },
207  "downloadFiles": [
208    {
209      "id": "5e9a5eba75e0ac242e1b6f64",
210      "name": "New product guide",
211      "url": "https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa"
212    }
213  ]
214}
Updated eComm Order
Built with