webflow-api 3.3.0-beta → 3.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (563) hide show
  1. package/BaseClient.d.ts +1 -1
  2. package/Client.d.ts +1 -7
  3. package/Client.js +31 -41
  4. package/LICENSE +18 -18
  5. package/README.md +55 -28
  6. package/api/resources/assets/client/Client.d.ts +4 -4
  7. package/api/resources/assets/client/Client.js +7 -8
  8. package/api/resources/assets/client/requests/AssetsListRequest.d.ts +2 -2
  9. package/api/resources/collections/client/Client.d.ts +2 -2
  10. package/api/resources/collections/client/Client.js +3 -6
  11. package/api/resources/collections/resources/fields/client/Client.d.ts +2 -2
  12. package/api/resources/collections/resources/fields/client/Client.js +4 -6
  13. package/api/resources/collections/resources/items/client/Client.d.ts +6 -6
  14. package/api/resources/collections/resources/items/client/Client.js +24 -12
  15. package/api/resources/collections/resources/items/client/requests/ItemsListItemsLiveRequest.d.ts +2 -2
  16. package/api/resources/collections/resources/items/client/requests/ItemsListItemsRequest.d.ts +2 -2
  17. package/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +1 -1
  18. package/{dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts → api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataOneItem.d.ts} +1 -1
  19. package/api/resources/collections/resources/items/types/index.d.ts +1 -1
  20. package/api/resources/collections/resources/items/types/index.js +1 -1
  21. package/api/resources/components/client/Client.d.ts +8 -8
  22. package/api/resources/components/client/Client.js +10 -12
  23. package/api/resources/components/client/requests/ComponentsGetContentRequest.d.ts +2 -2
  24. package/api/resources/components/client/requests/ComponentsGetPropertiesRequest.d.ts +2 -2
  25. package/api/resources/components/client/requests/ComponentsListRequest.d.ts +2 -2
  26. package/api/resources/ecommerce/client/Client.d.ts +2 -2
  27. package/api/resources/ecommerce/client/Client.js +2 -6
  28. package/api/resources/forms/client/Client.d.ts +6 -6
  29. package/api/resources/forms/client/Client.js +7 -10
  30. package/api/resources/forms/client/requests/FormsListRequest.d.ts +2 -2
  31. package/api/resources/forms/client/requests/FormsListSubmissionsRequest.d.ts +2 -2
  32. package/api/resources/index.d.ts +0 -6
  33. package/api/resources/index.js +1 -7
  34. package/api/resources/inventory/client/Client.d.ts +2 -2
  35. package/api/resources/inventory/client/Client.js +3 -6
  36. package/api/resources/orders/client/Client.d.ts +4 -4
  37. package/api/resources/orders/client/Client.js +8 -8
  38. package/api/resources/orders/client/requests/OrdersListRequest.d.ts +2 -2
  39. package/api/resources/pages/client/Client.d.ts +6 -6
  40. package/api/resources/pages/client/Client.js +8 -10
  41. package/api/resources/pages/client/requests/PagesGetContentRequest.d.ts +2 -2
  42. package/api/resources/pages/client/requests/PagesListRequest.d.ts +2 -2
  43. package/api/resources/pages/resources/scripts/client/Client.d.ts +2 -2
  44. package/api/resources/pages/resources/scripts/client/Client.js +3 -6
  45. package/api/resources/products/client/Client.d.ts +4 -4
  46. package/api/resources/products/client/Client.js +8 -8
  47. package/api/resources/products/client/requests/ProductsListRequest.d.ts +2 -2
  48. package/api/resources/scripts/client/Client.d.ts +2 -2
  49. package/api/resources/scripts/client/Client.js +4 -6
  50. package/api/resources/sites/client/Client.d.ts +2 -2
  51. package/api/resources/sites/client/Client.js +5 -6
  52. package/api/resources/sites/resources/activityLogs/client/Client.d.ts +4 -4
  53. package/api/resources/sites/resources/activityLogs/client/Client.js +4 -8
  54. package/api/resources/sites/resources/activityLogs/client/requests/ActivityLogsListRequest.d.ts +2 -2
  55. package/api/resources/sites/resources/comments/client/Client.d.ts +8 -8
  56. package/api/resources/sites/resources/comments/client/Client.js +14 -12
  57. package/api/resources/sites/resources/comments/client/requests/CommentsGetCommentThreadRequest.d.ts +2 -2
  58. package/api/resources/sites/resources/comments/client/requests/CommentsListCommentRepliesRequest.d.ts +2 -2
  59. package/api/resources/sites/resources/comments/client/requests/CommentsListCommentThreadsRequest.d.ts +2 -2
  60. package/api/resources/sites/resources/forms/client/Client.d.ts +6 -6
  61. package/api/resources/sites/resources/forms/client/Client.js +7 -10
  62. package/api/resources/sites/resources/forms/client/requests/FormsListSubmissionsBySiteRequest.d.ts +2 -2
  63. package/api/resources/sites/resources/forms/client/requests/FormsListSubmissionsRequest.d.ts +2 -2
  64. package/api/resources/sites/resources/plans/client/Client.d.ts +2 -2
  65. package/api/resources/sites/resources/plans/client/Client.js +2 -6
  66. package/api/resources/sites/resources/redirects/client/Client.d.ts +4 -4
  67. package/api/resources/sites/resources/redirects/client/Client.js +6 -8
  68. package/api/resources/sites/resources/robotsTxt/client/Client.d.ts +2 -2
  69. package/api/resources/sites/resources/robotsTxt/client/Client.js +5 -6
  70. package/api/resources/sites/resources/scripts/client/Client.d.ts +4 -4
  71. package/api/resources/sites/resources/scripts/client/Client.js +5 -8
  72. package/api/resources/sites/resources/scripts/client/requests/ScriptsListCustomCodeBlocksRequest.d.ts +2 -2
  73. package/api/resources/sites/resources/wellKnown/client/Client.d.ts +2 -2
  74. package/api/resources/sites/resources/wellKnown/client/Client.js +4 -6
  75. package/api/resources/token/client/Client.d.ts +2 -2
  76. package/api/resources/token/client/Client.js +2 -6
  77. package/api/resources/webhooks/client/Client.d.ts +2 -2
  78. package/api/resources/webhooks/client/Client.js +3 -6
  79. package/api/resources/workspaces/client/Client.d.ts +1 -1
  80. package/api/resources/workspaces/client/Client.js +1 -1
  81. package/api/resources/workspaces/resources/auditLogs/client/Client.d.ts +4 -4
  82. package/api/resources/workspaces/resources/auditLogs/client/Client.js +6 -8
  83. package/api/resources/workspaces/resources/auditLogs/client/requests/AuditLogsGetWorkspaceAuditLogsRequest.d.ts +2 -2
  84. package/api/resources/workspaces/resources/auditLogs/types/AuditLogsGetWorkspaceAuditLogsRequestEventType.d.ts +1 -0
  85. package/api/resources/workspaces/resources/auditLogs/types/AuditLogsGetWorkspaceAuditLogsRequestEventType.js +1 -0
  86. package/api/types/AssetVariant.d.ts +6 -6
  87. package/api/types/ComponentDom.d.ts +1 -1
  88. package/api/types/ForbiddenErrorBody.d.ts +1 -1
  89. package/api/types/ProductFieldData.d.ts +1 -1
  90. package/api/types/SettingChange.d.ts +7 -0
  91. package/api/types/SettingChangeAuditLogItem.d.ts +5 -0
  92. package/api/types/TriggerType.d.ts +0 -3
  93. package/api/types/TriggerType.js +0 -3
  94. package/api/types/WorkspaceAuditLogItem.d.ts +4 -1
  95. package/api/types/WorkspaceAuditLogItemPayloadSettingChangeMethod.d.ts +5 -0
  96. package/api/types/WorkspaceAuditLogItemPayloadSettingChangeMethod.js +8 -0
  97. package/api/types/index.d.ts +3 -13
  98. package/api/types/index.js +3 -13
  99. package/dist/BaseClient.d.ts +1 -1
  100. package/dist/Client.d.ts +1 -7
  101. package/dist/Client.js +31 -41
  102. package/dist/api/resources/assets/client/Client.d.ts +4 -4
  103. package/dist/api/resources/assets/client/Client.js +7 -8
  104. package/dist/api/resources/assets/client/requests/AssetsListRequest.d.ts +2 -2
  105. package/dist/api/resources/collections/client/Client.d.ts +2 -2
  106. package/dist/api/resources/collections/client/Client.js +3 -6
  107. package/dist/api/resources/collections/resources/fields/client/Client.d.ts +2 -2
  108. package/dist/api/resources/collections/resources/fields/client/Client.js +4 -6
  109. package/dist/api/resources/collections/resources/items/client/Client.d.ts +6 -6
  110. package/dist/api/resources/collections/resources/items/client/Client.js +24 -12
  111. package/dist/api/resources/collections/resources/items/client/requests/ItemsListItemsLiveRequest.d.ts +2 -2
  112. package/dist/api/resources/collections/resources/items/client/requests/ItemsListItemsRequest.d.ts +2 -2
  113. package/dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +1 -1
  114. package/{api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts → dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataOneItem.d.ts} +1 -1
  115. package/dist/api/resources/collections/resources/items/types/index.d.ts +1 -1
  116. package/dist/api/resources/collections/resources/items/types/index.js +1 -1
  117. package/dist/api/resources/components/client/Client.d.ts +8 -8
  118. package/dist/api/resources/components/client/Client.js +10 -12
  119. package/dist/api/resources/components/client/requests/ComponentsGetContentRequest.d.ts +2 -2
  120. package/dist/api/resources/components/client/requests/ComponentsGetPropertiesRequest.d.ts +2 -2
  121. package/dist/api/resources/components/client/requests/ComponentsListRequest.d.ts +2 -2
  122. package/dist/api/resources/ecommerce/client/Client.d.ts +2 -2
  123. package/dist/api/resources/ecommerce/client/Client.js +2 -6
  124. package/dist/api/resources/forms/client/Client.d.ts +6 -6
  125. package/dist/api/resources/forms/client/Client.js +7 -10
  126. package/dist/api/resources/forms/client/requests/FormsListRequest.d.ts +2 -2
  127. package/dist/api/resources/forms/client/requests/FormsListSubmissionsRequest.d.ts +2 -2
  128. package/dist/api/resources/index.d.ts +0 -6
  129. package/dist/api/resources/index.js +1 -7
  130. package/dist/api/resources/inventory/client/Client.d.ts +2 -2
  131. package/dist/api/resources/inventory/client/Client.js +3 -6
  132. package/dist/api/resources/orders/client/Client.d.ts +4 -4
  133. package/dist/api/resources/orders/client/Client.js +8 -8
  134. package/dist/api/resources/orders/client/requests/OrdersListRequest.d.ts +2 -2
  135. package/dist/api/resources/pages/client/Client.d.ts +6 -6
  136. package/dist/api/resources/pages/client/Client.js +8 -10
  137. package/dist/api/resources/pages/client/requests/PagesGetContentRequest.d.ts +2 -2
  138. package/dist/api/resources/pages/client/requests/PagesListRequest.d.ts +2 -2
  139. package/dist/api/resources/pages/resources/scripts/client/Client.d.ts +2 -2
  140. package/dist/api/resources/pages/resources/scripts/client/Client.js +3 -6
  141. package/dist/api/resources/products/client/Client.d.ts +4 -4
  142. package/dist/api/resources/products/client/Client.js +8 -8
  143. package/dist/api/resources/products/client/requests/ProductsListRequest.d.ts +2 -2
  144. package/dist/api/resources/scripts/client/Client.d.ts +2 -2
  145. package/dist/api/resources/scripts/client/Client.js +4 -6
  146. package/dist/api/resources/sites/client/Client.d.ts +2 -2
  147. package/dist/api/resources/sites/client/Client.js +5 -6
  148. package/dist/api/resources/sites/resources/activityLogs/client/Client.d.ts +4 -4
  149. package/dist/api/resources/sites/resources/activityLogs/client/Client.js +4 -8
  150. package/dist/api/resources/sites/resources/activityLogs/client/requests/ActivityLogsListRequest.d.ts +2 -2
  151. package/dist/api/resources/sites/resources/comments/client/Client.d.ts +8 -8
  152. package/dist/api/resources/sites/resources/comments/client/Client.js +14 -12
  153. package/dist/api/resources/sites/resources/comments/client/requests/CommentsGetCommentThreadRequest.d.ts +2 -2
  154. package/dist/api/resources/sites/resources/comments/client/requests/CommentsListCommentRepliesRequest.d.ts +2 -2
  155. package/dist/api/resources/sites/resources/comments/client/requests/CommentsListCommentThreadsRequest.d.ts +2 -2
  156. package/dist/api/resources/sites/resources/forms/client/Client.d.ts +6 -6
  157. package/dist/api/resources/sites/resources/forms/client/Client.js +7 -10
  158. package/dist/api/resources/sites/resources/forms/client/requests/FormsListSubmissionsBySiteRequest.d.ts +2 -2
  159. package/dist/api/resources/sites/resources/forms/client/requests/FormsListSubmissionsRequest.d.ts +2 -2
  160. package/dist/api/resources/sites/resources/plans/client/Client.d.ts +2 -2
  161. package/dist/api/resources/sites/resources/plans/client/Client.js +2 -6
  162. package/dist/api/resources/sites/resources/redirects/client/Client.d.ts +4 -4
  163. package/dist/api/resources/sites/resources/redirects/client/Client.js +6 -8
  164. package/dist/api/resources/sites/resources/robotsTxt/client/Client.d.ts +2 -2
  165. package/dist/api/resources/sites/resources/robotsTxt/client/Client.js +5 -6
  166. package/dist/api/resources/sites/resources/scripts/client/Client.d.ts +4 -4
  167. package/dist/api/resources/sites/resources/scripts/client/Client.js +5 -8
  168. package/dist/api/resources/sites/resources/scripts/client/requests/ScriptsListCustomCodeBlocksRequest.d.ts +2 -2
  169. package/dist/api/resources/sites/resources/wellKnown/client/Client.d.ts +2 -2
  170. package/dist/api/resources/sites/resources/wellKnown/client/Client.js +4 -6
  171. package/dist/api/resources/token/client/Client.d.ts +2 -2
  172. package/dist/api/resources/token/client/Client.js +2 -6
  173. package/dist/api/resources/webhooks/client/Client.d.ts +2 -2
  174. package/dist/api/resources/webhooks/client/Client.js +3 -6
  175. package/dist/api/resources/workspaces/client/Client.d.ts +1 -1
  176. package/dist/api/resources/workspaces/client/Client.js +1 -1
  177. package/dist/api/resources/workspaces/resources/auditLogs/client/Client.d.ts +4 -4
  178. package/dist/api/resources/workspaces/resources/auditLogs/client/Client.js +6 -8
  179. package/dist/api/resources/workspaces/resources/auditLogs/client/requests/AuditLogsGetWorkspaceAuditLogsRequest.d.ts +2 -2
  180. package/dist/api/resources/workspaces/resources/auditLogs/types/AuditLogsGetWorkspaceAuditLogsRequestEventType.d.ts +1 -0
  181. package/dist/api/resources/workspaces/resources/auditLogs/types/AuditLogsGetWorkspaceAuditLogsRequestEventType.js +1 -0
  182. package/dist/api/types/AssetVariant.d.ts +6 -6
  183. package/dist/api/types/ComponentDom.d.ts +1 -1
  184. package/dist/api/types/ForbiddenErrorBody.d.ts +1 -1
  185. package/dist/api/types/ProductFieldData.d.ts +1 -1
  186. package/dist/api/types/SettingChange.d.ts +7 -0
  187. package/dist/api/types/SettingChangeAuditLogItem.d.ts +5 -0
  188. package/dist/api/types/TriggerType.d.ts +0 -3
  189. package/dist/api/types/TriggerType.js +0 -3
  190. package/dist/api/types/WorkspaceAuditLogItem.d.ts +4 -1
  191. package/dist/api/types/WorkspaceAuditLogItemPayloadSettingChangeMethod.d.ts +5 -0
  192. package/dist/api/types/WorkspaceAuditLogItemPayloadSettingChangeMethod.js +8 -0
  193. package/dist/api/types/index.d.ts +3 -13
  194. package/dist/api/types/index.js +3 -13
  195. package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +2 -2
  196. package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.js +2 -2
  197. package/{serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts → dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataOneItem.d.ts} +2 -2
  198. package/{serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.js → dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataOneItem.js} +2 -2
  199. package/dist/serialization/resources/collections/resources/items/types/index.d.ts +1 -1
  200. package/dist/serialization/resources/collections/resources/items/types/index.js +1 -1
  201. package/dist/serialization/resources/index.d.ts +0 -5
  202. package/dist/serialization/resources/index.js +1 -6
  203. package/dist/serialization/resources/workspaces/resources/auditLogs/types/AuditLogsGetWorkspaceAuditLogsRequestEventType.d.ts +1 -1
  204. package/dist/serialization/resources/workspaces/resources/auditLogs/types/AuditLogsGetWorkspaceAuditLogsRequestEventType.js +1 -0
  205. package/dist/serialization/types/AssetVariant.d.ts +6 -6
  206. package/dist/serialization/types/AssetVariant.js +6 -6
  207. package/dist/serialization/types/ForbiddenErrorBody.d.ts +2 -2
  208. package/dist/serialization/types/ForbiddenErrorBody.js +2 -2
  209. package/dist/serialization/types/SettingChange.d.ts +13 -0
  210. package/dist/serialization/types/{AccessGroup.js → SettingChange.js} +7 -7
  211. package/dist/serialization/types/SettingChangeAuditLogItem.d.ts +11 -0
  212. package/dist/serialization/types/{UserAccessGroupsItem.js → SettingChangeAuditLogItem.js} +5 -5
  213. package/dist/serialization/types/TriggerType.d.ts +1 -1
  214. package/dist/serialization/types/TriggerType.js +0 -3
  215. package/dist/serialization/types/WorkspaceAuditLogItem.d.ts +5 -1
  216. package/dist/serialization/types/WorkspaceAuditLogItem.js +2 -0
  217. package/dist/serialization/types/WorkspaceAuditLogItemPayloadSettingChangeMethod.d.ts +7 -0
  218. package/dist/serialization/types/{UserStatus.js → WorkspaceAuditLogItemPayloadSettingChangeMethod.js} +2 -2
  219. package/dist/serialization/types/index.d.ts +3 -13
  220. package/dist/serialization/types/index.js +3 -13
  221. package/dist/version.d.ts +1 -1
  222. package/dist/version.js +1 -1
  223. package/dist/wrapper/AssetsUtilitiesClient.d.ts +1 -1
  224. package/dist/wrapper/FormsClient.js +5 -5
  225. package/dist/wrapper/ItemsClient.js +20 -20
  226. package/dist/wrapper/PagesClient.js +5 -5
  227. package/dist/wrapper/WebflowClient.js +1 -1
  228. package/jest.config.mjs +1 -1
  229. package/package.json +2 -1
  230. package/reference.md +68 -544
  231. package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +2 -2
  232. package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.js +2 -2
  233. package/{dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts → serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataOneItem.d.ts} +2 -2
  234. package/{dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.js → serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataOneItem.js} +2 -2
  235. package/serialization/resources/collections/resources/items/types/index.d.ts +1 -1
  236. package/serialization/resources/collections/resources/items/types/index.js +1 -1
  237. package/serialization/resources/index.d.ts +0 -5
  238. package/serialization/resources/index.js +1 -6
  239. package/serialization/resources/workspaces/resources/auditLogs/types/AuditLogsGetWorkspaceAuditLogsRequestEventType.d.ts +1 -1
  240. package/serialization/resources/workspaces/resources/auditLogs/types/AuditLogsGetWorkspaceAuditLogsRequestEventType.js +1 -0
  241. package/serialization/types/AssetVariant.d.ts +6 -6
  242. package/serialization/types/AssetVariant.js +6 -6
  243. package/serialization/types/ForbiddenErrorBody.d.ts +2 -2
  244. package/serialization/types/ForbiddenErrorBody.js +2 -2
  245. package/serialization/types/SettingChange.d.ts +13 -0
  246. package/{dist/serialization/types/AccessGroupList.js → serialization/types/SettingChange.js} +7 -8
  247. package/serialization/types/SettingChangeAuditLogItem.d.ts +11 -0
  248. package/serialization/types/{UserAccessGroupsItem.js → SettingChangeAuditLogItem.js} +5 -5
  249. package/serialization/types/TriggerType.d.ts +1 -1
  250. package/serialization/types/TriggerType.js +0 -3
  251. package/serialization/types/WorkspaceAuditLogItem.d.ts +5 -1
  252. package/serialization/types/WorkspaceAuditLogItem.js +2 -0
  253. package/serialization/types/WorkspaceAuditLogItemPayloadSettingChangeMethod.d.ts +7 -0
  254. package/{dist/serialization/types/UserLimitReached.js → serialization/types/WorkspaceAuditLogItemPayloadSettingChangeMethod.js} +2 -2
  255. package/serialization/types/index.d.ts +3 -13
  256. package/serialization/types/index.js +3 -13
  257. package/version.d.ts +1 -1
  258. package/version.js +1 -1
  259. package/wrapper/AssetsUtilitiesClient.d.ts +1 -1
  260. package/wrapper/FormsClient.js +5 -5
  261. package/wrapper/ItemsClient.js +20 -20
  262. package/wrapper/PagesClient.js +5 -5
  263. package/wrapper/WebflowClient.js +1 -1
  264. package/.mock/definition/__package__.yml +0 -4471
  265. package/.mock/definition/accessGroups.yml +0 -87
  266. package/.mock/definition/api.yml +0 -18
  267. package/.mock/definition/assets.yml +0 -487
  268. package/.mock/definition/collections/fields.yml +0 -212
  269. package/.mock/definition/collections/items.yml +0 -2145
  270. package/.mock/definition/collections.yml +0 -350
  271. package/.mock/definition/comments.yml +0 -41
  272. package/.mock/definition/components.yml +0 -548
  273. package/.mock/definition/ecommerce.yml +0 -45
  274. package/.mock/definition/forms.yml +0 -399
  275. package/.mock/definition/inventory.yml +0 -152
  276. package/.mock/definition/items.yml +0 -112
  277. package/.mock/definition/orders.yml +0 -1971
  278. package/.mock/definition/pages/scripts.yml +0 -155
  279. package/.mock/definition/pages.yml +0 -611
  280. package/.mock/definition/products.yml +0 -642
  281. package/.mock/definition/scripts.yml +0 -236
  282. package/.mock/definition/sites/activityLogs.yml +0 -77
  283. package/.mock/definition/sites/comments.yml +0 -352
  284. package/.mock/definition/sites/forms.yml +0 -316
  285. package/.mock/definition/sites/plans.yml +0 -48
  286. package/.mock/definition/sites/redirects.yml +0 -221
  287. package/.mock/definition/sites/robotsTxt.yml +0 -229
  288. package/.mock/definition/sites/scripts.yml +0 -243
  289. package/.mock/definition/sites/wellKnown.yml +0 -130
  290. package/.mock/definition/sites.yml +0 -558
  291. package/.mock/definition/token.yml +0 -75
  292. package/.mock/definition/users.yml +0 -594
  293. package/.mock/definition/webhooks.yml +0 -188
  294. package/.mock/definition/workspaces/auditLogs.yml +0 -125
  295. package/.mock/fern.config.json +0 -4
  296. package/api/resources/accessGroups/client/Client.d.ts +0 -39
  297. package/api/resources/accessGroups/client/Client.js +0 -197
  298. package/api/resources/accessGroups/client/index.d.ts +0 -1
  299. package/api/resources/accessGroups/client/index.js +0 -17
  300. package/api/resources/accessGroups/client/requests/AccessGroupsListRequest.d.ts +0 -20
  301. package/api/resources/accessGroups/client/requests/index.d.ts +0 -1
  302. package/api/resources/accessGroups/client/requests/index.js +0 -2
  303. package/api/resources/accessGroups/index.d.ts +0 -2
  304. package/api/resources/accessGroups/index.js +0 -18
  305. package/api/resources/accessGroups/types/AccessGroupsListRequestSort.d.ts +0 -9
  306. package/api/resources/accessGroups/types/AccessGroupsListRequestSort.js +0 -12
  307. package/api/resources/accessGroups/types/index.d.ts +0 -1
  308. package/api/resources/accessGroups/types/index.js +0 -17
  309. package/api/resources/users/client/Client.d.ts +0 -145
  310. package/api/resources/users/client/Client.js +0 -670
  311. package/api/resources/users/client/index.d.ts +0 -1
  312. package/api/resources/users/client/index.js +0 -17
  313. package/api/resources/users/client/requests/UsersInviteRequest.d.ts +0 -13
  314. package/api/resources/users/client/requests/UsersListRequest.d.ts +0 -23
  315. package/api/resources/users/client/requests/index.d.ts +0 -2
  316. package/api/resources/users/client/requests/index.js +0 -2
  317. package/api/resources/users/index.d.ts +0 -2
  318. package/api/resources/users/index.js +0 -18
  319. package/api/resources/users/types/UserAccountAddedPayload.d.ts +0 -5
  320. package/api/resources/users/types/UserAccountAddedPayloadPayload.d.ts +0 -20
  321. package/api/resources/users/types/UserAccountAddedPayloadPayloadData.d.ts +0 -9
  322. package/api/resources/users/types/UserAccountAddedPayloadPayloadData.js +0 -3
  323. package/api/resources/users/types/UserAccountDeletedPayload.d.ts +0 -5
  324. package/api/resources/users/types/UserAccountDeletedPayload.js +0 -3
  325. package/api/resources/users/types/UserAccountDeletedPayloadPayload.d.ts +0 -20
  326. package/api/resources/users/types/UserAccountDeletedPayloadPayload.js +0 -3
  327. package/api/resources/users/types/UserAccountDeletedPayloadPayloadData.d.ts +0 -9
  328. package/api/resources/users/types/UserAccountDeletedPayloadPayloadData.js +0 -3
  329. package/api/resources/users/types/UserAccountUpdatedPayload.d.ts +0 -5
  330. package/api/resources/users/types/UserAccountUpdatedPayload.js +0 -3
  331. package/api/resources/users/types/UserAccountUpdatedPayloadPayload.d.ts +0 -20
  332. package/api/resources/users/types/UserAccountUpdatedPayloadPayload.js +0 -3
  333. package/api/resources/users/types/UserAccountUpdatedPayloadPayloadData.d.ts +0 -9
  334. package/api/resources/users/types/UserAccountUpdatedPayloadPayloadData.js +0 -3
  335. package/api/resources/users/types/UsersListRequestSort.d.ts +0 -33
  336. package/api/resources/users/types/UsersListRequestSort.js +0 -36
  337. package/api/resources/users/types/index.d.ts +0 -10
  338. package/api/resources/users/types/index.js +0 -26
  339. package/api/types/AccessGroup.d.ts +0 -12
  340. package/api/types/AccessGroup.js +0 -3
  341. package/api/types/AccessGroupList.d.ts +0 -16
  342. package/api/types/AccessGroupList.js +0 -3
  343. package/api/types/ConflictErrorBody.d.ts +0 -2
  344. package/api/types/ConflictErrorBody.js +0 -3
  345. package/api/types/DuplicateUserEmail.d.ts +0 -1
  346. package/api/types/DuplicateUserEmail.js +0 -3
  347. package/api/types/User.d.ts +0 -22
  348. package/api/types/User.js +0 -3
  349. package/api/types/UserAccessGroupsItem.d.ts +0 -14
  350. package/api/types/UserAccessGroupsItem.js +0 -3
  351. package/api/types/UserAccessGroupsItemType.d.ts +0 -10
  352. package/api/types/UserAccessGroupsItemType.js +0 -13
  353. package/api/types/UserData.d.ts +0 -7
  354. package/api/types/UserData.js +0 -3
  355. package/api/types/UserDataData.d.ts +0 -12
  356. package/api/types/UserDataData.js +0 -3
  357. package/api/types/UserLimitReached.d.ts +0 -1
  358. package/api/types/UserLimitReached.js +0 -3
  359. package/api/types/UserList.d.ts +0 -16
  360. package/api/types/UserList.js +0 -3
  361. package/api/types/UserStatus.d.ts +0 -7
  362. package/api/types/UserStatus.js +0 -10
  363. package/api/types/UsersNotEnabled.d.ts +0 -1
  364. package/api/types/UsersNotEnabled.js +0 -3
  365. package/dist/api/resources/accessGroups/client/Client.d.ts +0 -39
  366. package/dist/api/resources/accessGroups/client/Client.js +0 -197
  367. package/dist/api/resources/accessGroups/client/index.d.ts +0 -1
  368. package/dist/api/resources/accessGroups/client/index.js +0 -17
  369. package/dist/api/resources/accessGroups/client/requests/AccessGroupsListRequest.d.ts +0 -20
  370. package/dist/api/resources/accessGroups/client/requests/AccessGroupsListRequest.js +0 -3
  371. package/dist/api/resources/accessGroups/client/requests/index.d.ts +0 -1
  372. package/dist/api/resources/accessGroups/client/requests/index.js +0 -2
  373. package/dist/api/resources/accessGroups/index.d.ts +0 -2
  374. package/dist/api/resources/accessGroups/index.js +0 -18
  375. package/dist/api/resources/accessGroups/types/AccessGroupsListRequestSort.d.ts +0 -9
  376. package/dist/api/resources/accessGroups/types/AccessGroupsListRequestSort.js +0 -12
  377. package/dist/api/resources/accessGroups/types/index.d.ts +0 -1
  378. package/dist/api/resources/accessGroups/types/index.js +0 -17
  379. package/dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.js +0 -3
  380. package/dist/api/resources/users/client/Client.d.ts +0 -145
  381. package/dist/api/resources/users/client/Client.js +0 -670
  382. package/dist/api/resources/users/client/index.d.ts +0 -1
  383. package/dist/api/resources/users/client/index.js +0 -17
  384. package/dist/api/resources/users/client/requests/UsersInviteRequest.d.ts +0 -13
  385. package/dist/api/resources/users/client/requests/UsersInviteRequest.js +0 -3
  386. package/dist/api/resources/users/client/requests/UsersListRequest.d.ts +0 -23
  387. package/dist/api/resources/users/client/requests/UsersListRequest.js +0 -3
  388. package/dist/api/resources/users/client/requests/index.d.ts +0 -2
  389. package/dist/api/resources/users/client/requests/index.js +0 -2
  390. package/dist/api/resources/users/index.d.ts +0 -2
  391. package/dist/api/resources/users/index.js +0 -18
  392. package/dist/api/resources/users/types/UserAccountAddedPayload.d.ts +0 -5
  393. package/dist/api/resources/users/types/UserAccountAddedPayload.js +0 -3
  394. package/dist/api/resources/users/types/UserAccountAddedPayloadPayload.d.ts +0 -20
  395. package/dist/api/resources/users/types/UserAccountAddedPayloadPayload.js +0 -3
  396. package/dist/api/resources/users/types/UserAccountAddedPayloadPayloadData.d.ts +0 -9
  397. package/dist/api/resources/users/types/UserAccountAddedPayloadPayloadData.js +0 -3
  398. package/dist/api/resources/users/types/UserAccountDeletedPayload.d.ts +0 -5
  399. package/dist/api/resources/users/types/UserAccountDeletedPayload.js +0 -3
  400. package/dist/api/resources/users/types/UserAccountDeletedPayloadPayload.d.ts +0 -20
  401. package/dist/api/resources/users/types/UserAccountDeletedPayloadPayload.js +0 -3
  402. package/dist/api/resources/users/types/UserAccountDeletedPayloadPayloadData.d.ts +0 -9
  403. package/dist/api/resources/users/types/UserAccountDeletedPayloadPayloadData.js +0 -3
  404. package/dist/api/resources/users/types/UserAccountUpdatedPayload.d.ts +0 -5
  405. package/dist/api/resources/users/types/UserAccountUpdatedPayload.js +0 -3
  406. package/dist/api/resources/users/types/UserAccountUpdatedPayloadPayload.d.ts +0 -20
  407. package/dist/api/resources/users/types/UserAccountUpdatedPayloadPayload.js +0 -3
  408. package/dist/api/resources/users/types/UserAccountUpdatedPayloadPayloadData.d.ts +0 -9
  409. package/dist/api/resources/users/types/UserAccountUpdatedPayloadPayloadData.js +0 -3
  410. package/dist/api/resources/users/types/UsersListRequestSort.d.ts +0 -33
  411. package/dist/api/resources/users/types/UsersListRequestSort.js +0 -36
  412. package/dist/api/resources/users/types/index.d.ts +0 -10
  413. package/dist/api/resources/users/types/index.js +0 -26
  414. package/dist/api/types/AccessGroup.d.ts +0 -12
  415. package/dist/api/types/AccessGroup.js +0 -3
  416. package/dist/api/types/AccessGroupList.d.ts +0 -16
  417. package/dist/api/types/AccessGroupList.js +0 -3
  418. package/dist/api/types/ConflictErrorBody.d.ts +0 -2
  419. package/dist/api/types/ConflictErrorBody.js +0 -3
  420. package/dist/api/types/DuplicateUserEmail.d.ts +0 -1
  421. package/dist/api/types/DuplicateUserEmail.js +0 -3
  422. package/dist/api/types/User.d.ts +0 -22
  423. package/dist/api/types/User.js +0 -3
  424. package/dist/api/types/UserAccessGroupsItem.d.ts +0 -14
  425. package/dist/api/types/UserAccessGroupsItem.js +0 -3
  426. package/dist/api/types/UserAccessGroupsItemType.d.ts +0 -10
  427. package/dist/api/types/UserAccessGroupsItemType.js +0 -13
  428. package/dist/api/types/UserData.d.ts +0 -7
  429. package/dist/api/types/UserData.js +0 -3
  430. package/dist/api/types/UserDataData.d.ts +0 -12
  431. package/dist/api/types/UserDataData.js +0 -3
  432. package/dist/api/types/UserLimitReached.d.ts +0 -1
  433. package/dist/api/types/UserLimitReached.js +0 -3
  434. package/dist/api/types/UserList.d.ts +0 -16
  435. package/dist/api/types/UserList.js +0 -3
  436. package/dist/api/types/UserStatus.d.ts +0 -7
  437. package/dist/api/types/UserStatus.js +0 -10
  438. package/dist/api/types/UsersNotEnabled.d.ts +0 -1
  439. package/dist/api/types/UsersNotEnabled.js +0 -3
  440. package/dist/serialization/resources/accessGroups/index.d.ts +0 -1
  441. package/dist/serialization/resources/accessGroups/index.js +0 -17
  442. package/dist/serialization/resources/accessGroups/types/AccessGroupsListRequestSort.d.ts +0 -7
  443. package/dist/serialization/resources/accessGroups/types/AccessGroupsListRequestSort.js +0 -39
  444. package/dist/serialization/resources/accessGroups/types/index.d.ts +0 -1
  445. package/dist/serialization/resources/accessGroups/types/index.js +0 -17
  446. package/dist/serialization/resources/users/client/index.d.ts +0 -1
  447. package/dist/serialization/resources/users/client/index.js +0 -17
  448. package/dist/serialization/resources/users/client/requests/UsersInviteRequest.d.ts +0 -10
  449. package/dist/serialization/resources/users/client/requests/UsersInviteRequest.js +0 -42
  450. package/dist/serialization/resources/users/client/requests/index.d.ts +0 -1
  451. package/dist/serialization/resources/users/client/requests/index.js +0 -5
  452. package/dist/serialization/resources/users/index.d.ts +0 -2
  453. package/dist/serialization/resources/users/index.js +0 -18
  454. package/dist/serialization/resources/users/types/UserAccountAddedPayload.d.ts +0 -11
  455. package/dist/serialization/resources/users/types/UserAccountAddedPayload.js +0 -43
  456. package/dist/serialization/resources/users/types/UserAccountAddedPayloadPayload.d.ts +0 -20
  457. package/dist/serialization/resources/users/types/UserAccountAddedPayloadPayload.js +0 -52
  458. package/dist/serialization/resources/users/types/UserAccountAddedPayloadPayloadData.d.ts +0 -12
  459. package/dist/serialization/resources/users/types/UserAccountAddedPayloadPayloadData.js +0 -44
  460. package/dist/serialization/resources/users/types/UserAccountDeletedPayload.d.ts +0 -11
  461. package/dist/serialization/resources/users/types/UserAccountDeletedPayload.js +0 -43
  462. package/dist/serialization/resources/users/types/UserAccountDeletedPayloadPayload.d.ts +0 -20
  463. package/dist/serialization/resources/users/types/UserAccountDeletedPayloadPayload.js +0 -52
  464. package/dist/serialization/resources/users/types/UserAccountDeletedPayloadPayloadData.d.ts +0 -12
  465. package/dist/serialization/resources/users/types/UserAccountDeletedPayloadPayloadData.js +0 -44
  466. package/dist/serialization/resources/users/types/UserAccountUpdatedPayload.d.ts +0 -11
  467. package/dist/serialization/resources/users/types/UserAccountUpdatedPayload.js +0 -43
  468. package/dist/serialization/resources/users/types/UserAccountUpdatedPayloadPayload.d.ts +0 -20
  469. package/dist/serialization/resources/users/types/UserAccountUpdatedPayloadPayload.js +0 -52
  470. package/dist/serialization/resources/users/types/UserAccountUpdatedPayloadPayloadData.d.ts +0 -12
  471. package/dist/serialization/resources/users/types/UserAccountUpdatedPayloadPayloadData.js +0 -44
  472. package/dist/serialization/resources/users/types/UsersListRequestSort.d.ts +0 -7
  473. package/dist/serialization/resources/users/types/UsersListRequestSort.js +0 -50
  474. package/dist/serialization/resources/users/types/index.d.ts +0 -10
  475. package/dist/serialization/resources/users/types/index.js +0 -26
  476. package/dist/serialization/types/AccessGroup.d.ts +0 -13
  477. package/dist/serialization/types/AccessGroupList.d.ts +0 -14
  478. package/dist/serialization/types/ConflictErrorBody.d.ts +0 -9
  479. package/dist/serialization/types/ConflictErrorBody.js +0 -41
  480. package/dist/serialization/types/DuplicateUserEmail.d.ts +0 -7
  481. package/dist/serialization/types/DuplicateUserEmail.js +0 -39
  482. package/dist/serialization/types/User.d.ts +0 -20
  483. package/dist/serialization/types/User.js +0 -52
  484. package/dist/serialization/types/UserAccessGroupsItem.d.ts +0 -11
  485. package/dist/serialization/types/UserAccessGroupsItemType.d.ts +0 -7
  486. package/dist/serialization/types/UserAccessGroupsItemType.js +0 -39
  487. package/dist/serialization/types/UserData.d.ts +0 -10
  488. package/dist/serialization/types/UserData.js +0 -42
  489. package/dist/serialization/types/UserDataData.d.ts +0 -13
  490. package/dist/serialization/types/UserDataData.js +0 -45
  491. package/dist/serialization/types/UserLimitReached.d.ts +0 -7
  492. package/dist/serialization/types/UserList.d.ts +0 -14
  493. package/dist/serialization/types/UserList.js +0 -46
  494. package/dist/serialization/types/UserStatus.d.ts +0 -7
  495. package/dist/serialization/types/UsersNotEnabled.d.ts +0 -7
  496. package/dist/serialization/types/UsersNotEnabled.js +0 -39
  497. package/serialization/resources/accessGroups/index.d.ts +0 -1
  498. package/serialization/resources/accessGroups/index.js +0 -17
  499. package/serialization/resources/accessGroups/types/AccessGroupsListRequestSort.d.ts +0 -7
  500. package/serialization/resources/accessGroups/types/AccessGroupsListRequestSort.js +0 -39
  501. package/serialization/resources/accessGroups/types/index.d.ts +0 -1
  502. package/serialization/resources/accessGroups/types/index.js +0 -17
  503. package/serialization/resources/users/client/index.d.ts +0 -1
  504. package/serialization/resources/users/client/index.js +0 -17
  505. package/serialization/resources/users/client/requests/UsersInviteRequest.d.ts +0 -10
  506. package/serialization/resources/users/client/requests/UsersInviteRequest.js +0 -42
  507. package/serialization/resources/users/client/requests/index.d.ts +0 -1
  508. package/serialization/resources/users/client/requests/index.js +0 -5
  509. package/serialization/resources/users/index.d.ts +0 -2
  510. package/serialization/resources/users/index.js +0 -18
  511. package/serialization/resources/users/types/UserAccountAddedPayload.d.ts +0 -11
  512. package/serialization/resources/users/types/UserAccountAddedPayload.js +0 -43
  513. package/serialization/resources/users/types/UserAccountAddedPayloadPayload.d.ts +0 -20
  514. package/serialization/resources/users/types/UserAccountAddedPayloadPayload.js +0 -52
  515. package/serialization/resources/users/types/UserAccountAddedPayloadPayloadData.d.ts +0 -12
  516. package/serialization/resources/users/types/UserAccountAddedPayloadPayloadData.js +0 -44
  517. package/serialization/resources/users/types/UserAccountDeletedPayload.d.ts +0 -11
  518. package/serialization/resources/users/types/UserAccountDeletedPayload.js +0 -43
  519. package/serialization/resources/users/types/UserAccountDeletedPayloadPayload.d.ts +0 -20
  520. package/serialization/resources/users/types/UserAccountDeletedPayloadPayload.js +0 -52
  521. package/serialization/resources/users/types/UserAccountDeletedPayloadPayloadData.d.ts +0 -12
  522. package/serialization/resources/users/types/UserAccountDeletedPayloadPayloadData.js +0 -44
  523. package/serialization/resources/users/types/UserAccountUpdatedPayload.d.ts +0 -11
  524. package/serialization/resources/users/types/UserAccountUpdatedPayload.js +0 -43
  525. package/serialization/resources/users/types/UserAccountUpdatedPayloadPayload.d.ts +0 -20
  526. package/serialization/resources/users/types/UserAccountUpdatedPayloadPayload.js +0 -52
  527. package/serialization/resources/users/types/UserAccountUpdatedPayloadPayloadData.d.ts +0 -12
  528. package/serialization/resources/users/types/UserAccountUpdatedPayloadPayloadData.js +0 -44
  529. package/serialization/resources/users/types/UsersListRequestSort.d.ts +0 -7
  530. package/serialization/resources/users/types/UsersListRequestSort.js +0 -50
  531. package/serialization/resources/users/types/index.d.ts +0 -10
  532. package/serialization/resources/users/types/index.js +0 -26
  533. package/serialization/types/AccessGroup.d.ts +0 -13
  534. package/serialization/types/AccessGroup.js +0 -45
  535. package/serialization/types/AccessGroupList.d.ts +0 -14
  536. package/serialization/types/AccessGroupList.js +0 -46
  537. package/serialization/types/ConflictErrorBody.d.ts +0 -9
  538. package/serialization/types/ConflictErrorBody.js +0 -41
  539. package/serialization/types/DuplicateUserEmail.d.ts +0 -7
  540. package/serialization/types/DuplicateUserEmail.js +0 -39
  541. package/serialization/types/User.d.ts +0 -20
  542. package/serialization/types/User.js +0 -52
  543. package/serialization/types/UserAccessGroupsItem.d.ts +0 -11
  544. package/serialization/types/UserAccessGroupsItemType.d.ts +0 -7
  545. package/serialization/types/UserAccessGroupsItemType.js +0 -39
  546. package/serialization/types/UserData.d.ts +0 -10
  547. package/serialization/types/UserData.js +0 -42
  548. package/serialization/types/UserDataData.d.ts +0 -13
  549. package/serialization/types/UserDataData.js +0 -45
  550. package/serialization/types/UserLimitReached.d.ts +0 -7
  551. package/serialization/types/UserLimitReached.js +0 -39
  552. package/serialization/types/UserList.d.ts +0 -14
  553. package/serialization/types/UserList.js +0 -46
  554. package/serialization/types/UserStatus.d.ts +0 -7
  555. package/serialization/types/UserStatus.js +0 -39
  556. package/serialization/types/UsersNotEnabled.d.ts +0 -7
  557. package/serialization/types/UsersNotEnabled.js +0 -39
  558. /package/api/resources/{accessGroups/client/requests/AccessGroupsListRequest.js → collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataOneItem.js} +0 -0
  559. /package/api/{resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.js → types/SettingChange.js} +0 -0
  560. /package/api/{resources/users/client/requests/UsersInviteRequest.js → types/SettingChangeAuditLogItem.js} +0 -0
  561. /package/{api/resources/users/client/requests/UsersListRequest.js → dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataOneItem.js} +0 -0
  562. /package/{api/resources/users/types/UserAccountAddedPayload.js → dist/api/types/SettingChange.js} +0 -0
  563. /package/{api/resources/users/types/UserAccountAddedPayloadPayload.js → dist/api/types/SettingChangeAuditLogItem.js} +0 -0
