For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Resources
Get started
ReferenceGuidesExamplesChangelog
ReferenceGuidesExamplesChangelog
  • Data API
    • Introduction
  • Token
    • GETGet Authorization User Info
    • GETGet Authorization Info
  • Sites
    • GETList Sites
    • GETGet Site
    • GETGet Custom Domains
    • POSTPublish Site
  • Pages and Components
  • CMS
  • Forms
  • Custom Code
  • Assets
  • Comments
    • GETList Comment Threads
    • GETGet Comment Thread
    • GETList Comment Replies
  • Ecommerce
  • Webhooks
    • GETList Webhooks
    • GETGet Webhook
    • POSTCreate Webhook
    • DELRemove Webhook
      • All Events
      • POSTForm Submission
      • POSTSite Publish
      • POSTPage Created
      • POSTPage Metadata Updated
      • POSTPage Deleted
      • POSTCollection Item Created
      • POSTCollection Item Updated
      • POSTCollection Item Deleted
      • POSTCollection Item Published
      • POSTCollection Item Unpublished
      • POSTNew eComm Order
      • POSTUpdated eComm Order
      • POSTUpdated eComm Inventory
      • POSTNew Comment Thread
  • Site Configuration
  • Enterprise
LogoLogo
Resources
Get started
WebhooksEvents

Updated eComm Order

Payload
1{
2  "triggerType": "ecomm_order_changed",
3  "payload": {
4    "status": "refunded",
5    "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.",
6    "orderComment": "Please gift wrap with a personal note saying \"Happy Birthday, Ford! 🎉",
7    "acceptedOn": "2024-03-29T21:29:21.555Z",
8    "fulfilledOn": "2024-03-29T21:29:21.555Z",
9    "refundedOn": "2024-04-08T18:25:04.238Z",
10    "disputedOn": "2024-03-29T21:29:21.555Z",
11    "disputeUpdatedOn": "2024-03-29T21:29:21.555Z",
12    "disputeLastStatus": "charge_refunded",
13    "customerPaid": {
14      "unit": "USD",
15      "value": "11873",
16      "string": "$ 118.73 USD"
17    },
18    "netAmount": {
19      "unit": "USD",
20      "value": "11262",
21      "string": "$ 112.62 USD"
22    },
23    "applicationFee": {
24      "unit": "USD",
25      "value": "237",
26      "string": "$ 2.37 USD"
27    },
28    "allAddresses": [
29      {
30        "type": "billing",
31        "addressee": "Arthur Dent",
32        "line1": "20 W 34th St",
33        "line2": "Empire State Building",
34        "city": "New York",
35        "state": "New York",
36        "country": "US",
37        "postalCode": "10118"
38      },
39      {
40        "type": "shipping",
41        "addressee": "Arthur Dent",
42        "line1": "20 W 34th St",
43        "line2": "Empire State Building",
44        "city": "New York",
45        "state": "New York",
46        "country": "US",
47        "postalCode": "10118"
48      }
49    ],
50    "shippingAddress": {
51      "type": "shipping",
52      "japanType": "kanji",
53      "addressee": "Arthur Dent",
54      "line1": "20 W 34th St",
55      "line2": "Empire State Building",
56      "city": "New York",
57      "state": "New York",
58      "country": "US",
59      "postalCode": "10118"
60    },
61    "billingAddress": {
62      "type": "billing",
63      "addressee": "Arthur Dent",
64      "line1": "20 W 34th St",
65      "line2": "Empire State Building",
66      "city": "New York",
67      "state": "New York",
68      "country": "US",
69      "postalCode": "10118"
70    },
71    "shippingProvider": "Shipping Company, Co.",
72    "shippingTracking": "tr00000000001",
73    "shippingTrackingURL": "https://www.shippingcompany.com/tracking/tr00000000001",
74    "customerInfo": {
75      "fullName": "Arthur Dent",
76      "email": "arthur.dent@example.com"
77    },
78    "purchasedItems": [
79      {
80        "count": 1,
81        "rowTotal": {
82          "unit": "USD",
83          "value": "5561",
84          "string": "$ 55.61 USD"
85        },
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://dev-assets.website-files.com/66072f39417a2a35b2589cc7/66072fb51b89448912e2672c_image14.jpeg"
94        },
95        "variantPrice": {
96          "unit": "USD",
97          "value": "5561",
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": "5344",
110          "string": "$ 53.44 USD"
111        },
112        "productName": "Recycled Steel Gloves",
113        "productSlug": "recycled-steel-gloves",
114        "variantId": "66072fb91b89448912e26ab9",
115        "variantName": "Recycled Steel Gloves Electronic: Granite, Handcrafted: grey",
116        "variantSlug": "recycled-steel-gloves-electronic-granite-handcrafted-grey",
117        "variantSKU": "recycled-steel-gloves-electronic-granite-handcrafted-grey",
118        "variantImage": {
119          "url": "https://dev-assets.website-files.com/66072f39417a2a35b2589cc7/66072fb51b89448912e2671e_image2.jpeg"
120        },
121        "variantPrice": {
122          "unit": "USD",
123          "value": "5344",
124          "string": "$ 53.44 USD"
125        },
126        "weight": 38,
127        "width": 76,
128        "height": 85,
129        "length": 40
130      }
131    ],
132    "purchasedItemsCount": 2,
133    "stripeDetails": {
134      "paymentMethod": "pm_1OzmzBJYFi4lcbXWHKNdXU7j",
135      "paymentIntentId": "pi_3OzmzDJYFi4lcbXW1hTBW6ft",
136      "customerId": "cus_PpRsNHwWdUoRKR",
137      "chargeId": "ch_3OzmzDJYFi4lcbXW1ndkkrH2",
138      "refundId": "re_3OzmzDJYFi4lcbXW1kFAmlBk",
139      "refundReason": "fraudulent"
140    },
141    "stripeCard": {
142      "last4": "4242",
143      "brand": "Visa",
144      "ownerName": "Arthur Dent",
145      "expires": {
146        "year": 2024,
147        "month": 4
148      }
149    },
150    "customData": [
151      {}
152    ],
153    "metadata": {
154      "isBuyNow": false,
155      "hasDownloads": false,
156      "paymentProcessor": "stripe"
157    },
158    "isCustomerDeleted": false,
159    "isShippingRequired": true,
160    "totals": {
161      "subtotal": {
162        "unit": "USD",
163        "value": "10905",
164        "string": "$ 109.05 USD"
165      },
166      "extras": [
167        {
168          "type": "tax",
169          "name": "State Taxes",
170          "description": "NY Taxes (4.00%)",
171          "price": {
172            "unit": "USD",
173            "value": "436",
174            "string": "$ 4.36 USD"
175          }
176        },
177        {
178          "type": "tax",
179          "name": "City Taxes",
180          "description": "NEW YORK Taxes (4.88%)",
181          "price": {
182            "unit": "USD",
183            "value": "532",
184            "string": "$ 5.32 USD"
185          }
186        },
187        {
188          "type": "shipping",
189          "name": "Flat",
190          "description": "",
191          "price": {
192            "unit": "USD",
193            "value": "0",
194            "string": "$ 0.00 USD"
195          }
196        }
197      ],
198      "total": {
199        "unit": "USD",
200        "value": "11873",
201        "string": "$ 118.73 USD"
202      }
203    },
204    "downloadFiles": [
205      {
206        "id": "5e9a5eba75e0ac242e1b6f64",
207        "name": "New product guide",
208        "url": "https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa"
209      }
210    ]
211  }
212}
Information about an updated ecommerce order
Was this page helpful?
Previous

Updated eComm Inventory

Next
Built with

Payload

The payload of this webhook request is an object.
triggerTypestringOptional
The type of event that triggered the request
payloadobjectOptional

Response

200
any
Return a 200 status to indicate that the data was received successfully.