@@ -1,1971 +0,0 @@
1
- types:
2
- OrdersListRequestStatus:
3
- enum:
4
- - pending
5
- - refunded
6
- - value: dispute-lost
7
- name: DisputeLost
8
- - fulfilled
9
- - disputed
10
- - unfulfilled
11
- source:
12
- openapi: ../../../openapi/referenced-specs/v2.yml
13
- OrdersRefundRequestReason:
14
- enum:
15
- - duplicate
16
- - fraudulent
17
- - requested
18
- docs: The reason for the refund
19
- inline: true
20
- source:
21
- openapi: ../../../openapi/referenced-specs/v2.yml
22
- imports:
23
- root: __package__.yml
24
- service:
25
- auth: false
26
- base-path: ''
27
- endpoints:
28
- list:
29
- path: /sites/{site_id}/orders
30
- method: GET
31
- auth:
32
- - OAuth2:
33
- - ecommerce:read
34
- docs: |
35
- List all orders created for a given site.
36
-
37
- Required scope | `ecommerce:read`
38
- source:
39
- openapi: ../../../openapi/referenced-specs/v2.yml
40
- path-parameters:
41
- site_id:
42
- type: string
43
- docs: Unique identifier for a Site
44
- display-name: List Orders
45
- request:
46
- name: OrdersListRequest
47
- query-parameters:
48
- status:
49
- type: optional<OrdersListRequestStatus>
50
- docs: Filter the orders by status
51
- offset:
52
- type: optional<double>
53
- docs: >-
54
- Offset used for pagination if the results have more than limit
55
- records
56
- limit:
57
- type: optional<double>
58
- docs: 'Maximum number of records to be returned (max limit: 100)'
59
- response:
60
- docs: Request was successful
61
- type: root.OrderList
62
- status-code: 200
63
- errors:
64
- - root.BadRequestError
65
- - root.UnauthorizedError
66
- - root.ForbiddenError
67
- - root.NotFoundError
68
- - root.ConflictError
69
- - root.TooManyRequestsError
70
- - root.InternalServerError
71
- examples:
72
- - path-parameters:
73
- site_id: 580e63e98c9a982ac9b8b741
74
- query-parameters:
75
- status: pending
76
- offset: 1.1
77
- limit: 1.1
78
- response:
79
- body:
80
- orders:
81
- - orderId: 7c1-9fd
82
- status: unfulfilled
83
- comment: >-
84
- Customer requested gift wrapping and a personalized note
85
- saying: Happy Birthday, Ford! 🎉 Please ensure the item is
86
- packed with extra bubble wrap for safe transit.
87
- orderComment: >-
88
- Please gift wrap with a personal note saying "Happy
89
- Birthday, Ford! 🎉
90
- acceptedOn: '2024-04-10T13:16:21Z'
91
- fulfilledOn: '2018-12-03T22:06:15Z'
92
- refundedOn: '2018-12-03T22:06:15Z'
93
- disputedOn: '2018-12-03T22:06:15Z'
94
- disputeUpdatedOn: '2018-12-03T22:06:15Z'
95
- disputeLastStatus: warning_needs_response
96
- customerPaid:
97
- unit: USD
98
- value: '5892'
99
- string: \$ 211.55 USD
100
- netAmount:
101
- unit: USD
102
- value: '5892'
103
- string: \$ 200.89 USD
104
- applicationFee:
105
- unit: USD
106
- value: '5892'
107
- string: \$ 4.23 USD
108
- allAddresses:
109
- - type: billing
110
- addressee: Arthur Dent
111
- line1: 20 W 34th St
112
- line2: Empire State Building
113
- city: New York
114
- state: New York
115
- country: US
116
- postalCode: '10118'
117
- - type: shipping
118
- addressee: Arthur Dent
119
- line1: 20 W 34th St
120
- line2: Empire State Building
121
- city: New York
122
- state: New York
123
- country: US
124
- postalCode: '10118'
125
- shippingAddress:
126
- type: shipping
127
- japanType: kanji
128
- addressee: Arthur Dent
129
- line1: 20 W 34th St
130
- line2: Empire State Building
131
- city: New York
132
- state: New York
133
- country: US
134
- postalCode: '10118'
135
- billingAddress:
136
- type: billing
137
- addressee: Arthur Dent
138
- line1: 20 W 34th St
139
- line2: Empire State Building
140
- city: New York
141
- state: New York
142
- country: US
143
- postalCode: '10118'
144
- shippingProvider: Shipping Company, Co.
145
- shippingTracking: tr00000000002
146
- shippingTrackingURL: https://www.shippingcompany.com/tracking/tr00000000002
147
- customerInfo:
148
- fullName: Arthur Dent
149
- email: arthur.dent@example.com
150
- purchasedItems:
151
- - count: 2
152
- rowTotal:
153
- unit: USD
154
- value: '5892'
155
- string: \$ 111.22 USD
156
- productId: 66072fb61b89448912e26791
157
- productName: Luxurious Fresh Ball
158
- productSlug: luxurious-fresh-ball
159
- variantId: 66072fb71b89448912e2683f
160
- variantName: 'Luxurious Fresh Ball Generic: Bronze, Practical: Plastic'
161
- variantSlug: luxurious-fresh-ball-generic-bronze-practical-plastic
162
- variantSKU: luxurious-fresh-ball-generic-bronze-practical-plastic
163
- variantImage:
164
- url: >-
165
- https://dev-assets.website-files.com/66072f39417a2a35b2589cc7/66072fb51b89448912e2672c_image14.jpeg
166
- variantPrice:
167
- unit: USD
168
- value: '5892'
169
- string: \$ 55.61 USD
170
- weight: 11
171
- width: 82
172
- height: 70
173
- length: 9
174
- - count: 1
175
- rowTotal:
176
- unit: USD
177
- value: '5892'
178
- string: \$ 83.09 USD
179
- productId: 66072fb61b89448912e2678b
180
- productName: Incredible Bronze Towels
181
- productSlug: incredible-bronze-towels
182
- variantId: 66072fb71b89448912e2681e
183
- variantName: >-
184
- Incredible Bronze Towels Sleek: Frozen, Incredible:
185
- Metal
186
- variantSlug: incredible-bronze-towels-sleek-frozen-incredible-metal
187
- variantSKU: incredible-bronze-towels-sleek-frozen-incredible-metal
188
- variantImage:
189
- url: >-
190
- https://dev-assets.website-files.com/66072f39417a2a35b2589cc7/66072fb51b89448912e26729_image16.jpeg
191
- variantPrice:
192
- unit: USD
193
- value: '5892'
194
- string: \$ 83.09 USD
195
- weight: 5
196
- width: 19
197
- height: 72
198
- length: 18
199
- purchasedItemsCount: 3
200
- stripeDetails:
201
- subscriptionId: sub_1J6xwG2eZvKYlo2CXu9Zt0Tn
202
- paymentMethod: pm_1P410gJYFi4lcbXWbeKghqjK
203
- paymentIntentId: pi_3P410iJYFi4lcbXW0EKKgcVg
204
- customerId: cus_Ptod8KJBiiPgnH
205
- chargeId: ch_3P410iJYFi4lcbXW0DxUkzCH
206
- refundReason: requested_by_customer
207
- stripeCard:
208
- last4: '4242'
209
- brand: Visa
210
- ownerName: Arthur Dent
211
- expires:
212
- year: 2025
213
- month: 4
214
- paypalDetails:
215
- orderId: 1a2b3c4d5e6f7g8h9i0j
216
- payerId: 9k8j7i6h5g4f3e2d1c0b
217
- captureId: qwe123rty456uio789p
218
- refundId: abcde12345fghij67890
219
- refundReason: Customer requested refund
220
- disputeId: zxcvbnm987poiuytrewq
221
- customData:
222
- - key: value
223
- metadata:
224
- isBuyNow: false
225
- isCustomerDeleted: false
226
- isShippingRequired: false
227
- hasDownloads: false
228
- paymentProcessor: stripe
229
- totals:
230
- extras:
231
- - type: tax
232
- name: State Taxes
233
- description: CA Taxes (6.25%)
234
- price:
235
- unit: USD
236
- value: '5892'
237
- string: \$3.44
238
- downloadFiles:
239
- - id: 5e9a5eba75e0ac242e1b6f64
240
- name: The modern web design process - Webflow Ebook.pdf
241
- url: >-
242
- https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa
243
- - orderId: fc7-128
244
- status: refunded
245
- comment: Example comment to myself
246
- orderComment: ''
247
- acceptedOn: '2024-03-29T21:29:21Z'
248
- fulfilledOn: '2018-12-03T22:06:15Z'
249
- refundedOn: '2024-04-08T18:25:04Z'
250
- disputedOn: '2018-12-03T22:06:15Z'
251
- disputeUpdatedOn: '2018-12-03T22:06:15Z'
252
- disputeLastStatus: warning_needs_response
253
- customerPaid:
254
- unit: USD
255
- value: '5892'
256
- string: \$ 118.73 USD
257
- netAmount:
258
- unit: USD
259
- value: '5892'
260
- string: \$ 112.62 USD
261
- applicationFee:
262
- unit: USD
263
- value: '5892'
264
- string: \$ 2.37 USD
265
- allAddresses:
266
- - type: billing
267
- addressee: Arthur Dent
268
- line1: 20 W 34th St
269
- line2: Empire State Building
270
- city: New York
271
- state: New York
272
- country: US
273
- postalCode: '10118'
274
- - type: shipping
275
- addressee: Arthur Dent
276
- line1: 20 W 34th St
277
- line2: Empire State Building
278
- city: New York
279
- state: New York
280
- country: US
281
- postalCode: '10118'
282
- shippingAddress:
283
- type: shipping
284
- addressee: Arthur Dent
285
- line1: 20 W 34th St
286
- line2: Empire State Building
287
- city: New York
288
- state: New York
289
- country: US
290
- postalCode: '10118'
291
- billingAddress:
292
- type: billing
293
- addressee: Arthur Dent
294
- line1: 20 W 34th St
295
- line2: Empire State Building
296
- city: New York
297
- state: New York
298
- country: US
299
- postalCode: '10118'
300
- shippingProvider: Shipping Company, Co.
301
- shippingTracking: tr00000000001
302
- shippingTrackingURL: https://www.shippingcompany.com/tracking/tr00000000001
303
- customerInfo:
304
- fullName: Arthur Dent
305
- email: arthur.dent@example.com
306
- purchasedItems:
307
- - count: 1
308
- rowTotal:
309
- unit: USD
310
- value: '5892'
311
- string: \$ 55.61 USD
312
- productId: 66072fb61b89448912e26791
313
- productName: Luxurious Fresh Ball
314
- productSlug: luxurious-fresh-ball
315
- variantId: 66072fb71b89448912e2683f
316
- variantName: 'Luxurious Fresh Ball Generic: Bronze, Practical: Plastic'
317
- variantSlug: luxurious-fresh-ball-generic-bronze-practical-plastic
318
- variantSKU: luxurious-fresh-ball-generic-bronze-practical-plastic
319
- variantImage:
320
- url: >-
321
- https://dev-assets.website-files.com/66072f39417a2a35b2589cc7/66072fb51b89448912e2672c_image14.jpeg
322
- variantPrice:
323
- unit: USD
324
- value: '5892'
325
- string: \$ 55.61 USD
326
- weight: 11
327
- width: 82
328
- height: 70
329
- length: 9
330
- - count: 1
331
- rowTotal:
332
- unit: USD
333
- value: '5892'
334
- string: \$ 53.44 USD
335
- productId: 66072fb61b89448912e26799
336
- productName: Recycled Steel Gloves
337
- productSlug: recycled-steel-gloves
338
- variantId: 66072fb91b89448912e26ab9
339
- variantName: >-
340
- Recycled Steel Gloves Electronic: Granite, Handcrafted:
341
- grey
342
- variantSlug: >-
343
- recycled-steel-gloves-electronic-granite-handcrafted-grey
344
- variantSKU: >-
345
- recycled-steel-gloves-electronic-granite-handcrafted-grey
346
- variantImage:
347
- url: >-
348
- https://dev-assets.website-files.com/66072f39417a2a35b2589cc7/66072fb51b89448912e2671e_image2.jpeg
349
- variantPrice:
350
- unit: USD
351
- value: '5892'
352
- string: \$ 53.44 USD
353
- weight: 38
354
- width: 76
355
- height: 85
356
- length: 40
357
- purchasedItemsCount: 2
358
- stripeDetails:
359
- subscriptionId: sub_1J6xwG2eZvKYlo2CXu9Zt0Tn
360
- paymentMethod: pm_1OzmzBJYFi4lcbXWHKNdXU7j
361
- paymentIntentId: pi_3OzmzDJYFi4lcbXW1hTBW6ft
362
- customerId: cus_PpRsNHwWdUoRKR
363
- chargeId: ch_3OzmzDJYFi4lcbXW1ndkkrH2
364
- refundId: re_3OzmzDJYFi4lcbXW1kFAmlBk
365
- refundReason: fraudulent
366
- stripeCard:
367
- last4: '4242'
368
- brand: Visa
369
- ownerName: Arthur Dent
370
- expires:
371
- year: 2024
372
- month: 4
373
- paypalDetails:
374
- orderId: 1a2b3c4d5e6f7g8h9i0j
375
- payerId: 9k8j7i6h5g4f3e2d1c0b
376
- captureId: qwe123rty456uio789p
377
- refundId: abcde12345fghij67890
378
- refundReason: Customer requested refund
379
- disputeId: zxcvbnm987poiuytrewq
380
- customData:
381
- - key: value
382
- metadata:
383
- isBuyNow: false
384
- isCustomerDeleted: false
385
- isShippingRequired: true
386
- hasDownloads: false
387
- paymentProcessor: stripe
388
- totals:
389
- subtotal:
390
- unit: USD
391
- value: '5892'
392
- string: \$ 109.05 USD
393
- extras:
394
- - type: tax
395
- name: State Taxes
396
- description: NY Taxes (4.00%)
397
- price:
398
- unit: USD
399
- value: '5892'
400
- string: \$ 4.36 USD
401
- - type: tax
402
- name: City Taxes
403
- description: NEW YORK Taxes (4.88%)
404
- price:
405
- unit: USD
406
- value: '5892'
407
- string: \$ 5.32 USD
408
- - type: shipping
409
- name: Flat
410
- description: ''
411
- price:
412
- unit: USD
413
- value: '5892'
414
- string: \$ 0.00 USD
415
- total:
416
- unit: USD
417
- value: '5892'
418
- string: \$ 118.73 USD
419
- downloadFiles:
420
- - id: 5e9a5eba75e0ac242e1b6f64
421
- name: New product guide
422
- url: >-
423
- https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa
424
- pagination:
425
- limit: 100
426
- offset: 0
427
- total: 2
428
- get:
429
- path: /sites/{site_id}/orders/{order_id}
430
- method: GET
431
- auth:
432
- - OAuth2:
433
- - ecommerce:read
434
- docs: |
435
- Retrieve a single product by its ID. All of its SKUs will also be
436
- retrieved.
437
-
438
- Required scope | `ecommerce:read`
439
- source:
440
- openapi: ../../../openapi/referenced-specs/v2.yml
441
- path-parameters:
442
- site_id:
443
- type: string
444
- docs: Unique identifier for a Site
445
- order_id:
446
- type: string
447
- docs: Unique identifier for an Order
448
- display-name: Get Order
449
- response:
450
- docs: Request was successful
451
- type: root.Order
452
- status-code: 200
453
- errors:
454
- - root.BadRequestError
455
- - root.UnauthorizedError
456
- - root.ForbiddenError
457
- - root.NotFoundError
458
- - root.ConflictError
459
- - root.TooManyRequestsError
460
- - root.InternalServerError
461
- examples:
462
- - path-parameters:
463
- site_id: 580e63e98c9a982ac9b8b741
464
- order_id: 5e8518516e147040726cc415
465
- response:
466
- body:
467
- orderId: fc7-128
468
- status: refunded
469
- comment: >-
470
- Customer requested gift wrapping and a personalized note saying:
471
- Happy Birthday, Ford! 🎉 Please ensure the item is packed with
472
- extra bubble wrap for safe transit.
473
- orderComment: >-
474
- Please gift wrap with a personal note saying "Happy Birthday,
475
- Ford! 🎉
476
- acceptedOn: '2024-03-29T21:29:21Z'
477
- fulfilledOn: '2024-03-29T21:29:21Z'
478
- refundedOn: '2024-04-08T18:25:04Z'
479
- disputedOn: '2024-03-29T21:29:21Z'
480
- disputeUpdatedOn: '2024-03-29T21:29:21Z'
481
- disputeLastStatus: charge_refunded
482
- customerPaid:
483
- unit: USD
484
- value: '5892'
485
- string: \$ 118.73 USD
486
- netAmount:
487
- unit: USD
488
- value: '5892'
489
- string: \$ 112.62 USD
490
- applicationFee:
491
- unit: USD
492
- value: '5892'
493
- string: \$ 2.37 USD
494
- allAddresses:
495
- - type: billing
496
- japanType: kana
497
- addressee: Arthur Dent
498
- line1: 20 W 34th St
499
- line2: Empire State Building
500
- city: New York
501
- state: New York
502
- country: US
503
- postalCode: '10118'
504
- - type: shipping
505
- japanType: kana
506
- addressee: Arthur Dent
507
- line1: 20 W 34th St
508
- line2: Empire State Building
509
- city: New York
510
- state: New York
511
- country: US
512
- postalCode: '10118'
513
- shippingAddress:
514
- type: shipping
515
- japanType: kanji
516
- addressee: Arthur Dent
517
- line1: 20 W 34th St
518
- line2: Empire State Building
519
- city: New York
520
- state: New York
521
- country: US
522
- postalCode: '10118'
523
- billingAddress:
524
- type: billing
525
- japanType: kana
526
- addressee: Arthur Dent
527
- line1: 20 W 34th St
528
- line2: Empire State Building
529
- city: New York
530
- state: New York
531
- country: US
532
- postalCode: '10118'
533
- shippingProvider: Shipping Company, Co.
534
- shippingTracking: tr00000000001
535
- shippingTrackingURL: https://www.shippingcompany.com/tracking/tr00000000001
536
- customerInfo:
537
- fullName: Arthur Dent
538
- email: arthur.dent@example.com
539
- purchasedItems:
540
- - count: 1
541
- rowTotal:
542
- unit: USD
543
- value: '5892'
544
- string: \$ 55.61 USD
545
- productId: 66072fb61b89448912e26791
546
- productName: Luxurious Fresh Ball
547
- productSlug: luxurious-fresh-ball
548
- variantId: 66072fb71b89448912e2683f
549
- variantName: 'Luxurious Fresh Ball Generic: Bronze, Practical: Plastic'
550
- variantSlug: luxurious-fresh-ball-generic-bronze-practical-plastic
551
- variantSKU: luxurious-fresh-ball-generic-bronze-practical-plastic
552
- variantImage:
553
- url: >-
554
- https://dev-assets.website-files.com/66072f39417a2a35b2589cc7/66072fb51b89448912e2672c_image14.jpeg
555
- variantPrice:
556
- unit: USD
557
- value: '5892'
558
- string: \$ 55.61 USD
559
- weight: 11
560
- width: 82
561
- height: 70
562
- length: 9
563
- - count: 1
564
- rowTotal:
565
- unit: USD
566
- value: '5892'
567
- string: \$ 53.44 USD
568
- productId: 66072fb61b89448912e26799
569
- productName: Recycled Steel Gloves
570
- productSlug: recycled-steel-gloves
571
- variantId: 66072fb91b89448912e26ab9
572
- variantName: 'Recycled Steel Gloves Electronic: Granite, Handcrafted: grey'
573
- variantSlug: recycled-steel-gloves-electronic-granite-handcrafted-grey
574
- variantSKU: recycled-steel-gloves-electronic-granite-handcrafted-grey
575
- variantImage:
576
- url: >-
577
- https://dev-assets.website-files.com/66072f39417a2a35b2589cc7/66072fb51b89448912e2671e_image2.jpeg
578
- variantPrice:
579
- unit: USD
580
- value: '5892'
581
- string: \$ 53.44 USD
582
- weight: 38
583
- width: 76
584
- height: 85
585
- length: 40
586
- purchasedItemsCount: 2
587
- stripeDetails:
588
- subscriptionId: sub_1J6xwG2eZvKYlo2CXu9Zt0Tn
589
- paymentMethod: pm_1OzmzBJYFi4lcbXWHKNdXU7j
590
- paymentIntentId: pi_3OzmzDJYFi4lcbXW1hTBW6ft
591
- customerId: cus_PpRsNHwWdUoRKR
592
- chargeId: ch_3OzmzDJYFi4lcbXW1ndkkrH2
593
- disputeId: disputeId
594
- refundId: re_3OzmzDJYFi4lcbXW1kFAmlBk
595
- refundReason: fraudulent
596
- stripeCard:
597
- last4: '4242'
598
- brand: Visa
599
- ownerName: Arthur Dent
600
- expires:
601
- year: 2024
602
- month: 4
603
- paypalDetails:
604
- orderId: 1a2b3c4d5e6f7g8h9i0j
605
- payerId: 9k8j7i6h5g4f3e2d1c0b
606
- captureId: qwe123rty456uio789p
607
- refundId: abcde12345fghij67890
608
- refundReason: Customer requested refund
609
- disputeId: zxcvbnm987poiuytrewq
610
- customData:
611
- - key: value
612
- metadata:
613
- isBuyNow: false
614
- isCustomerDeleted: false
615
- isShippingRequired: true
616
- hasDownloads: false
617
- paymentProcessor: stripe
618
- totals:
619
- subtotal:
620
- unit: USD
621
- value: '5892'
622
- string: \$ 109.05 USD
623
- extras:
624
- - type: tax
625
- name: State Taxes
626
- description: NY Taxes (4.00%)
627
- price:
628
- unit: USD
629
- value: '5892'
630
- string: \$ 4.36 USD
631
- - type: tax
632
- name: City Taxes
633
- description: NEW YORK Taxes (4.88%)
634
- price:
635
- unit: USD
636
- value: '5892'
637
- string: \$ 5.32 USD
638
- - type: shipping
639
- name: Flat
640
- description: ''
641
- price:
642
- unit: USD
643
- value: '5892'
644
- string: \$ 0.00 USD
645
- total:
646
- unit: USD
647
- value: '5892'
648
- string: \$ 118.73 USD
649
- downloadFiles:
650
- - id: 5e9a5eba75e0ac242e1b6f64
651
- name: New product guide
652
- url: >-
653
- https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa
654
- update:
655
- path: /sites/{site_id}/orders/{order_id}
656
- method: PATCH
657
- auth:
658
- - OAuth2:
659
- - ecommerce:write
660
- docs: |
661
- This API lets you update the fields, `comment`, `shippingProvider`,
662
- and/or `shippingTracking` for a given order. All three fields can be
663
- updated simultaneously or independently.
664
-
665
- Required scope | `ecommerce:write`
666
- source:
667
- openapi: ../../../openapi/referenced-specs/v2.yml
668
- path-parameters:
669
- site_id:
670
- type: string
671
- docs: Unique identifier for a Site
672
- order_id:
673
- type: string
674
- docs: Unique identifier for an Order
675
- display-name: Update Order
676
- request:
677
- name: OrdersUpdateRequest
678
- body:
679
- properties:
680
- comment:
681
- type: optional<string>
682
- docs: Arbitrary data for your records
683
- shippingProvider:
684
- type: optional<string>
685
- docs: Company or method used to ship order
686
- shippingTracking:
687
- type: optional<string>
688
- docs: Tracking number for order shipment
689
- shippingTrackingURL:
690
- type: optional<string>
691
- docs: URL to track order shipment
692
- content-type: application/json
693
- response:
694
- docs: Request was successful
695
- type: root.Order
696
- status-code: 200
697
- errors:
698
- - root.BadRequestError
699
- - root.UnauthorizedError
700
- - root.ForbiddenError
701
- - root.NotFoundError
702
- - root.ConflictError
703
- - root.TooManyRequestsError
704
- - root.InternalServerError
705
- examples:
706
- - path-parameters:
707
- site_id: 580e63e98c9a982ac9b8b741
708
- order_id: 5e8518516e147040726cc415
709
- request: {}
710
- response:
711
- body:
712
- orderId: fc7-128
713
- status: refunded
714
- comment: >-
715
- Customer requested gift wrapping and a personalized note saying:
716
- Happy Birthday, Ford! 🎉 Please ensure the item is packed with
717
- extra bubble wrap for safe transit.
718
- orderComment: >-
719
- Please gift wrap with a personal note saying "Happy Birthday,
720
- Ford! 🎉
721
- acceptedOn: '2024-03-29T21:29:21Z'
722
- fulfilledOn: '2024-03-29T21:29:21Z'
723
- refundedOn: '2024-04-08T18:25:04Z'
724
- disputedOn: '2024-03-29T21:29:21Z'
725
- disputeUpdatedOn: '2024-03-29T21:29:21Z'
726
- disputeLastStatus: charge_refunded
727
- customerPaid:
728
- unit: USD
729
- value: '5892'
730
- string: \$ 118.73 USD
731
- netAmount:
732
- unit: USD
733
- value: '5892'
734
- string: \$ 112.62 USD
735
- applicationFee:
736
- unit: USD
737
- value: '5892'
738
- string: \$ 2.37 USD
739
- allAddresses:
740
- - type: billing
741
- japanType: kana
742
- addressee: Arthur Dent
743
- line1: 20 W 34th St
744
- line2: Empire State Building
745
- city: New York
746
- state: New York
747
- country: US
748
- postalCode: '10118'
749
- - type: shipping
750
- japanType: kana
751
- addressee: Arthur Dent
752
- line1: 20 W 34th St
753
- line2: Empire State Building
754
- city: New York
755
- state: New York
756
- country: US
757
- postalCode: '10118'
758
- shippingAddress:
759
- type: shipping
760
- japanType: kanji
761
- addressee: Arthur Dent
762
- line1: 20 W 34th St
763
- line2: Empire State Building
764
- city: New York
765
- state: New York
766
- country: US
767
- postalCode: '10118'
768
- billingAddress:
769
- type: billing
770
- japanType: kana
771
- addressee: Arthur Dent
772
- line1: 20 W 34th St
773
- line2: Empire State Building
774
- city: New York
775
- state: New York
776
- country: US
777
- postalCode: '10118'
778
- shippingProvider: Shipping Company, Co.
779
- shippingTracking: tr00000000001
780
- shippingTrackingURL: https://www.shippingcompany.com/tracking/tr00000000001
781
- customerInfo:
782
- fullName: Arthur Dent
783
- email: arthur.dent@example.com
784
- purchasedItems:
785
- - count: 1
786
- rowTotal:
787
- unit: USD
788
- value: '5892'
789
- string: \$ 55.61 USD
790
- productId: 66072fb61b89448912e26791
791
- productName: Luxurious Fresh Ball
792
- productSlug: luxurious-fresh-ball
793
- variantId: 66072fb71b89448912e2683f
794
- variantName: 'Luxurious Fresh Ball Generic: Bronze, Practical: Plastic'
795
- variantSlug: luxurious-fresh-ball-generic-bronze-practical-plastic
796
- variantSKU: luxurious-fresh-ball-generic-bronze-practical-plastic
797
- variantImage:
798
- url: >-
799
- https://dev-assets.website-files.com/66072f39417a2a35b2589cc7/66072fb51b89448912e2672c_image14.jpeg
800
- variantPrice:
801
- unit: USD
802
- value: '5892'
803
- string: \$ 55.61 USD
804
- weight: 11
805
- width: 82
806
- height: 70
807
- length: 9
808
- - count: 1
809
- rowTotal:
810
- unit: USD
811
- value: '5892'
812
- string: \$ 53.44 USD
813
- productId: 66072fb61b89448912e26799
814
- productName: Recycled Steel Gloves
815
- productSlug: recycled-steel-gloves
816
- variantId: 66072fb91b89448912e26ab9
817
- variantName: 'Recycled Steel Gloves Electronic: Granite, Handcrafted: grey'
818
- variantSlug: recycled-steel-gloves-electronic-granite-handcrafted-grey
819
- variantSKU: recycled-steel-gloves-electronic-granite-handcrafted-grey
820
- variantImage:
821
- url: >-
822
- https://dev-assets.website-files.com/66072f39417a2a35b2589cc7/66072fb51b89448912e2671e_image2.jpeg
823
- variantPrice:
824
- unit: USD
825
- value: '5892'
826
- string: \$ 53.44 USD
827
- weight: 38
828
- width: 76
829
- height: 85
830
- length: 40
831
- purchasedItemsCount: 2
832
- stripeDetails:
833
- subscriptionId: sub_1J6xwG2eZvKYlo2CXu9Zt0Tn
834
- paymentMethod: pm_1OzmzBJYFi4lcbXWHKNdXU7j
835
- paymentIntentId: pi_3OzmzDJYFi4lcbXW1hTBW6ft
836
- customerId: cus_PpRsNHwWdUoRKR
837
- chargeId: ch_3OzmzDJYFi4lcbXW1ndkkrH2
838
- disputeId: disputeId
839
- refundId: re_3OzmzDJYFi4lcbXW1kFAmlBk
840
- refundReason: fraudulent
841
- stripeCard:
842
- last4: '4242'
843
- brand: Visa
844
- ownerName: Arthur Dent
845
- expires:
846
- year: 2024
847
- month: 4
848
- paypalDetails:
849
- orderId: 1a2b3c4d5e6f7g8h9i0j
850
- payerId: 9k8j7i6h5g4f3e2d1c0b
851
- captureId: qwe123rty456uio789p
852
- refundId: abcde12345fghij67890
853
- refundReason: Customer requested refund
854
- disputeId: zxcvbnm987poiuytrewq
855
- customData:
856
- - key: value
857
- metadata:
858
- isBuyNow: false
859
- isCustomerDeleted: false
860
- isShippingRequired: true
861
- hasDownloads: false
862
- paymentProcessor: stripe
863
- totals:
864
- subtotal:
865
- unit: USD
866
- value: '5892'
867
- string: \$ 109.05 USD
868
- extras:
869
- - type: tax
870
- name: State Taxes
871
- description: NY Taxes (4.00%)
872
- price:
873
- unit: USD
874
- value: '5892'
875
- string: \$ 4.36 USD
876
- - type: tax
877
- name: City Taxes
878
- description: NEW YORK Taxes (4.88%)
879
- price:
880
- unit: USD
881
- value: '5892'
882
- string: \$ 5.32 USD
883
- - type: shipping
884
- name: Flat
885
- description: ''
886
- price:
887
- unit: USD
888
- value: '5892'
889
- string: \$ 0.00 USD
890
- total:
891
- unit: USD
892
- value: '5892'
893
- string: \$ 118.73 USD
894
- downloadFiles:
895
- - id: 5e9a5eba75e0ac242e1b6f64
896
- name: New product guide
897
- url: >-
898
- https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa
899
- update-fulfill:
900
- path: /sites/{site_id}/orders/{order_id}/fulfill
901
- method: POST
902
- auth:
903
- - OAuth2:
904
- - ecommerce:write
905
- docs: |
906
- Updates an order's status to fulfilled
907
-
908
- Required scope | `ecommerce:write`
909
- source:
910
- openapi: ../../../openapi/referenced-specs/v2.yml
911
- path-parameters:
912
- site_id:
913
- type: string
914
- docs: Unique identifier for a Site
915
- order_id:
916
- type: string
917
- docs: Unique identifier for an Order
918
- display-name: Fulfill Order
919
- request:
920
- name: OrdersUpdateFulfillRequest
921
- body:
922
- properties:
923
- sendOrderFulfilledEmail:
924
- type: optional<boolean>
925
- docs: Whether or not the Order Fulfilled email should be sent
926
- default: false
927
- content-type: application/json
928
- response:
929
- docs: Request was successful
930
- type: root.Order
931
- status-code: 200
932
- errors:
933
- - root.BadRequestError
934
- - root.UnauthorizedError
935
- - root.ForbiddenError
936
- - root.NotFoundError
937
- - root.ConflictError
938
- - root.TooManyRequestsError
939
- - root.InternalServerError
940
- examples:
941
- - path-parameters:
942
- site_id: 580e63e98c9a982ac9b8b741
943
- order_id: 5e8518516e147040726cc415
944
- request: {}
945
- response:
946
- body:
947
- orderId: fc7-128
948
- status: refunded
949
- comment: >-
950
- Customer requested gift wrapping and a personalized note saying:
951
- Happy Birthday, Ford! 🎉 Please ensure the item is packed with
952
- extra bubble wrap for safe transit.
953
- orderComment: >-
954
- Please gift wrap with a personal note saying "Happy Birthday,
955
- Ford! 🎉
956
- acceptedOn: '2024-03-29T21:29:21Z'
957
- fulfilledOn: '2024-03-29T21:29:21Z'
958
- refundedOn: '2024-04-08T18:25:04Z'
959
- disputedOn: '2024-03-29T21:29:21Z'
960
- disputeUpdatedOn: '2024-03-29T21:29:21Z'
961
- disputeLastStatus: charge_refunded
962
- customerPaid:
963
- unit: USD
964
- value: '5892'
965
- string: \$ 118.73 USD
966
- netAmount:
967
- unit: USD
968
- value: '5892'
969
- string: \$ 112.62 USD
970
- applicationFee:
971
- unit: USD
972
- value: '5892'
973
- string: \$ 2.37 USD
974
- allAddresses:
975
- - type: billing
976
- japanType: kana
977
- addressee: Arthur Dent
978
- line1: 20 W 34th St
979
- line2: Empire State Building
980
- city: New York
981
- state: New York
982
- country: US
983
- postalCode: '10118'
984
- - type: shipping
985
- japanType: kana
986
- addressee: Arthur Dent
987
- line1: 20 W 34th St
988
- line2: Empire State Building
989
- city: New York
990
- state: New York
991
- country: US
992
- postalCode: '10118'
993
- shippingAddress:
994
- type: shipping
995
- japanType: kanji
996
- addressee: Arthur Dent
997
- line1: 20 W 34th St
998
- line2: Empire State Building
999
- city: New York
1000
- state: New York
1001
- country: US
1002
- postalCode: '10118'
1003
- billingAddress:
1004
- type: billing
1005
- japanType: kana
1006
- addressee: Arthur Dent
1007
- line1: 20 W 34th St
1008
- line2: Empire State Building
1009
- city: New York
1010
- state: New York
1011
- country: US
1012
- postalCode: '10118'
1013
- shippingProvider: Shipping Company, Co.
1014
- shippingTracking: tr00000000001
1015
- shippingTrackingURL: https://www.shippingcompany.com/tracking/tr00000000001
1016
- customerInfo:
1017
- fullName: Arthur Dent
1018
- email: arthur.dent@example.com
1019
- purchasedItems:
1020
- - count: 1
1021
- rowTotal:
1022
- unit: USD
1023
- value: '5892'
1024
- string: \$ 55.61 USD
1025
- productId: 66072fb61b89448912e26791
1026
- productName: Luxurious Fresh Ball
1027
- productSlug: luxurious-fresh-ball
1028
- variantId: 66072fb71b89448912e2683f
1029
- variantName: 'Luxurious Fresh Ball Generic: Bronze, Practical: Plastic'
1030
- variantSlug: luxurious-fresh-ball-generic-bronze-practical-plastic
1031
- variantSKU: luxurious-fresh-ball-generic-bronze-practical-plastic
1032
- variantImage:
1033
- url: >-
1034
- https://dev-assets.website-files.com/66072f39417a2a35b2589cc7/66072fb51b89448912e2672c_image14.jpeg
1035
- variantPrice:
1036
- unit: USD
1037
- value: '5892'
1038
- string: \$ 55.61 USD
1039
- weight: 11
1040
- width: 82
1041
- height: 70
1042
- length: 9
1043
- - count: 1
1044
- rowTotal:
1045
- unit: USD
1046
- value: '5892'
1047
- string: \$ 53.44 USD
1048
- productId: 66072fb61b89448912e26799
1049
- productName: Recycled Steel Gloves
1050
- productSlug: recycled-steel-gloves
1051
- variantId: 66072fb91b89448912e26ab9
1052
- variantName: 'Recycled Steel Gloves Electronic: Granite, Handcrafted: grey'
1053
- variantSlug: recycled-steel-gloves-electronic-granite-handcrafted-grey
1054
- variantSKU: recycled-steel-gloves-electronic-granite-handcrafted-grey
1055
- variantImage:
1056
- url: >-
1057
- https://dev-assets.website-files.com/66072f39417a2a35b2589cc7/66072fb51b89448912e2671e_image2.jpeg
1058
- variantPrice:
1059
- unit: USD
1060
- value: '5892'
1061
- string: \$ 53.44 USD
1062
- weight: 38
1063
- width: 76
1064
- height: 85
1065
- length: 40
1066
- purchasedItemsCount: 2
1067
- stripeDetails:
1068
- subscriptionId: sub_1J6xwG2eZvKYlo2CXu9Zt0Tn
1069
- paymentMethod: pm_1OzmzBJYFi4lcbXWHKNdXU7j
1070
- paymentIntentId: pi_3OzmzDJYFi4lcbXW1hTBW6ft
1071
- customerId: cus_PpRsNHwWdUoRKR
1072
- chargeId: ch_3OzmzDJYFi4lcbXW1ndkkrH2
1073
- disputeId: disputeId
1074
- refundId: re_3OzmzDJYFi4lcbXW1kFAmlBk
1075
- refundReason: fraudulent
1076
- stripeCard:
1077
- last4: '4242'
1078
- brand: Visa
1079
- ownerName: Arthur Dent
1080
- expires:
1081
- year: 2024
1082
- month: 4
1083
- paypalDetails:
1084
- orderId: 1a2b3c4d5e6f7g8h9i0j
1085
- payerId: 9k8j7i6h5g4f3e2d1c0b
1086
- captureId: qwe123rty456uio789p
1087
- refundId: abcde12345fghij67890
1088
- refundReason: Customer requested refund
1089
- disputeId: zxcvbnm987poiuytrewq
1090
- customData:
1091
- - key: value
1092
- metadata:
1093
- isBuyNow: false
1094
- isCustomerDeleted: false
1095
- isShippingRequired: true
1096
- hasDownloads: false
1097
- paymentProcessor: stripe
1098
- totals:
1099
- subtotal:
1100
- unit: USD
1101
- value: '5892'
1102
- string: \$ 109.05 USD
1103
- extras:
1104
- - type: tax
1105
- name: State Taxes
1106
- description: NY Taxes (4.00%)
1107
- price:
1108
- unit: USD
1109
- value: '5892'
1110
- string: \$ 4.36 USD
1111
- - type: tax
1112
- name: City Taxes
1113
- description: NEW YORK Taxes (4.88%)
1114
- price:
1115
- unit: USD
1116
- value: '5892'
1117
- string: \$ 5.32 USD
1118
- - type: shipping
1119
- name: Flat
1120
- description: ''
1121
- price:
1122
- unit: USD
1123
- value: '5892'
1124
- string: \$ 0.00 USD
1125
- total:
1126
- unit: USD
1127
- value: '5892'
1128
- string: \$ 118.73 USD
1129
- downloadFiles:
1130
- - id: 5e9a5eba75e0ac242e1b6f64
1131
- name: New product guide
1132
- url: >-
1133
- https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa
1134
- update-unfulfill:
1135
- path: /sites/{site_id}/orders/{order_id}/unfulfill
1136
- method: POST
1137
- auth:
1138
- - OAuth2:
1139
- - ecommerce:write
1140
- docs: |
1141
- Updates an order's status to unfulfilled
1142
-
1143
- Required scope | `ecommerce:write`
1144
- source:
1145
- openapi: ../../../openapi/referenced-specs/v2.yml
1146
- path-parameters:
1147
- site_id:
1148
- type: string
1149
- docs: Unique identifier for a Site
1150
- order_id:
1151
- type: string
1152
- docs: Unique identifier for an Order
1153
- display-name: Unfulfill Order
1154
- response:
1155
- docs: Request was successful
1156
- type: root.Order
1157
- status-code: 200
1158
- errors:
1159
- - root.BadRequestError
1160
- - root.UnauthorizedError
1161
- - root.ForbiddenError
1162
- - root.NotFoundError
1163
- - root.ConflictError
1164
- - root.TooManyRequestsError
1165
- - root.InternalServerError
1166
- examples:
1167
- - path-parameters:
1168
- site_id: 580e63e98c9a982ac9b8b741
1169
- order_id: 5e8518516e147040726cc415
1170
- response:
1171
- body:
1172
- orderId: fc7-128
1173
- status: refunded
1174
- comment: >-
1175
- Customer requested gift wrapping and a personalized note saying:
1176
- Happy Birthday, Ford! 🎉 Please ensure the item is packed with
1177
- extra bubble wrap for safe transit.
1178
- orderComment: >-
1179
- Please gift wrap with a personal note saying "Happy Birthday,
1180
- Ford! 🎉
1181
- acceptedOn: '2024-03-29T21:29:21Z'
1182
- fulfilledOn: '2024-03-29T21:29:21Z'
1183
- refundedOn: '2024-04-08T18:25:04Z'
1184
- disputedOn: '2024-03-29T21:29:21Z'
1185
- disputeUpdatedOn: '2024-03-29T21:29:21Z'
1186
- disputeLastStatus: charge_refunded
1187
- customerPaid:
1188
- unit: USD
1189
- value: '5892'
1190
- string: \$ 118.73 USD
1191
- netAmount:
1192
- unit: USD
1193
- value: '5892'
1194
- string: \$ 112.62 USD
1195
- applicationFee:
1196
- unit: USD
1197
- value: '5892'
1198
- string: \$ 2.37 USD
1199
- allAddresses:
1200
- - type: billing
1201
- japanType: kana
1202
- addressee: Arthur Dent
1203
- line1: 20 W 34th St
1204
- line2: Empire State Building
1205
- city: New York
1206
- state: New York
1207
- country: US
1208
- postalCode: '10118'
1209
- - type: shipping
1210
- japanType: kana
1211
- addressee: Arthur Dent
1212
- line1: 20 W 34th St
1213
- line2: Empire State Building
1214
- city: New York
1215
- state: New York
1216
- country: US
1217
- postalCode: '10118'
1218
- shippingAddress:
1219
- type: shipping
1220
- japanType: kanji
1221
- addressee: Arthur Dent
1222
- line1: 20 W 34th St
1223
- line2: Empire State Building
1224
- city: New York
1225
- state: New York
1226
- country: US
1227
- postalCode: '10118'
1228
- billingAddress:
1229
- type: billing
1230
- japanType: kana
1231
- addressee: Arthur Dent
1232
- line1: 20 W 34th St
1233
- line2: Empire State Building
1234
- city: New York
1235
- state: New York
1236
- country: US
1237
- postalCode: '10118'
1238
- shippingProvider: Shipping Company, Co.
1239
- shippingTracking: tr00000000001
1240
- shippingTrackingURL: https://www.shippingcompany.com/tracking/tr00000000001
1241
- customerInfo:
1242
- fullName: Arthur Dent
1243
- email: arthur.dent@example.com
1244
- purchasedItems:
1245
- - count: 1
1246
- rowTotal:
1247
- unit: USD
1248
- value: '5892'
1249
- string: \$ 55.61 USD
1250
- productId: 66072fb61b89448912e26791
1251
- productName: Luxurious Fresh Ball
1252
- productSlug: luxurious-fresh-ball
1253
- variantId: 66072fb71b89448912e2683f
1254
- variantName: 'Luxurious Fresh Ball Generic: Bronze, Practical: Plastic'
1255
- variantSlug: luxurious-fresh-ball-generic-bronze-practical-plastic
1256
- variantSKU: luxurious-fresh-ball-generic-bronze-practical-plastic
1257
- variantImage:
1258
- url: >-
1259
- https://dev-assets.website-files.com/66072f39417a2a35b2589cc7/66072fb51b89448912e2672c_image14.jpeg
1260
- variantPrice:
1261
- unit: USD
1262
- value: '5892'
1263
- string: \$ 55.61 USD
1264
- weight: 11
1265
- width: 82
1266
- height: 70
1267
- length: 9
1268
- - count: 1
1269
- rowTotal:
1270
- unit: USD
1271
- value: '5892'
1272
- string: \$ 53.44 USD
1273
- productId: 66072fb61b89448912e26799
1274
- productName: Recycled Steel Gloves
1275
- productSlug: recycled-steel-gloves
1276
- variantId: 66072fb91b89448912e26ab9
1277
- variantName: 'Recycled Steel Gloves Electronic: Granite, Handcrafted: grey'
1278
- variantSlug: recycled-steel-gloves-electronic-granite-handcrafted-grey
1279
- variantSKU: recycled-steel-gloves-electronic-granite-handcrafted-grey
1280
- variantImage:
1281
- url: >-
1282
- https://dev-assets.website-files.com/66072f39417a2a35b2589cc7/66072fb51b89448912e2671e_image2.jpeg
1283
- variantPrice:
1284
- unit: USD
1285
- value: '5892'
1286
- string: \$ 53.44 USD
1287
- weight: 38
1288
- width: 76
1289
- height: 85
1290
- length: 40
1291
- purchasedItemsCount: 2
1292
- stripeDetails:
1293
- subscriptionId: sub_1J6xwG2eZvKYlo2CXu9Zt0Tn
1294
- paymentMethod: pm_1OzmzBJYFi4lcbXWHKNdXU7j
1295
- paymentIntentId: pi_3OzmzDJYFi4lcbXW1hTBW6ft
1296
- customerId: cus_PpRsNHwWdUoRKR
1297
- chargeId: ch_3OzmzDJYFi4lcbXW1ndkkrH2
1298
- disputeId: disputeId
1299
- refundId: re_3OzmzDJYFi4lcbXW1kFAmlBk
1300
- refundReason: fraudulent
1301
- stripeCard:
1302
- last4: '4242'
1303
- brand: Visa
1304
- ownerName: Arthur Dent
1305
- expires:
1306
- year: 2024
1307
- month: 4
1308
- paypalDetails:
1309
- orderId: 1a2b3c4d5e6f7g8h9i0j
1310
- payerId: 9k8j7i6h5g4f3e2d1c0b
1311
- captureId: qwe123rty456uio789p
1312
- refundId: abcde12345fghij67890
1313
- refundReason: Customer requested refund
1314
- disputeId: zxcvbnm987poiuytrewq
1315
- customData:
1316
- - key: value
1317
- metadata:
1318
- isBuyNow: false
1319
- isCustomerDeleted: false
1320
- isShippingRequired: true
1321
- hasDownloads: false
1322
- paymentProcessor: stripe
1323
- totals:
1324
- subtotal:
1325
- unit: USD
1326
- value: '5892'
1327
- string: \$ 109.05 USD
1328
- extras:
1329
- - type: tax
1330
- name: State Taxes
1331
- description: NY Taxes (4.00%)
1332
- price:
1333
- unit: USD
1334
- value: '5892'
1335
- string: \$ 4.36 USD
1336
- - type: tax
1337
- name: City Taxes
1338
- description: NEW YORK Taxes (4.88%)
1339
- price:
1340
- unit: USD
1341
- value: '5892'
1342
- string: \$ 5.32 USD
1343
- - type: shipping
1344
- name: Flat
1345
- description: ''
1346
- price:
1347
- unit: USD
1348
- value: '5892'
1349
- string: \$ 0.00 USD
1350
- total:
1351
- unit: USD
1352
- value: '5892'
1353
- string: \$ 118.73 USD
1354
- downloadFiles:
1355
- - id: 5e9a5eba75e0ac242e1b6f64
1356
- name: New product guide
1357
- url: >-
1358
- https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa
1359
- refund:
1360
- path: /sites/{site_id}/orders/{order_id}/refund
1361
- method: POST
1362
- auth:
1363
- - OAuth2:
1364
- - ecommerce:write
1365
- docs: |
1366
- This API will reverse a Stripe charge and refund an order back to a
1367
- customer. It will also set the order's status to `refunded`.
1368
-
1369
- Required scope | `ecommerce:write`
1370
- source:
1371
- openapi: ../../../openapi/referenced-specs/v2.yml
1372
- path-parameters:
1373
- site_id:
1374
- type: string
1375
- docs: Unique identifier for a Site
1376
- order_id:
1377
- type: string
1378
- docs: Unique identifier for an Order
1379
- display-name: Refund Order
1380
- request:
1381
- name: OrdersRefundRequest
1382
- body:
1383
- properties:
1384
- reason:
1385
- type: optional<OrdersRefundRequestReason>
1386
- docs: The reason for the refund
1387
- content-type: application/json
1388
- response:
1389
- docs: Request was successful
1390
- type: root.Order
1391
- status-code: 200
1392
- errors:
1393
- - root.BadRequestError
1394
- - root.UnauthorizedError
1395
- - root.ForbiddenError
1396
- - root.NotFoundError
1397
- - root.ConflictError
1398
- - root.TooManyRequestsError
1399
- - root.InternalServerError
1400
- examples:
1401
- - path-parameters:
1402
- site_id: 580e63e98c9a982ac9b8b741
1403
- order_id: 5e8518516e147040726cc415
1404
- request: {}
1405
- response:
1406
- body:
1407
- orderId: fc7-128
1408
- status: refunded
1409
- comment: >-
1410
- Customer requested gift wrapping and a personalized note saying:
1411
- Happy Birthday, Ford! 🎉 Please ensure the item is packed with
1412
- extra bubble wrap for safe transit.
1413
- orderComment: >-
1414
- Please gift wrap with a personal note saying "Happy Birthday,
1415
- Ford! 🎉
1416
- acceptedOn: '2024-03-29T21:29:21Z'
1417
- fulfilledOn: '2024-03-29T21:29:21Z'
1418
- refundedOn: '2024-04-08T18:25:04Z'
1419
- disputedOn: '2024-03-29T21:29:21Z'
1420
- disputeUpdatedOn: '2024-03-29T21:29:21Z'
1421
- disputeLastStatus: charge_refunded
1422
- customerPaid:
1423
- unit: USD
1424
- value: '5892'
1425
- string: \$ 118.73 USD
1426
- netAmount:
1427
- unit: USD
1428
- value: '5892'
1429
- string: \$ 112.62 USD
1430
- applicationFee:
1431
- unit: USD
1432
- value: '5892'
1433
- string: \$ 2.37 USD
1434
- allAddresses:
1435
- - type: billing
1436
- japanType: kana
1437
- addressee: Arthur Dent
1438
- line1: 20 W 34th St
1439
- line2: Empire State Building
1440
- city: New York
1441
- state: New York
1442
- country: US
1443
- postalCode: '10118'
1444
- - type: shipping
1445
- japanType: kana
1446
- addressee: Arthur Dent
1447
- line1: 20 W 34th St
1448
- line2: Empire State Building
1449
- city: New York
1450
- state: New York
1451
- country: US
1452
- postalCode: '10118'
1453
- shippingAddress:
1454
- type: shipping
1455
- japanType: kanji
1456
- addressee: Arthur Dent
1457
- line1: 20 W 34th St
1458
- line2: Empire State Building
1459
- city: New York
1460
- state: New York
1461
- country: US
1462
- postalCode: '10118'
1463
- billingAddress:
1464
- type: billing
1465
- japanType: kana
1466
- addressee: Arthur Dent
1467
- line1: 20 W 34th St
1468
- line2: Empire State Building
1469
- city: New York
1470
- state: New York
1471
- country: US
1472
- postalCode: '10118'
1473
- shippingProvider: Shipping Company, Co.
1474
- shippingTracking: tr00000000001
1475
- shippingTrackingURL: https://www.shippingcompany.com/tracking/tr00000000001
1476
- customerInfo:
1477
- fullName: Arthur Dent
1478
- email: arthur.dent@example.com
1479
- purchasedItems:
1480
- - count: 1
1481
- rowTotal:
1482
- unit: USD
1483
- value: '5892'
1484
- string: \$ 55.61 USD
1485
- productId: 66072fb61b89448912e26791
1486
- productName: Luxurious Fresh Ball
1487
- productSlug: luxurious-fresh-ball
1488
- variantId: 66072fb71b89448912e2683f
1489
- variantName: 'Luxurious Fresh Ball Generic: Bronze, Practical: Plastic'
1490
- variantSlug: luxurious-fresh-ball-generic-bronze-practical-plastic
1491
- variantSKU: luxurious-fresh-ball-generic-bronze-practical-plastic
1492
- variantImage:
1493
- url: >-
1494
- https://dev-assets.website-files.com/66072f39417a2a35b2589cc7/66072fb51b89448912e2672c_image14.jpeg
1495
- variantPrice:
1496
- unit: USD
1497
- value: '5892'
1498
- string: \$ 55.61 USD
1499
- weight: 11
1500
- width: 82
1501
- height: 70
1502
- length: 9
1503
- - count: 1
1504
- rowTotal:
1505
- unit: USD
1506
- value: '5892'
1507
- string: \$ 53.44 USD
1508
- productId: 66072fb61b89448912e26799
1509
- productName: Recycled Steel Gloves
1510
- productSlug: recycled-steel-gloves
1511
- variantId: 66072fb91b89448912e26ab9
1512
- variantName: 'Recycled Steel Gloves Electronic: Granite, Handcrafted: grey'
1513
- variantSlug: recycled-steel-gloves-electronic-granite-handcrafted-grey
1514
- variantSKU: recycled-steel-gloves-electronic-granite-handcrafted-grey
1515
- variantImage:
1516
- url: >-
1517
- https://dev-assets.website-files.com/66072f39417a2a35b2589cc7/66072fb51b89448912e2671e_image2.jpeg
1518
- variantPrice:
1519
- unit: USD
1520
- value: '5892'
1521
- string: \$ 53.44 USD
1522
- weight: 38
1523
- width: 76
1524
- height: 85
1525
- length: 40
1526
- purchasedItemsCount: 2
1527
- stripeDetails:
1528
- subscriptionId: sub_1J6xwG2eZvKYlo2CXu9Zt0Tn
1529
- paymentMethod: pm_1OzmzBJYFi4lcbXWHKNdXU7j
1530
- paymentIntentId: pi_3OzmzDJYFi4lcbXW1hTBW6ft
1531
- customerId: cus_PpRsNHwWdUoRKR
1532
- chargeId: ch_3OzmzDJYFi4lcbXW1ndkkrH2
1533
- disputeId: disputeId
1534
- refundId: re_3OzmzDJYFi4lcbXW1kFAmlBk
1535
- refundReason: fraudulent
1536
- stripeCard:
1537
- last4: '4242'
1538
- brand: Visa
1539
- ownerName: Arthur Dent
1540
- expires:
1541
- year: 2024
1542
- month: 4
1543
- paypalDetails:
1544
- orderId: 1a2b3c4d5e6f7g8h9i0j
1545
- payerId: 9k8j7i6h5g4f3e2d1c0b
1546
- captureId: qwe123rty456uio789p
1547
- refundId: abcde12345fghij67890
1548
- refundReason: Customer requested refund
1549
- disputeId: zxcvbnm987poiuytrewq
1550
- customData:
1551
- - key: value
1552
- metadata:
1553
- isBuyNow: false
1554
- isCustomerDeleted: false
1555
- isShippingRequired: true
1556
- hasDownloads: false
1557
- paymentProcessor: stripe
1558
- totals:
1559
- subtotal:
1560
- unit: USD
1561
- value: '5892'
1562
- string: \$ 109.05 USD
1563
- extras:
1564
- - type: tax
1565
- name: State Taxes
1566
- description: NY Taxes (4.00%)
1567
- price:
1568
- unit: USD
1569
- value: '5892'
1570
- string: \$ 4.36 USD
1571
- - type: tax
1572
- name: City Taxes
1573
- description: NEW YORK Taxes (4.88%)
1574
- price:
1575
- unit: USD
1576
- value: '5892'
1577
- string: \$ 5.32 USD
1578
- - type: shipping
1579
- name: Flat
1580
- description: ''
1581
- price:
1582
- unit: USD
1583
- value: '5892'
1584
- string: \$ 0.00 USD
1585
- total:
1586
- unit: USD
1587
- value: '5892'
1588
- string: \$ 118.73 USD
1589
- downloadFiles:
1590
- - id: 5e9a5eba75e0ac242e1b6f64
1591
- name: New product guide
1592
- url: >-
1593
- https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa
1594
- source:
1595
- openapi: ../../../openapi/referenced-specs/v2.yml
1596
- display-name: Orders
1597
- docs: Orders are the orders for your Webflow site.
1598
- webhooks:
1599
- ecomm_new_order:
1600
- audiences: []
1601
- method: POST
1602
- display-name: New eComm Order
1603
- headers: {}
1604
- payload: root.NewOrder
1605
- examples:
1606
- - payload:
1607
- triggerType: ecomm_new_order
1608
- payload:
1609
- orderId: fc7-128
1610
- status: unfulfilled
1611
- comment: >-
1612
- Customer requested gift wrapping and a personalized note saying:
1613
- Happy Birthday, Ford! 🎉 Please ensure the item is packed with
1614
- extra bubble wrap for safe transit.
1615
- orderComment: >-
1616
- Please gift wrap with a personal note saying "Happy Birthday,
1617
- Ford! 🎉
1618
- acceptedOn: '2024-03-29T21:29:21Z'
1619
- fulfilledOn: '2018-12-03T22:06:15Z'
1620
- refundedOn: '2018-12-03T22:06:15Z'
1621
- disputedOn: '2018-12-03T22:06:15Z'
1622
- disputeUpdatedOn: '2018-12-03T22:06:15Z'
1623
- customerPaid:
1624
- unit: USD
1625
- value: '5892'
1626
- string: \$ 118.73 USD
1627
- netAmount:
1628
- unit: USD
1629
- value: '5892'
1630
- string: \$ 112.62 USD
1631
- applicationFee:
1632
- unit: USD
1633
- value: '5892'
1634
- string: \$ 2.37 USD
1635
- allAddresses:
1636
- - type: billing
1637
- addressee: Arthur Dent
1638
- line1: 20 W 34th St
1639
- line2: Empire State Building
1640
- city: New York
1641
- state: New York
1642
- country: US
1643
- postalCode: '10118'
1644
- - type: shipping
1645
- addressee: Arthur Dent
1646
- line1: 20 W 34th St
1647
- line2: Empire State Building
1648
- city: New York
1649
- state: New York
1650
- country: US
1651
- postalCode: '10118'
1652
- shippingAddress:
1653
- type: shipping
1654
- japanType: kanji
1655
- addressee: Arthur Dent
1656
- line1: 20 W 34th St
1657
- line2: Empire State Building
1658
- city: New York
1659
- state: New York
1660
- country: US
1661
- postalCode: '10118'
1662
- billingAddress:
1663
- type: billing
1664
- addressee: Arthur Dent
1665
- line1: 20 W 34th St
1666
- line2: Empire State Building
1667
- city: New York
1668
- state: New York
1669
- country: US
1670
- postalCode: '10118'
1671
- shippingProvider: Shipping Company, Co.
1672
- shippingTracking: tr00000000001
1673
- shippingTrackingURL: https://www.shippingcompany.com/tracking/tr00000000001
1674
- customerInfo:
1675
- fullName: Arthur Dent
1676
- email: arthur.dent@example.com
1677
- purchasedItems:
1678
- - count: 1
1679
- rowTotal:
1680
- unit: USD
1681
- value: '5892'
1682
- string: \$ 55.61 USD
1683
- productId: 66072fb61b89448912e26791
1684
- productName: Luxurious Fresh Ball
1685
- productSlug: luxurious-fresh-ball
1686
- variantId: 66072fb71b89448912e2683f
1687
- variantName: 'Luxurious Fresh Ball Generic: Bronze, Practical: Plastic'
1688
- variantSlug: luxurious-fresh-ball-generic-bronze-practical-plastic
1689
- variantSKU: luxurious-fresh-ball-generic-bronze-practical-plastic
1690
- variantImage:
1691
- url: >-
1692
- https://dev-assets.website-files.com/66072f39417a2a35b2589cc7/66072fb51b89448912e2672c_image14.jpeg
1693
- variantPrice:
1694
- unit: USD
1695
- value: '5892'
1696
- string: \$ 55.61 USD
1697
- weight: 11
1698
- width: 82
1699
- height: 70
1700
- length: 9
1701
- - count: 1
1702
- rowTotal:
1703
- unit: USD
1704
- value: '5892'
1705
- string: \$ 53.44 USD
1706
- productId: 66072fb61b89448912e26799
1707
- productName: Recycled Steel Gloves
1708
- productSlug: recycled-steel-gloves
1709
- variantId: 66072fb91b89448912e26ab9
1710
- variantName: 'Recycled Steel Gloves Electronic: Granite, Handcrafted: grey'
1711
- variantSlug: recycled-steel-gloves-electronic-granite-handcrafted-grey
1712
- variantSKU: recycled-steel-gloves-electronic-granite-handcrafted-grey
1713
- variantImage:
1714
- url: >-
1715
- https://dev-assets.website-files.com/66072f39417a2a35b2589cc7/66072fb51b89448912e2671e_image2.jpeg
1716
- variantPrice:
1717
- unit: USD
1718
- value: '5892'
1719
- string: \$ 53.44 USD
1720
- weight: 38
1721
- width: 76
1722
- height: 85
1723
- length: 40
1724
- purchasedItemsCount: 2
1725
- stripeDetails:
1726
- subscriptionId: sub_1J6xwG2eZvKYlo2CXu9Zt0Tn
1727
- paymentMethod: pm_1OzmzBJYFi4lcbXWHKNdXU7j
1728
- paymentIntentId: pi_3OzmzDJYFi4lcbXW1hTBW6ft
1729
- customerId: cus_PpRsNHwWdUoRKR
1730
- chargeId: ch_3OzmzDJYFi4lcbXW1ndkkrH2
1731
- refundId: re_3OzmzDJYFi4lcbXW1kFAmlBk
1732
- refundReason: fraudulent
1733
- stripeCard:
1734
- last4: '4242'
1735
- brand: Visa
1736
- ownerName: Arthur Dent
1737
- expires:
1738
- year: 2024
1739
- month: 4
1740
- customData:
1741
- - key: value
1742
- metadata:
1743
- isBuyNow: false
1744
- isCustomerDeleted: false
1745
- isShippingRequired: true
1746
- hasDownloads: false
1747
- paymentProcessor: stripe
1748
- totals:
1749
- subtotal:
1750
- unit: USD
1751
- value: '5892'
1752
- string: \$ 109.05 USD
1753
- extras:
1754
- - type: tax
1755
- name: State Taxes
1756
- description: NY Taxes (4.00%)
1757
- price:
1758
- unit: USD
1759
- value: '5892'
1760
- string: \$ 4.36 USD
1761
- - type: tax
1762
- name: City Taxes
1763
- description: NEW YORK Taxes (4.88%)
1764
- price:
1765
- unit: USD
1766
- value: '5892'
1767
- string: \$ 5.32 USD
1768
- - type: shipping
1769
- name: Flat
1770
- description: ''
1771
- price:
1772
- unit: USD
1773
- value: '5892'
1774
- string: \$ 0.00 USD
1775
- total:
1776
- unit: USD
1777
- value: '5892'
1778
- string: \$ 118.73 USD
1779
- downloadFiles:
1780
- - id: 5e9a5eba75e0ac242e1b6f64
1781
- name: New product guide
1782
- url: >-
1783
- https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa
1784
- docs: Information about a new ecommerce order
1785
- ecomm_order_changed:
1786
- audiences: []
1787
- method: POST
1788
- display-name: Updated eComm Order
1789
- headers: {}
1790
- payload: root.UpdatedOrder
1791
- examples:
1792
- - payload:
1793
- triggerType: ecomm_order_changed
1794
- payload:
1795
- orderId: fc7-128
1796
- status: refunded
1797
- comment: >-
1798
- Customer requested gift wrapping and a personalized note saying:
1799
- Happy Birthday, Ford! 🎉 Please ensure the item is packed with
1800
- extra bubble wrap for safe transit.
1801
- orderComment: >-
1802
- Please gift wrap with a personal note saying "Happy Birthday,
1803
- Ford! 🎉
1804
- acceptedOn: '2024-03-29T21:29:21Z'
1805
- fulfilledOn: '2024-03-29T21:29:21Z'
1806
- refundedOn: '2024-04-08T18:25:04Z'
1807
- disputedOn: '2024-03-29T21:29:21Z'
1808
- disputeUpdatedOn: '2024-03-29T21:29:21Z'
1809
- disputeLastStatus: charge_refunded
1810
- customerPaid:
1811
- unit: USD
1812
- value: '5892'
1813
- string: \$ 118.73 USD
1814
- netAmount:
1815
- unit: USD
1816
- value: '5892'
1817
- string: \$ 112.62 USD
1818
- applicationFee:
1819
- unit: USD
1820
- value: '5892'
1821
- string: \$ 2.37 USD
1822
- allAddresses:
1823
- - type: billing
1824
- addressee: Arthur Dent
1825
- line1: 20 W 34th St
1826
- line2: Empire State Building
1827
- city: New York
1828
- state: New York
1829
- country: US
1830
- postalCode: '10118'
1831
- - type: shipping
1832
- addressee: Arthur Dent
1833
- line1: 20 W 34th St
1834
- line2: Empire State Building
1835
- city: New York
1836
- state: New York
1837
- country: US
1838
- postalCode: '10118'
1839
- shippingAddress:
1840
- type: shipping
1841
- japanType: kanji
1842
- addressee: Arthur Dent
1843
- line1: 20 W 34th St
1844
- line2: Empire State Building
1845
- city: New York
1846
- state: New York
1847
- country: US
1848
- postalCode: '10118'
1849
- billingAddress:
1850
- type: billing
1851
- addressee: Arthur Dent
1852
- line1: 20 W 34th St
1853
- line2: Empire State Building
1854
- city: New York
1855
- state: New York
1856
- country: US
1857
- postalCode: '10118'
1858
- shippingProvider: Shipping Company, Co.
1859
- shippingTracking: tr00000000001
1860
- shippingTrackingURL: https://www.shippingcompany.com/tracking/tr00000000001
1861
- customerInfo:
1862
- fullName: Arthur Dent
1863
- email: arthur.dent@example.com
1864
- purchasedItems:
1865
- - count: 1
1866
- rowTotal:
1867
- unit: USD
1868
- value: '5892'
1869
- string: \$ 55.61 USD
1870
- productId: 66072fb61b89448912e26791
1871
- productName: Luxurious Fresh Ball
1872
- productSlug: luxurious-fresh-ball
1873
- variantId: 66072fb71b89448912e2683f
1874
- variantName: 'Luxurious Fresh Ball Generic: Bronze, Practical: Plastic'
1875
- variantSlug: luxurious-fresh-ball-generic-bronze-practical-plastic
1876
- variantSKU: luxurious-fresh-ball-generic-bronze-practical-plastic
1877
- variantImage:
1878
- url: >-
1879
- https://dev-assets.website-files.com/66072f39417a2a35b2589cc7/66072fb51b89448912e2672c_image14.jpeg
1880
- variantPrice:
1881
- unit: USD
1882
- value: '5892'
1883
- string: \$ 55.61 USD
1884
- weight: 11
1885
- width: 82
1886
- height: 70
1887
- length: 9
1888
- - count: 1
1889
- rowTotal:
1890
- unit: USD
1891
- value: '5892'
1892
- string: \$ 53.44 USD
1893
- productId: 66072fb61b89448912e26799
1894
- productName: Recycled Steel Gloves
1895
- productSlug: recycled-steel-gloves
1896
- variantId: 66072fb91b89448912e26ab9
1897
- variantName: 'Recycled Steel Gloves Electronic: Granite, Handcrafted: grey'
1898
- variantSlug: recycled-steel-gloves-electronic-granite-handcrafted-grey
1899
- variantSKU: recycled-steel-gloves-electronic-granite-handcrafted-grey
1900
- variantImage:
1901
- url: >-
1902
- https://dev-assets.website-files.com/66072f39417a2a35b2589cc7/66072fb51b89448912e2671e_image2.jpeg
1903
- variantPrice:
1904
- unit: USD
1905
- value: '5892'
1906
- string: \$ 53.44 USD
1907
- weight: 38
1908
- width: 76
1909
- height: 85
1910
- length: 40
1911
- purchasedItemsCount: 2
1912
- stripeDetails:
1913
- subscriptionId: sub_1J6xwG2eZvKYlo2CXu9Zt0Tn
1914
- paymentMethod: pm_1OzmzBJYFi4lcbXWHKNdXU7j
1915
- paymentIntentId: pi_3OzmzDJYFi4lcbXW1hTBW6ft
1916
- customerId: cus_PpRsNHwWdUoRKR
1917
- chargeId: ch_3OzmzDJYFi4lcbXW1ndkkrH2
1918
- refundId: re_3OzmzDJYFi4lcbXW1kFAmlBk
1919
- refundReason: fraudulent
1920
- stripeCard:
1921
- last4: '4242'
1922
- brand: Visa
1923
- ownerName: Arthur Dent
1924
- expires:
1925
- year: 2024
1926
- month: 4
1927
- customData:
1928
- - key: value
1929
- metadata:
1930
- isBuyNow: false
1931
- isCustomerDeleted: false
1932
- isShippingRequired: true
1933
- hasDownloads: false
1934
- paymentProcessor: stripe
1935
- totals:
1936
- subtotal:
1937
- unit: USD
1938
- value: '5892'
1939
- string: \$ 109.05 USD
1940
- extras:
1941
- - type: tax
1942
- name: State Taxes
1943
- description: NY Taxes (4.00%)
1944
- price:
1945
- unit: USD
1946
- value: '5892'
1947
- string: \$ 4.36 USD
1948
- - type: tax
1949
- name: City Taxes
1950
- description: NEW YORK Taxes (4.88%)
1951
- price:
1952
- unit: USD
1953
- value: '5892'
1954
- string: \$ 5.32 USD
1955
- - type: shipping
1956
- name: Flat
1957
- description: ''
1958
- price:
1959
- unit: USD
1960
- value: '5892'
1961
- string: \$ 0.00 USD
1962
- total:
1963
- unit: USD
1964
- value: '5892'
1965
- string: \$ 118.73 USD
1966
- downloadFiles:
1967
- - id: 5e9a5eba75e0ac242e1b6f64
1968
- name: New product guide
1969
- url: >-
1970
- https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa
1971
- docs: Information about an updated ecommerce order