webflow-api 2.4.0 → 2.5.0

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 (457) hide show
  1. package/.mock/definition/__package__.yml +2495 -0
  2. package/.mock/definition/accessGroups.yml +80 -0
  3. package/.mock/definition/api.yml +13 -0
  4. package/.mock/definition/assets.yml +414 -0
  5. package/.mock/definition/collections/fields.yml +187 -0
  6. package/.mock/definition/collections/items.yml +1511 -0
  7. package/.mock/definition/collections.yml +185 -0
  8. package/.mock/definition/ecommerce.yml +42 -0
  9. package/.mock/definition/forms.yml +301 -0
  10. package/.mock/definition/inventory.yml +120 -0
  11. package/.mock/definition/orders.yml +1569 -0
  12. package/.mock/definition/pages/scripts.yml +169 -0
  13. package/.mock/definition/pages.yml +443 -0
  14. package/.mock/definition/products.yml +500 -0
  15. package/.mock/definition/scripts.yml +257 -0
  16. package/.mock/definition/sites/activityLogs.yml +65 -0
  17. package/.mock/definition/sites/scripts.yml +228 -0
  18. package/.mock/definition/sites.yml +299 -0
  19. package/.mock/definition/token.yml +71 -0
  20. package/.mock/definition/users.yml +392 -0
  21. package/.mock/definition/webhooks.yml +189 -0
  22. package/.mock/fern.config.json +4 -0
  23. package/Client.d.ts +2 -0
  24. package/README.md +23 -30
  25. package/api/errors/InternalServerError.d.ts +2 -1
  26. package/api/errors/NotFoundError.d.ts +2 -1
  27. package/api/errors/TooManyRequestsError.d.ts +1 -1
  28. package/api/errors/UnauthorizedError.d.ts +2 -1
  29. package/api/resources/accessGroups/client/Client.d.ts +5 -1
  30. package/api/resources/accessGroups/client/Client.js +27 -15
  31. package/api/resources/assets/client/Client.d.ts +31 -11
  32. package/api/resources/assets/client/Client.js +236 -126
  33. package/api/resources/assets/client/requests/AssetsCreateRequest.d.ts +2 -2
  34. package/api/resources/assets/client/requests/AssetsUpdateRequest.d.ts +5 -5
  35. package/api/resources/collections/client/Client.d.ts +15 -22
  36. package/api/resources/collections/client/Client.js +109 -137
  37. package/api/resources/collections/resources/fields/client/Client.d.ts +34 -2
  38. package/api/resources/collections/resources/fields/client/Client.js +163 -32
  39. package/api/resources/collections/resources/items/client/Client.d.ts +302 -30
  40. package/api/resources/collections/resources/items/client/Client.js +959 -221
  41. package/api/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.d.ts +61 -0
  42. package/api/resources/collections/resources/items/client/requests/ItemsDeleteItemsLiveRequest.d.ts +11 -0
  43. package/api/resources/collections/resources/items/client/requests/ItemsDeleteItemsRequest.d.ts +11 -0
  44. package/api/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.d.ts +128 -0
  45. package/api/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.d.ts +128 -0
  46. package/api/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.js +5 -0
  47. package/api/resources/collections/resources/items/client/requests/index.d.ts +5 -0
  48. package/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +5 -0
  49. package/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.js +5 -0
  50. package/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts +14 -0
  51. package/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.js +5 -0
  52. package/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataName.d.ts +14 -0
  53. package/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataName.js +5 -0
  54. package/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.d.ts +5 -0
  55. package/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.js +5 -0
  56. package/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.d.ts +8 -0
  57. package/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.js +5 -0
  58. package/api/resources/collections/resources/items/types/ItemsCreateItemRequest.d.ts +5 -0
  59. package/api/resources/collections/resources/items/types/ItemsCreateItemRequest.js +5 -0
  60. package/api/resources/collections/resources/items/types/ItemsCreateItemRequestItems.d.ts +8 -0
  61. package/api/resources/collections/resources/items/types/ItemsCreateItemRequestItems.js +5 -0
  62. package/api/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.d.ts +9 -0
  63. package/api/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.js +5 -0
  64. package/api/resources/collections/resources/items/types/ItemsDeleteItemsRequestItemsItem.d.ts +9 -0
  65. package/api/resources/collections/resources/items/types/ItemsDeleteItemsRequestItemsItem.js +5 -0
  66. package/api/resources/collections/resources/items/types/index.d.ts +9 -0
  67. package/api/resources/collections/resources/items/types/index.js +9 -0
  68. package/api/resources/ecommerce/client/Client.d.ts +2 -0
  69. package/api/resources/ecommerce/client/Client.js +24 -14
  70. package/api/resources/forms/client/Client.d.ts +17 -5
  71. package/api/resources/forms/client/Client.js +140 -76
  72. package/api/resources/inventory/client/Client.d.ts +8 -1
  73. package/api/resources/inventory/client/Client.js +59 -30
  74. package/api/resources/orders/client/Client.d.ts +7 -2
  75. package/api/resources/orders/client/Client.js +164 -89
  76. package/api/resources/pages/client/Client.d.ts +25 -14
  77. package/api/resources/pages/client/Client.js +169 -100
  78. package/api/resources/pages/client/requests/DomWrite.d.ts +6 -6
  79. package/api/resources/pages/client/requests/PagesGetContentRequest.d.ts +2 -2
  80. package/api/resources/pages/client/requests/PagesGetMetadataRequest.d.ts +2 -2
  81. package/api/resources/pages/client/requests/PagesListRequest.d.ts +2 -2
  82. package/api/resources/pages/client/requests/UpdatePageSettingsRequest.d.ts +3 -4
  83. package/api/resources/pages/resources/scripts/client/Client.d.ts +29 -3
  84. package/api/resources/pages/resources/scripts/client/Client.js +104 -46
  85. package/api/resources/products/client/Client.d.ts +26 -10
  86. package/api/resources/products/client/Client.js +188 -98
  87. package/api/resources/scripts/client/Client.d.ts +31 -3
  88. package/api/resources/scripts/client/Client.js +111 -47
  89. package/api/resources/sites/client/Client.d.ts +16 -4
  90. package/api/resources/sites/client/Client.js +101 -59
  91. package/api/resources/sites/client/requests/SitesPublishRequest.d.ts +1 -1
  92. package/api/resources/sites/resources/activityLogs/client/Client.d.ts +2 -0
  93. package/api/resources/sites/resources/activityLogs/client/Client.js +17 -13
  94. package/api/resources/sites/resources/scripts/client/Client.d.ts +26 -4
  95. package/api/resources/sites/resources/scripts/client/Client.js +125 -61
  96. package/api/resources/token/client/Client.d.ts +7 -2
  97. package/api/resources/token/client/Client.js +23 -24
  98. package/api/resources/users/client/Client.d.ts +21 -6
  99. package/api/resources/users/client/Client.js +149 -78
  100. package/api/resources/webhooks/client/Client.d.ts +15 -2
  101. package/api/resources/webhooks/client/Client.js +114 -59
  102. package/api/types/AssetFolder.d.ts +1 -1
  103. package/api/types/AuthorizationAuthorization.d.ts +1 -1
  104. package/api/types/AuthorizedUser.d.ts +1 -1
  105. package/api/types/BulkCollectionItemFieldData.d.ts +1 -1
  106. package/api/types/CollectionItem.d.ts +1 -1
  107. package/api/types/CollectionItemFieldData.d.ts +1 -1
  108. package/api/types/CollectionItemListNoPagination.d.ts +11 -0
  109. package/api/types/CollectionItemListNoPagination.js +5 -0
  110. package/api/types/CollectionItemWithIdInput.d.ts +24 -0
  111. package/api/types/CollectionItemWithIdInput.js +5 -0
  112. package/api/types/CollectionItemWithIdInputFieldData.d.ts +11 -0
  113. package/api/types/CollectionItemWithIdInputFieldData.js +5 -0
  114. package/api/types/ConflictErrorBody.d.ts +1 -10
  115. package/api/types/CustomCodeBlock.d.ts +2 -2
  116. package/api/types/DuplicateUserEmail.d.ts +1 -11
  117. package/api/types/ErrorCode.d.ts +38 -0
  118. package/api/types/ErrorCode.js +37 -0
  119. package/api/types/Error_.d.ts +1 -1
  120. package/api/types/ForbiddenErrorBody.d.ts +2 -7
  121. package/api/types/Form.d.ts +8 -8
  122. package/api/types/FormSubmission.d.ts +3 -3
  123. package/api/types/InvalidScopes.d.ts +4 -0
  124. package/api/types/InvalidScopes.js +5 -0
  125. package/api/types/NotEnterprisePlanSite.d.ts +1 -11
  126. package/api/types/Order.d.ts +5 -1
  127. package/api/types/Page.d.ts +2 -0
  128. package/api/types/Site.d.ts +4 -0
  129. package/api/types/SiteActivityLogItem.d.ts +1 -1
  130. package/api/types/SiteActivityLogItemEvent.d.ts +48 -0
  131. package/api/types/SiteActivityLogItemEvent.js +50 -0
  132. package/api/types/SiteActivityLogItemResourceOperation.d.ts +5 -1
  133. package/api/types/SiteActivityLogItemResourceOperation.js +4 -0
  134. package/api/types/SiteDataCollectionType.d.ts +12 -0
  135. package/api/types/SiteDataCollectionType.js +11 -0
  136. package/api/types/UserLimitReached.d.ts +1 -11
  137. package/api/types/UsersNotEnabled.d.ts +1 -11
  138. package/api/types/index.d.ts +10 -6
  139. package/api/types/index.js +10 -6
  140. package/core/fetcher/Fetcher.d.ts +1 -1
  141. package/core/fetcher/getResponseBody.js +3 -0
  142. package/core/fetcher/requestWithRetries.js +13 -4
  143. package/core/schemas/builders/object/object.js +28 -0
  144. package/core/schemas/builders/object/types.d.ts +5 -0
  145. package/dist/Client.d.ts +2 -0
  146. package/dist/api/errors/InternalServerError.d.ts +2 -1
  147. package/dist/api/errors/NotFoundError.d.ts +2 -1
  148. package/dist/api/errors/TooManyRequestsError.d.ts +1 -1
  149. package/dist/api/errors/UnauthorizedError.d.ts +2 -1
  150. package/dist/api/resources/accessGroups/client/Client.d.ts +5 -1
  151. package/dist/api/resources/accessGroups/client/Client.js +27 -15
  152. package/dist/api/resources/assets/client/Client.d.ts +31 -11
  153. package/dist/api/resources/assets/client/Client.js +236 -126
  154. package/dist/api/resources/assets/client/requests/AssetsCreateRequest.d.ts +2 -2
  155. package/dist/api/resources/assets/client/requests/AssetsUpdateRequest.d.ts +5 -5
  156. package/dist/api/resources/collections/client/Client.d.ts +15 -22
  157. package/dist/api/resources/collections/client/Client.js +109 -137
  158. package/dist/api/resources/collections/resources/fields/client/Client.d.ts +34 -2
  159. package/dist/api/resources/collections/resources/fields/client/Client.js +163 -32
  160. package/dist/api/resources/collections/resources/items/client/Client.d.ts +302 -30
  161. package/dist/api/resources/collections/resources/items/client/Client.js +959 -221
  162. package/dist/api/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.d.ts +61 -0
  163. package/dist/api/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.js +5 -0
  164. package/dist/api/resources/collections/resources/items/client/requests/ItemsDeleteItemsLiveRequest.d.ts +11 -0
  165. package/dist/api/resources/collections/resources/items/client/requests/ItemsDeleteItemsLiveRequest.js +5 -0
  166. package/dist/api/resources/collections/resources/items/client/requests/ItemsDeleteItemsRequest.d.ts +11 -0
  167. package/dist/api/resources/collections/resources/items/client/requests/ItemsDeleteItemsRequest.js +5 -0
  168. package/dist/api/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.d.ts +128 -0
  169. package/dist/api/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.js +5 -0
  170. package/dist/api/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.d.ts +128 -0
  171. package/dist/api/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.js +5 -0
  172. package/dist/api/resources/collections/resources/items/client/requests/index.d.ts +5 -0
  173. package/dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +5 -0
  174. package/dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.js +5 -0
  175. package/dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts +14 -0
  176. package/dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.js +5 -0
  177. package/dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataName.d.ts +14 -0
  178. package/dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataName.js +5 -0
  179. package/dist/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.d.ts +5 -0
  180. package/dist/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.js +5 -0
  181. package/dist/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.d.ts +8 -0
  182. package/dist/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.js +5 -0
  183. package/dist/api/resources/collections/resources/items/types/ItemsCreateItemRequest.d.ts +5 -0
  184. package/dist/api/resources/collections/resources/items/types/ItemsCreateItemRequest.js +5 -0
  185. package/dist/api/resources/collections/resources/items/types/ItemsCreateItemRequestItems.d.ts +8 -0
  186. package/dist/api/resources/collections/resources/items/types/ItemsCreateItemRequestItems.js +5 -0
  187. package/dist/api/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.d.ts +9 -0
  188. package/dist/api/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.js +5 -0
  189. package/dist/api/resources/collections/resources/items/types/ItemsDeleteItemsRequestItemsItem.d.ts +9 -0
  190. package/dist/api/resources/collections/resources/items/types/ItemsDeleteItemsRequestItemsItem.js +5 -0
  191. package/dist/api/resources/collections/resources/items/types/index.d.ts +9 -0
  192. package/dist/api/resources/collections/resources/items/types/index.js +9 -0
  193. package/dist/api/resources/ecommerce/client/Client.d.ts +2 -0
  194. package/dist/api/resources/ecommerce/client/Client.js +24 -14
  195. package/dist/api/resources/forms/client/Client.d.ts +17 -5
  196. package/dist/api/resources/forms/client/Client.js +140 -76
  197. package/dist/api/resources/inventory/client/Client.d.ts +8 -1
  198. package/dist/api/resources/inventory/client/Client.js +59 -30
  199. package/dist/api/resources/orders/client/Client.d.ts +7 -2
  200. package/dist/api/resources/orders/client/Client.js +164 -89
  201. package/dist/api/resources/pages/client/Client.d.ts +25 -14
  202. package/dist/api/resources/pages/client/Client.js +169 -100
  203. package/dist/api/resources/pages/client/requests/DomWrite.d.ts +6 -6
  204. package/dist/api/resources/pages/client/requests/PagesGetContentRequest.d.ts +2 -2
  205. package/dist/api/resources/pages/client/requests/PagesGetMetadataRequest.d.ts +2 -2
  206. package/dist/api/resources/pages/client/requests/PagesListRequest.d.ts +2 -2
  207. package/dist/api/resources/pages/client/requests/UpdatePageSettingsRequest.d.ts +3 -4
  208. package/dist/api/resources/pages/resources/scripts/client/Client.d.ts +29 -3
  209. package/dist/api/resources/pages/resources/scripts/client/Client.js +104 -46
  210. package/dist/api/resources/products/client/Client.d.ts +26 -10
  211. package/dist/api/resources/products/client/Client.js +188 -98
  212. package/dist/api/resources/scripts/client/Client.d.ts +31 -3
  213. package/dist/api/resources/scripts/client/Client.js +111 -47
  214. package/dist/api/resources/sites/client/Client.d.ts +16 -4
  215. package/dist/api/resources/sites/client/Client.js +101 -59
  216. package/dist/api/resources/sites/client/requests/SitesPublishRequest.d.ts +1 -1
  217. package/dist/api/resources/sites/resources/activityLogs/client/Client.d.ts +2 -0
  218. package/dist/api/resources/sites/resources/activityLogs/client/Client.js +17 -13
  219. package/dist/api/resources/sites/resources/scripts/client/Client.d.ts +26 -4
  220. package/dist/api/resources/sites/resources/scripts/client/Client.js +125 -61
  221. package/dist/api/resources/token/client/Client.d.ts +7 -2
  222. package/dist/api/resources/token/client/Client.js +23 -24
  223. package/dist/api/resources/users/client/Client.d.ts +21 -6
  224. package/dist/api/resources/users/client/Client.js +149 -78
  225. package/dist/api/resources/webhooks/client/Client.d.ts +15 -2
  226. package/dist/api/resources/webhooks/client/Client.js +114 -59
  227. package/dist/api/types/AssetFolder.d.ts +1 -1
  228. package/dist/api/types/AuthorizationAuthorization.d.ts +1 -1
  229. package/dist/api/types/AuthorizedUser.d.ts +1 -1
  230. package/dist/api/types/BulkCollectionItemFieldData.d.ts +1 -1
  231. package/dist/api/types/CollectionItem.d.ts +1 -1
  232. package/dist/api/types/CollectionItemFieldData.d.ts +1 -1
  233. package/dist/api/types/CollectionItemListNoPagination.d.ts +11 -0
  234. package/dist/api/types/CollectionItemListNoPagination.js +5 -0
  235. package/dist/api/types/CollectionItemWithIdInput.d.ts +24 -0
  236. package/dist/api/types/CollectionItemWithIdInput.js +5 -0
  237. package/dist/api/types/CollectionItemWithIdInputFieldData.d.ts +11 -0
  238. package/dist/api/types/CollectionItemWithIdInputFieldData.js +5 -0
  239. package/dist/api/types/ConflictErrorBody.d.ts +1 -10
  240. package/dist/api/types/CustomCodeBlock.d.ts +2 -2
  241. package/dist/api/types/DuplicateUserEmail.d.ts +1 -11
  242. package/dist/api/types/ErrorCode.d.ts +38 -0
  243. package/dist/api/types/ErrorCode.js +37 -0
  244. package/dist/api/types/Error_.d.ts +1 -1
  245. package/dist/api/types/ForbiddenErrorBody.d.ts +2 -7
  246. package/dist/api/types/Form.d.ts +8 -8
  247. package/dist/api/types/FormSubmission.d.ts +3 -3
  248. package/dist/api/types/InvalidScopes.d.ts +4 -0
  249. package/dist/api/types/InvalidScopes.js +5 -0
  250. package/dist/api/types/NotEnterprisePlanSite.d.ts +1 -11
  251. package/dist/api/types/Order.d.ts +5 -1
  252. package/dist/api/types/Page.d.ts +2 -0
  253. package/dist/api/types/Site.d.ts +4 -0
  254. package/dist/api/types/SiteActivityLogItem.d.ts +1 -1
  255. package/dist/api/types/SiteActivityLogItemEvent.d.ts +48 -0
  256. package/dist/api/types/SiteActivityLogItemEvent.js +50 -0
  257. package/dist/api/types/SiteActivityLogItemResourceOperation.d.ts +5 -1
  258. package/dist/api/types/SiteActivityLogItemResourceOperation.js +4 -0
  259. package/dist/api/types/SiteDataCollectionType.d.ts +12 -0
  260. package/dist/api/types/SiteDataCollectionType.js +11 -0
  261. package/dist/api/types/UserLimitReached.d.ts +1 -11
  262. package/dist/api/types/UsersNotEnabled.d.ts +1 -11
  263. package/dist/api/types/index.d.ts +10 -6
  264. package/dist/api/types/index.js +10 -6
  265. package/dist/core/fetcher/Fetcher.d.ts +1 -1
  266. package/dist/core/fetcher/getResponseBody.js +3 -0
  267. package/dist/core/fetcher/requestWithRetries.js +13 -4
  268. package/dist/core/schemas/builders/object/object.js +28 -0
  269. package/dist/core/schemas/builders/object/types.d.ts +5 -0
  270. package/dist/errors/WebflowTimeoutError.d.ts +1 -1
  271. package/dist/errors/WebflowTimeoutError.js +2 -2
  272. package/dist/serialization/resources/assets/client/requests/AssetsUpdateRequest.d.ts +2 -1
  273. package/dist/serialization/resources/assets/client/requests/AssetsUpdateRequest.js +2 -1
  274. package/dist/serialization/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.d.ts +16 -0
  275. package/dist/serialization/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.js +37 -0
  276. package/dist/serialization/resources/collections/resources/items/client/requests/ItemsDeleteItemsLiveRequest.d.ts +13 -0
  277. package/dist/serialization/resources/collections/resources/items/client/requests/ItemsDeleteItemsLiveRequest.js +34 -0
  278. package/dist/serialization/resources/collections/resources/items/client/requests/ItemsDeleteItemsRequest.d.ts +13 -0
  279. package/dist/serialization/resources/collections/resources/items/client/requests/ItemsDeleteItemsRequest.js +34 -0
  280. package/dist/serialization/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.d.ts +13 -0
  281. package/dist/serialization/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.js +34 -0
  282. package/dist/serialization/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.d.ts +13 -0
  283. package/dist/serialization/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.js +34 -0
  284. package/dist/serialization/resources/collections/resources/items/client/requests/index.d.ts +5 -0
  285. package/dist/serialization/resources/collections/resources/items/client/requests/index.js +11 -1
  286. package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +12 -0
  287. package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.js +36 -0
  288. package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts +14 -0
  289. package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.js +36 -0
  290. package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataName.d.ts +14 -0
  291. package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataName.js +36 -0
  292. package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.d.ts +12 -0
  293. package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.js +33 -0
  294. package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.d.ts +13 -0
  295. package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.js +34 -0
  296. package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemRequest.d.ts +12 -0
  297. package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemRequest.js +33 -0
  298. package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemRequestItems.d.ts +13 -0
  299. package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemRequestItems.js +34 -0
  300. package/dist/serialization/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.d.ts +13 -0
  301. package/dist/serialization/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.js +34 -0
  302. package/dist/serialization/resources/collections/resources/items/types/ItemsDeleteItemsRequestItemsItem.d.ts +13 -0
  303. package/dist/serialization/resources/collections/resources/items/types/ItemsDeleteItemsRequestItemsItem.js +34 -0
  304. package/dist/serialization/resources/collections/resources/items/types/index.d.ts +9 -0
  305. package/dist/serialization/resources/collections/resources/items/types/index.js +9 -0
  306. package/dist/serialization/resources/pages/client/requests/DomWrite.d.ts +1 -1
  307. package/dist/serialization/types/BulkCollectionItemFieldData.js +4 -2
  308. package/dist/serialization/types/CollectionItem.d.ts +1 -1
  309. package/dist/serialization/types/CollectionItem.js +1 -1
  310. package/dist/serialization/types/CollectionItemFieldData.js +4 -2
  311. package/dist/serialization/types/CollectionItemListNoPagination.d.ts +13 -0
  312. package/dist/serialization/types/{TooManyRequestsErrorBody.js → CollectionItemListNoPagination.js} +4 -6
  313. package/dist/serialization/types/CollectionItemWithIdInput.d.ts +20 -0
  314. package/dist/serialization/types/CollectionItemWithIdInput.js +41 -0
  315. package/dist/serialization/types/CollectionItemWithIdInputFieldData.d.ts +14 -0
  316. package/dist/serialization/types/{MissingScopes.js → CollectionItemWithIdInputFieldData.js} +7 -8
  317. package/dist/serialization/types/ConflictErrorBody.d.ts +4 -8
  318. package/dist/serialization/types/ConflictErrorBody.js +3 -7
  319. package/dist/serialization/types/DuplicateUserEmail.d.ts +2 -8
  320. package/dist/serialization/types/DuplicateUserEmail.js +1 -7
  321. package/dist/serialization/types/ErrorCode.d.ts +10 -0
  322. package/dist/serialization/types/ErrorCode.js +61 -0
  323. package/dist/serialization/types/Error_.d.ts +2 -1
  324. package/dist/serialization/types/Error_.js +2 -1
  325. package/dist/serialization/types/ForbiddenErrorBody.d.ts +4 -8
  326. package/dist/serialization/types/ForbiddenErrorBody.js +3 -7
  327. package/dist/serialization/types/Form.d.ts +1 -1
  328. package/dist/serialization/types/Form.js +1 -1
  329. package/dist/serialization/types/InvalidScopes.d.ts +10 -0
  330. package/{serialization/types/MissingScopes.js → dist/serialization/types/InvalidScopes.js} +2 -8
  331. package/dist/serialization/types/NotEnterprisePlanSite.d.ts +2 -8
  332. package/dist/serialization/types/NotEnterprisePlanSite.js +1 -7
  333. package/dist/serialization/types/Page.d.ts +1 -0
  334. package/dist/serialization/types/Page.js +1 -0
  335. package/dist/serialization/types/Site.d.ts +3 -0
  336. package/dist/serialization/types/Site.js +3 -0
  337. package/dist/serialization/types/SiteActivityLogItem.d.ts +2 -1
  338. package/dist/serialization/types/SiteActivityLogItem.js +2 -1
  339. package/dist/serialization/types/SiteActivityLogItemEvent.d.ts +10 -0
  340. package/dist/serialization/types/SiteActivityLogItemEvent.js +74 -0
  341. package/dist/serialization/types/SiteActivityLogItemResourceOperation.d.ts +1 -1
  342. package/dist/serialization/types/SiteActivityLogItemResourceOperation.js +11 -1
  343. package/dist/serialization/types/SiteDataCollectionType.d.ts +10 -0
  344. package/dist/serialization/types/SiteDataCollectionType.js +31 -0
  345. package/dist/serialization/types/UserLimitReached.d.ts +2 -8
  346. package/dist/serialization/types/UserLimitReached.js +1 -7
  347. package/dist/serialization/types/UsersNotEnabled.d.ts +2 -8
  348. package/dist/serialization/types/UsersNotEnabled.js +1 -7
  349. package/dist/serialization/types/index.d.ts +10 -5
  350. package/dist/serialization/types/index.js +10 -5
  351. package/dist/version.d.ts +1 -1
  352. package/dist/version.js +1 -1
  353. package/dist/wrapper/ItemsClient.d.ts +23 -49
  354. package/dist/wrapper/ItemsClient.js +50 -216
  355. package/dist/wrapper/WebflowClient.d.ts +1 -1
  356. package/dist/wrapper/WebflowClient.js +11 -1
  357. package/errors/WebflowTimeoutError.d.ts +1 -1
  358. package/errors/WebflowTimeoutError.js +2 -2
  359. package/package.json +1 -2
  360. package/reference.md +821 -230
  361. package/serialization/resources/assets/client/requests/AssetsUpdateRequest.d.ts +2 -1
  362. package/serialization/resources/assets/client/requests/AssetsUpdateRequest.js +2 -1
  363. package/serialization/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.d.ts +16 -0
  364. package/serialization/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.js +37 -0
  365. package/serialization/resources/collections/resources/items/client/requests/ItemsDeleteItemsLiveRequest.d.ts +13 -0
  366. package/serialization/resources/collections/resources/items/client/requests/ItemsDeleteItemsLiveRequest.js +34 -0
  367. package/serialization/resources/collections/resources/items/client/requests/ItemsDeleteItemsRequest.d.ts +13 -0
  368. package/serialization/resources/collections/resources/items/client/requests/ItemsDeleteItemsRequest.js +34 -0
  369. package/serialization/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.d.ts +13 -0
  370. package/serialization/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.js +34 -0
  371. package/serialization/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.d.ts +13 -0
  372. package/serialization/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.js +34 -0
  373. package/serialization/resources/collections/resources/items/client/requests/index.d.ts +5 -0
  374. package/serialization/resources/collections/resources/items/client/requests/index.js +11 -1
  375. package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +12 -0
  376. package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.js +36 -0
  377. package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts +14 -0
  378. package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.js +36 -0
  379. package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataName.d.ts +14 -0
  380. package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataName.js +36 -0
  381. package/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.d.ts +12 -0
  382. package/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.js +33 -0
  383. package/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.d.ts +13 -0
  384. package/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.js +34 -0
  385. package/serialization/resources/collections/resources/items/types/ItemsCreateItemRequest.d.ts +12 -0
  386. package/serialization/resources/collections/resources/items/types/ItemsCreateItemRequest.js +33 -0
  387. package/serialization/resources/collections/resources/items/types/ItemsCreateItemRequestItems.d.ts +13 -0
  388. package/serialization/resources/collections/resources/items/types/ItemsCreateItemRequestItems.js +34 -0
  389. package/serialization/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.d.ts +13 -0
  390. package/serialization/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.js +34 -0
  391. package/serialization/resources/collections/resources/items/types/ItemsDeleteItemsRequestItemsItem.d.ts +13 -0
  392. package/serialization/resources/collections/resources/items/types/ItemsDeleteItemsRequestItemsItem.js +34 -0
  393. package/serialization/resources/collections/resources/items/types/index.d.ts +9 -0
  394. package/serialization/resources/collections/resources/items/types/index.js +9 -0
  395. package/serialization/resources/pages/client/requests/DomWrite.d.ts +1 -1
  396. package/serialization/types/BulkCollectionItemFieldData.js +4 -2
  397. package/serialization/types/CollectionItem.d.ts +1 -1
  398. package/serialization/types/CollectionItem.js +1 -1
  399. package/serialization/types/CollectionItemFieldData.js +4 -2
  400. package/serialization/types/CollectionItemListNoPagination.d.ts +13 -0
  401. package/serialization/types/{TooManyRequestsErrorBody.js → CollectionItemListNoPagination.js} +4 -6
  402. package/serialization/types/CollectionItemWithIdInput.d.ts +20 -0
  403. package/serialization/types/CollectionItemWithIdInput.js +41 -0
  404. package/serialization/types/CollectionItemWithIdInputFieldData.d.ts +14 -0
  405. package/serialization/types/CollectionItemWithIdInputFieldData.js +36 -0
  406. package/serialization/types/ConflictErrorBody.d.ts +4 -8
  407. package/serialization/types/ConflictErrorBody.js +3 -7
  408. package/serialization/types/DuplicateUserEmail.d.ts +2 -8
  409. package/serialization/types/DuplicateUserEmail.js +1 -7
  410. package/serialization/types/ErrorCode.d.ts +10 -0
  411. package/serialization/types/ErrorCode.js +61 -0
  412. package/serialization/types/Error_.d.ts +2 -1
  413. package/serialization/types/Error_.js +2 -1
  414. package/serialization/types/ForbiddenErrorBody.d.ts +4 -8
  415. package/serialization/types/ForbiddenErrorBody.js +3 -7
  416. package/serialization/types/Form.d.ts +1 -1
  417. package/serialization/types/Form.js +1 -1
  418. package/serialization/types/InvalidScopes.d.ts +10 -0
  419. package/serialization/types/InvalidScopes.js +31 -0
  420. package/serialization/types/NotEnterprisePlanSite.d.ts +2 -8
  421. package/serialization/types/NotEnterprisePlanSite.js +1 -7
  422. package/serialization/types/Page.d.ts +1 -0
  423. package/serialization/types/Page.js +1 -0
  424. package/serialization/types/Site.d.ts +3 -0
  425. package/serialization/types/Site.js +3 -0
  426. package/serialization/types/SiteActivityLogItem.d.ts +2 -1
  427. package/serialization/types/SiteActivityLogItem.js +2 -1
  428. package/serialization/types/SiteActivityLogItemEvent.d.ts +10 -0
  429. package/serialization/types/SiteActivityLogItemEvent.js +74 -0
  430. package/serialization/types/SiteActivityLogItemResourceOperation.d.ts +1 -1
  431. package/serialization/types/SiteActivityLogItemResourceOperation.js +11 -1
  432. package/serialization/types/SiteDataCollectionType.d.ts +10 -0
  433. package/serialization/types/SiteDataCollectionType.js +31 -0
  434. package/serialization/types/UserLimitReached.d.ts +2 -8
  435. package/serialization/types/UserLimitReached.js +1 -7
  436. package/serialization/types/UsersNotEnabled.d.ts +2 -8
  437. package/serialization/types/UsersNotEnabled.js +1 -7
  438. package/serialization/types/index.d.ts +10 -5
  439. package/serialization/types/index.js +10 -5
  440. package/version.d.ts +1 -1
  441. package/version.js +1 -1
  442. package/wrapper/ItemsClient.d.ts +23 -49
  443. package/wrapper/ItemsClient.js +50 -216
  444. package/wrapper/WebflowClient.d.ts +1 -1
  445. package/wrapper/WebflowClient.js +11 -1
  446. package/api/types/MissingScopes.d.ts +0 -14
  447. package/api/types/TooManyRequestsErrorBody.d.ts +0 -9
  448. package/dist/api/types/MissingScopes.d.ts +0 -14
  449. package/dist/api/types/TooManyRequestsErrorBody.d.ts +0 -9
  450. package/dist/serialization/types/MissingScopes.d.ts +0 -16
  451. package/dist/serialization/types/TooManyRequestsErrorBody.d.ts +0 -15
  452. package/serialization/types/MissingScopes.d.ts +0 -16
  453. package/serialization/types/TooManyRequestsErrorBody.d.ts +0 -15
  454. /package/api/{types/MissingScopes.js → resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.js} +0 -0
  455. /package/api/{types/TooManyRequestsErrorBody.js → resources/collections/resources/items/client/requests/ItemsDeleteItemsLiveRequest.js} +0 -0
  456. /package/{dist/api/types/MissingScopes.js → api/resources/collections/resources/items/client/requests/ItemsDeleteItemsRequest.js} +0 -0
  457. /package/{dist/api/types/TooManyRequestsErrorBody.js → api/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.js} +0 -0
@@ -0,0 +1,1569 @@
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: ../../../referenced-specs/v2.yml
13
+ OrdersRefundRequestReason:
14
+ enum:
15
+ - duplicate
16
+ - fraudulent
17
+ - requested
18
+ docs: The reason for the refund
19
+ source:
20
+ openapi: ../../../referenced-specs/v2.yml
21
+ imports:
22
+ root: __package__.yml
23
+ service:
24
+ auth: false
25
+ base-path: ''
26
+ endpoints:
27
+ list:
28
+ path: /sites/{site_id}/orders
29
+ method: GET
30
+ auth: true
31
+ docs: |
32
+ List all orders created for a given site.
33
+
34
+ Required scope | `ecommerce:read`
35
+ source:
36
+ openapi: ../../../referenced-specs/v2.yml
37
+ path-parameters:
38
+ site_id:
39
+ type: string
40
+ docs: Unique identifier for a Site
41
+ display-name: List Orders
42
+ request:
43
+ name: OrdersListRequest
44
+ query-parameters:
45
+ status:
46
+ type: optional<OrdersListRequestStatus>
47
+ docs: Filter the orders by status
48
+ offset:
49
+ type: optional<double>
50
+ docs: >-
51
+ Offset used for pagination if the results have more than limit
52
+ records
53
+ limit:
54
+ type: optional<double>
55
+ docs: 'Maximum number of records to be returned (max limit: 100)'
56
+ response:
57
+ docs: Request was successful
58
+ type: root.OrderList
59
+ errors:
60
+ - root.BadRequestError
61
+ - root.UnauthorizedError
62
+ - root.ForbiddenError
63
+ - root.NotFoundError
64
+ - root.ConflictError
65
+ - root.TooManyRequestsError
66
+ - root.InternalServerError
67
+ examples:
68
+ - path-parameters:
69
+ site_id: 580e63e98c9a982ac9b8b741
70
+ response:
71
+ body:
72
+ orders:
73
+ - orderId: 7c1-9fd
74
+ status: unfulfilled
75
+ comment: >-
76
+ Customer requested gift wrapping and a personalized note
77
+ saying: Happy Birthday, Ford! 🎉 Please ensure the item is
78
+ packed with extra bubble wrap for safe transit.
79
+ orderComment: >-
80
+ Please gift wrap with a personal note saying "Happy
81
+ Birthday, Ford! 🎉
82
+ acceptedOn: '2024-04-10T13:16:21Z'
83
+ fulfilledOn: '2018-12-03T22:06:15Z'
84
+ refundedOn: '2018-12-03T22:06:15Z'
85
+ disputedOn: '2018-12-03T22:06:15Z'
86
+ disputeUpdatedOn: '2018-12-03T22:06:15Z'
87
+ disputeLastStatus: warning_needs_response
88
+ customerPaid:
89
+ unit: USD
90
+ value: '5892'
91
+ string: ' 211.55 USD'
92
+ netAmount:
93
+ unit: USD
94
+ value: '5892'
95
+ string: ' 200.89 USD'
96
+ applicationFee:
97
+ unit: USD
98
+ value: '5892'
99
+ string: ' 4.23 USD'
100
+ allAddresses:
101
+ - type: billing
102
+ addressee: Arthur Dent
103
+ line1: 20 W 34th St
104
+ line2: Empire State Building
105
+ city: New York
106
+ state: New York
107
+ country: US
108
+ postalCode: '10118'
109
+ - type: shipping
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
+ shippingAddress:
118
+ type: shipping
119
+ japanType: kanji
120
+ addressee: Arthur Dent
121
+ line1: 20 W 34th St
122
+ line2: Empire State Building
123
+ city: New York
124
+ state: New York
125
+ country: US
126
+ postalCode: '10118'
127
+ billingAddress:
128
+ type: billing
129
+ addressee: Arthur Dent
130
+ line1: 20 W 34th St
131
+ line2: Empire State Building
132
+ city: New York
133
+ state: New York
134
+ country: US
135
+ postalCode: '10118'
136
+ shippingProvider: Shipping Company, Co.
137
+ shippingTracking: tr00000000002
138
+ shippingTrackingURL: https://www.shippingcompany.com/tracking/tr00000000002
139
+ customerInfo:
140
+ fullName: Arthur Dent
141
+ email: arthur.dent@example.com
142
+ purchasedItems:
143
+ - count: 2
144
+ rowTotal:
145
+ unit: USD
146
+ value: '5892'
147
+ string: ' 111.22 USD'
148
+ productId: 66072fb61b89448912e26791
149
+ productName: Luxurious Fresh Ball
150
+ productSlug: luxurious-fresh-ball
151
+ variantId: 66072fb71b89448912e2683f
152
+ variantName: 'Luxurious Fresh Ball Generic: Bronze, Practical: Plastic'
153
+ variantSlug: luxurious-fresh-ball-generic-bronze-practical-plastic
154
+ variantSKU: luxurious-fresh-ball-generic-bronze-practical-plastic
155
+ variantImage:
156
+ url: >-
157
+ https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2672c_image14.jpeg
158
+ variantPrice:
159
+ unit: USD
160
+ value: '5892'
161
+ string: ' 55.61 USD'
162
+ weight: 11
163
+ width: 82
164
+ height: 70
165
+ length: 9
166
+ - count: 1
167
+ rowTotal:
168
+ unit: USD
169
+ value: '5892'
170
+ string: ' 83.09 USD'
171
+ productId: 66072fb61b89448912e2678b
172
+ productName: Incredible Bronze Towels
173
+ productSlug: incredible-bronze-towels
174
+ variantId: 66072fb71b89448912e2681e
175
+ variantName: >-
176
+ Incredible Bronze Towels Sleek: Frozen, Incredible:
177
+ Metal
178
+ variantSlug: incredible-bronze-towels-sleek-frozen-incredible-metal
179
+ variantSKU: incredible-bronze-towels-sleek-frozen-incredible-metal
180
+ variantImage:
181
+ url: >-
182
+ https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e26729_image16.jpeg
183
+ variantPrice:
184
+ unit: USD
185
+ value: '5892'
186
+ string: ' 83.09 USD'
187
+ width: 19
188
+ height: 72
189
+ length: 18
190
+ purchasedItemsCount: 3
191
+ stripeDetails:
192
+ paymentMethod: pm_1P410gJYFi4lcbXWbeKghqjK
193
+ paymentIntentId: pi_3P410iJYFi4lcbXW0EKKgcVg
194
+ customerId: cus_Ptod8KJBiiPgnH
195
+ chargeId: ch_3P410iJYFi4lcbXW0DxUkzCH
196
+ stripeCard:
197
+ last4: '4242'
198
+ brand: Visa
199
+ ownerName: Arthur Dent
200
+ expires:
201
+ year: 2025
202
+ month: 4
203
+ paypalDetails:
204
+ orderId: 1a2b3c4d5e6f7g8h9i0j
205
+ payerId: 9k8j7i6h5g4f3e2d1c0b
206
+ captureId: qwe123rty456uio789p
207
+ refundId: abcde12345fghij67890
208
+ refundReason: Customer requested refund
209
+ disputeId: zxcvbnm987poiuytrewq
210
+ customData:
211
+ - key: value
212
+ metadata:
213
+ isBuyNow: false
214
+ isCustomerDeleted: false
215
+ isShippingRequired: false
216
+ hasDownloads: false
217
+ paymentProcessor: stripe
218
+ totals:
219
+ extras:
220
+ - type: tax
221
+ name: State Taxes
222
+ description: CA Taxes (6.25%)
223
+ price:
224
+ unit: USD
225
+ value: '5892'
226
+ string: '3.44'
227
+ downloadFiles:
228
+ - id: 5e9a5eba75e0ac242e1b6f64
229
+ name: The modern web design process - Webflow Ebook.pdf
230
+ url: >-
231
+ https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa
232
+ - orderId: fc7-128
233
+ status: refunded
234
+ comment: Example comment to myself
235
+ orderComment: ''
236
+ acceptedOn: '2024-03-29T21:29:21Z'
237
+ fulfilledOn: '2018-12-03T22:06:15Z'
238
+ refundedOn: '2024-04-08T18:25:04Z'
239
+ disputedOn: '2018-12-03T22:06:15Z'
240
+ disputeUpdatedOn: '2018-12-03T22:06:15Z'
241
+ disputeLastStatus: warning_needs_response
242
+ customerPaid:
243
+ unit: USD
244
+ value: '5892'
245
+ string: ' 118.73 USD'
246
+ netAmount:
247
+ unit: USD
248
+ value: '5892'
249
+ string: ' 112.62 USD'
250
+ applicationFee:
251
+ unit: USD
252
+ value: '5892'
253
+ string: ' 2.37 USD'
254
+ allAddresses:
255
+ - type: billing
256
+ addressee: Arthur Dent
257
+ line1: 20 W 34th St
258
+ line2: Empire State Building
259
+ city: New York
260
+ state: New York
261
+ country: US
262
+ postalCode: '10118'
263
+ - type: shipping
264
+ addressee: Arthur Dent
265
+ line1: 20 W 34th St
266
+ line2: Empire State Building
267
+ city: New York
268
+ state: New York
269
+ country: US
270
+ postalCode: '10118'
271
+ shippingAddress:
272
+ type: shipping
273
+ addressee: Arthur Dent
274
+ line1: 20 W 34th St
275
+ line2: Empire State Building
276
+ city: New York
277
+ state: New York
278
+ country: US
279
+ postalCode: '10118'
280
+ billingAddress:
281
+ type: billing
282
+ addressee: Arthur Dent
283
+ line1: 20 W 34th St
284
+ line2: Empire State Building
285
+ city: New York
286
+ state: New York
287
+ country: US
288
+ postalCode: '10118'
289
+ shippingProvider: Shipping Company, Co.
290
+ shippingTracking: tr00000000001
291
+ shippingTrackingURL: https://www.shippingcompany.com/tracking/tr00000000001
292
+ customerInfo:
293
+ fullName: Arthur Dent
294
+ email: arthur.dent@example.com
295
+ purchasedItems:
296
+ - count: 1
297
+ rowTotal:
298
+ unit: USD
299
+ value: '5892'
300
+ string: ' 55.61 USD'
301
+ productId: 66072fb61b89448912e26791
302
+ productName: Luxurious Fresh Ball
303
+ productSlug: luxurious-fresh-ball
304
+ variantId: 66072fb71b89448912e2683f
305
+ variantName: 'Luxurious Fresh Ball Generic: Bronze, Practical: Plastic'
306
+ variantSlug: luxurious-fresh-ball-generic-bronze-practical-plastic
307
+ variantSKU: luxurious-fresh-ball-generic-bronze-practical-plastic
308
+ variantImage:
309
+ url: >-
310
+ https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2672c_image14.jpeg
311
+ variantPrice:
312
+ unit: USD
313
+ value: '5892'
314
+ string: ' 55.61 USD'
315
+ weight: 11
316
+ width: 82
317
+ height: 70
318
+ length: 9
319
+ - count: 1
320
+ rowTotal:
321
+ unit: USD
322
+ value: '5892'
323
+ string: ' 53.44 USD'
324
+ productId: 66072fb61b89448912e26799
325
+ productName: Recycled Steel Gloves
326
+ productSlug: recycled-steel-gloves
327
+ variantId: 66072fb91b89448912e26ab9
328
+ variantName: >-
329
+ Recycled Steel Gloves Electronic: Granite, Handcrafted:
330
+ grey
331
+ variantSlug: >-
332
+ recycled-steel-gloves-electronic-granite-handcrafted-grey
333
+ variantSKU: >-
334
+ recycled-steel-gloves-electronic-granite-handcrafted-grey
335
+ variantImage:
336
+ url: >-
337
+ https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2671e_image2.jpeg
338
+ variantPrice:
339
+ unit: USD
340
+ value: '5892'
341
+ string: ' 53.44 USD'
342
+ weight: 38
343
+ width: 76
344
+ height: 85
345
+ length: 40
346
+ purchasedItemsCount: 2
347
+ stripeDetails:
348
+ paymentMethod: pm_1OzmzBJYFi4lcbXWHKNdXU7j
349
+ paymentIntentId: pi_3OzmzDJYFi4lcbXW1hTBW6ft
350
+ customerId: cus_PpRsNHwWdUoRKR
351
+ chargeId: ch_3OzmzDJYFi4lcbXW1ndkkrH2
352
+ refundId: re_3OzmzDJYFi4lcbXW1kFAmlBk
353
+ refundReason: fraudulent
354
+ stripeCard:
355
+ last4: '4242'
356
+ brand: Visa
357
+ ownerName: Arthur Dent
358
+ expires:
359
+ year: 2024
360
+ month: 4
361
+ paypalDetails:
362
+ orderId: 1a2b3c4d5e6f7g8h9i0j
363
+ payerId: 9k8j7i6h5g4f3e2d1c0b
364
+ captureId: qwe123rty456uio789p
365
+ refundId: abcde12345fghij67890
366
+ refundReason: Customer requested refund
367
+ disputeId: zxcvbnm987poiuytrewq
368
+ customData:
369
+ - key: value
370
+ metadata:
371
+ isBuyNow: false
372
+ isCustomerDeleted: false
373
+ isShippingRequired: true
374
+ hasDownloads: false
375
+ paymentProcessor: stripe
376
+ totals:
377
+ subtotal:
378
+ unit: USD
379
+ value: '5892'
380
+ string: ' 109.05 USD'
381
+ extras:
382
+ - type: tax
383
+ name: State Taxes
384
+ description: NY Taxes (4.00%)
385
+ price:
386
+ unit: USD
387
+ value: '5892'
388
+ string: ' 4.36 USD'
389
+ - type: tax
390
+ name: City Taxes
391
+ description: NEW YORK Taxes (4.88%)
392
+ price:
393
+ unit: USD
394
+ value: '5892'
395
+ string: ' 5.32 USD'
396
+ - type: shipping
397
+ name: Flat
398
+ description: ''
399
+ price:
400
+ unit: USD
401
+ value: '5892'
402
+ string: ' 0.00 USD'
403
+ total:
404
+ unit: USD
405
+ value: '5892'
406
+ string: ' 118.73 USD'
407
+ downloadFiles:
408
+ - id: 5e9a5eba75e0ac242e1b6f64
409
+ name: New product guide
410
+ url: >-
411
+ https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa
412
+ pagination:
413
+ limit: 100
414
+ offset: 0
415
+ total: 2
416
+ get:
417
+ path: /sites/{site_id}/orders/{order_id}
418
+ method: GET
419
+ auth: true
420
+ docs: |
421
+ Retrieve a single product by its ID. All of its SKUs will also be
422
+ retrieved.
423
+
424
+ Required scope | `ecommerce:read`
425
+ source:
426
+ openapi: ../../../referenced-specs/v2.yml
427
+ path-parameters:
428
+ site_id:
429
+ type: string
430
+ docs: Unique identifier for a Site
431
+ order_id:
432
+ type: string
433
+ docs: Unique identifier for an Order
434
+ display-name: Get Order
435
+ response:
436
+ docs: Request was successful
437
+ type: root.Order
438
+ errors:
439
+ - root.BadRequestError
440
+ - root.UnauthorizedError
441
+ - root.ForbiddenError
442
+ - root.NotFoundError
443
+ - root.ConflictError
444
+ - root.TooManyRequestsError
445
+ - root.InternalServerError
446
+ examples:
447
+ - path-parameters:
448
+ site_id: 580e63e98c9a982ac9b8b741
449
+ order_id: 5e8518516e147040726cc415
450
+ response:
451
+ body:
452
+ orderId: fc7-128
453
+ status: refunded
454
+ comment: >-
455
+ Customer requested gift wrapping and a personalized note saying:
456
+ Happy Birthday, Ford! 🎉 Please ensure the item is packed with
457
+ extra bubble wrap for safe transit.
458
+ orderComment: >-
459
+ Please gift wrap with a personal note saying "Happy Birthday,
460
+ Ford! 🎉
461
+ acceptedOn: '2024-03-29T21:29:21Z'
462
+ fulfilledOn: '2024-03-29T21:29:21Z'
463
+ refundedOn: '2024-04-08T18:25:04Z'
464
+ disputedOn: '2024-03-29T21:29:21Z'
465
+ disputeUpdatedOn: '2024-03-29T21:29:21Z'
466
+ disputeLastStatus: charge_refunded
467
+ customerPaid:
468
+ unit: USD
469
+ value: '5892'
470
+ string: ' 118.73 USD'
471
+ netAmount:
472
+ unit: USD
473
+ value: '5892'
474
+ string: ' 112.62 USD'
475
+ applicationFee:
476
+ unit: USD
477
+ value: '5892'
478
+ string: ' 2.37 USD'
479
+ allAddresses:
480
+ - type: billing
481
+ japanType: kana
482
+ addressee: Arthur Dent
483
+ line1: 20 W 34th St
484
+ line2: Empire State Building
485
+ city: New York
486
+ state: New York
487
+ country: US
488
+ postalCode: '10118'
489
+ - type: shipping
490
+ japanType: kana
491
+ addressee: Arthur Dent
492
+ line1: 20 W 34th St
493
+ line2: Empire State Building
494
+ city: New York
495
+ state: New York
496
+ country: US
497
+ postalCode: '10118'
498
+ shippingAddress:
499
+ type: shipping
500
+ japanType: kanji
501
+ addressee: Arthur Dent
502
+ line1: 20 W 34th St
503
+ line2: Empire State Building
504
+ city: New York
505
+ state: New York
506
+ country: US
507
+ postalCode: '10118'
508
+ billingAddress:
509
+ type: billing
510
+ japanType: kana
511
+ addressee: Arthur Dent
512
+ line1: 20 W 34th St
513
+ line2: Empire State Building
514
+ city: New York
515
+ state: New York
516
+ country: US
517
+ postalCode: '10118'
518
+ shippingProvider: Shipping Company, Co.
519
+ shippingTracking: tr00000000001
520
+ shippingTrackingURL: https://www.shippingcompany.com/tracking/tr00000000001
521
+ customerInfo:
522
+ fullName: Arthur Dent
523
+ email: arthur.dent@example.com
524
+ purchasedItems:
525
+ - count: 1
526
+ rowTotal:
527
+ unit: USD
528
+ value: '5892'
529
+ string: ' 55.61 USD'
530
+ productId: 66072fb61b89448912e26791
531
+ productName: Luxurious Fresh Ball
532
+ productSlug: luxurious-fresh-ball
533
+ variantId: 66072fb71b89448912e2683f
534
+ variantName: 'Luxurious Fresh Ball Generic: Bronze, Practical: Plastic'
535
+ variantSlug: luxurious-fresh-ball-generic-bronze-practical-plastic
536
+ variantSKU: luxurious-fresh-ball-generic-bronze-practical-plastic
537
+ variantImage:
538
+ url: >-
539
+ https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2672c_image14.jpeg
540
+ variantPrice:
541
+ unit: USD
542
+ value: '5892'
543
+ string: ' 55.61 USD'
544
+ weight: 11
545
+ width: 82
546
+ height: 70
547
+ length: 9
548
+ - count: 1
549
+ rowTotal:
550
+ unit: USD
551
+ value: '5892'
552
+ string: ' 53.44 USD'
553
+ productId: 66072fb61b89448912e26799
554
+ productName: Recycled Steel Gloves
555
+ productSlug: recycled-steel-gloves
556
+ variantId: 66072fb91b89448912e26ab9
557
+ variantName: 'Recycled Steel Gloves Electronic: Granite, Handcrafted: grey'
558
+ variantSlug: recycled-steel-gloves-electronic-granite-handcrafted-grey
559
+ variantSKU: recycled-steel-gloves-electronic-granite-handcrafted-grey
560
+ variantImage:
561
+ url: >-
562
+ https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2671e_image2.jpeg
563
+ variantPrice:
564
+ unit: USD
565
+ value: '5892'
566
+ string: ' 53.44 USD'
567
+ weight: 38
568
+ width: 76
569
+ height: 85
570
+ length: 40
571
+ purchasedItemsCount: 2
572
+ stripeDetails:
573
+ subscriptionId: sub_1J6xwG2eZvKYlo2CXu9Zt0Tn
574
+ paymentMethod: pm_1OzmzBJYFi4lcbXWHKNdXU7j
575
+ paymentIntentId: pi_3OzmzDJYFi4lcbXW1hTBW6ft
576
+ customerId: cus_PpRsNHwWdUoRKR
577
+ chargeId: ch_3OzmzDJYFi4lcbXW1ndkkrH2
578
+ disputeId: disputeId
579
+ refundId: re_3OzmzDJYFi4lcbXW1kFAmlBk
580
+ refundReason: fraudulent
581
+ stripeCard:
582
+ last4: '4242'
583
+ brand: Visa
584
+ ownerName: Arthur Dent
585
+ expires:
586
+ year: 2024
587
+ month: 4
588
+ paypalDetails:
589
+ orderId: 1a2b3c4d5e6f7g8h9i0j
590
+ payerId: 9k8j7i6h5g4f3e2d1c0b
591
+ captureId: qwe123rty456uio789p
592
+ refundId: abcde12345fghij67890
593
+ refundReason: Customer requested refund
594
+ disputeId: zxcvbnm987poiuytrewq
595
+ customData:
596
+ - key: value
597
+ metadata:
598
+ isBuyNow: false
599
+ isCustomerDeleted: false
600
+ isShippingRequired: true
601
+ hasDownloads: false
602
+ paymentProcessor: stripe
603
+ totals:
604
+ subtotal:
605
+ unit: USD
606
+ value: '5892'
607
+ string: ' 109.05 USD'
608
+ extras:
609
+ - type: tax
610
+ name: State Taxes
611
+ description: NY Taxes (4.00%)
612
+ price:
613
+ unit: USD
614
+ value: '5892'
615
+ string: ' 4.36 USD'
616
+ - type: tax
617
+ name: City Taxes
618
+ description: NEW YORK Taxes (4.88%)
619
+ price:
620
+ unit: USD
621
+ value: '5892'
622
+ string: ' 5.32 USD'
623
+ - type: shipping
624
+ name: Flat
625
+ description: ''
626
+ price:
627
+ unit: USD
628
+ value: '5892'
629
+ string: ' 0.00 USD'
630
+ total:
631
+ unit: USD
632
+ value: '5892'
633
+ string: ' 118.73 USD'
634
+ downloadFiles:
635
+ - id: 5e9a5eba75e0ac242e1b6f64
636
+ name: New product guide
637
+ url: >-
638
+ https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa
639
+ update:
640
+ path: /sites/{site_id}/orders/{order_id}
641
+ method: PATCH
642
+ auth: true
643
+ docs: |
644
+ This API lets you update the fields, `comment`, `shippingProvider`,
645
+ and/or `shippingTracking` for a given order. All three fields can be
646
+ updated simultaneously or independently.
647
+
648
+ Required scope | `ecommerce:write`
649
+ source:
650
+ openapi: ../../../referenced-specs/v2.yml
651
+ path-parameters:
652
+ site_id:
653
+ type: string
654
+ docs: Unique identifier for a Site
655
+ order_id:
656
+ type: string
657
+ docs: Unique identifier for an Order
658
+ display-name: Update Order
659
+ request:
660
+ name: OrdersUpdateRequest
661
+ body:
662
+ properties:
663
+ comment:
664
+ type: optional<string>
665
+ docs: Arbitrary data for your records
666
+ shippingProvider:
667
+ type: optional<string>
668
+ docs: Company or method used to ship order
669
+ shippingTracking:
670
+ type: optional<string>
671
+ docs: Tracking number for order shipment
672
+ shippingTrackingURL:
673
+ type: optional<string>
674
+ docs: URL to track order shipment
675
+ content-type: application/json
676
+ response:
677
+ docs: Request was successful
678
+ type: root.Order
679
+ errors:
680
+ - root.BadRequestError
681
+ - root.UnauthorizedError
682
+ - root.ForbiddenError
683
+ - root.NotFoundError
684
+ - root.ConflictError
685
+ - root.TooManyRequestsError
686
+ - root.InternalServerError
687
+ examples:
688
+ - path-parameters:
689
+ site_id: 580e63e98c9a982ac9b8b741
690
+ order_id: 5e8518516e147040726cc415
691
+ request: {}
692
+ response:
693
+ body:
694
+ orderId: fc7-128
695
+ status: refunded
696
+ comment: >-
697
+ Customer requested gift wrapping and a personalized note saying:
698
+ Happy Birthday, Ford! 🎉 Please ensure the item is packed with
699
+ extra bubble wrap for safe transit.
700
+ orderComment: >-
701
+ Please gift wrap with a personal note saying "Happy Birthday,
702
+ Ford! 🎉
703
+ acceptedOn: '2024-03-29T21:29:21Z'
704
+ fulfilledOn: '2024-03-29T21:29:21Z'
705
+ refundedOn: '2024-04-08T18:25:04Z'
706
+ disputedOn: '2024-03-29T21:29:21Z'
707
+ disputeUpdatedOn: '2024-03-29T21:29:21Z'
708
+ disputeLastStatus: charge_refunded
709
+ customerPaid:
710
+ unit: USD
711
+ value: '5892'
712
+ string: ' 118.73 USD'
713
+ netAmount:
714
+ unit: USD
715
+ value: '5892'
716
+ string: ' 112.62 USD'
717
+ applicationFee:
718
+ unit: USD
719
+ value: '5892'
720
+ string: ' 2.37 USD'
721
+ allAddresses:
722
+ - type: billing
723
+ japanType: kana
724
+ addressee: Arthur Dent
725
+ line1: 20 W 34th St
726
+ line2: Empire State Building
727
+ city: New York
728
+ state: New York
729
+ country: US
730
+ postalCode: '10118'
731
+ - type: shipping
732
+ japanType: kana
733
+ addressee: Arthur Dent
734
+ line1: 20 W 34th St
735
+ line2: Empire State Building
736
+ city: New York
737
+ state: New York
738
+ country: US
739
+ postalCode: '10118'
740
+ shippingAddress:
741
+ type: shipping
742
+ japanType: kanji
743
+ addressee: Arthur Dent
744
+ line1: 20 W 34th St
745
+ line2: Empire State Building
746
+ city: New York
747
+ state: New York
748
+ country: US
749
+ postalCode: '10118'
750
+ billingAddress:
751
+ type: billing
752
+ japanType: kana
753
+ addressee: Arthur Dent
754
+ line1: 20 W 34th St
755
+ line2: Empire State Building
756
+ city: New York
757
+ state: New York
758
+ country: US
759
+ postalCode: '10118'
760
+ shippingProvider: Shipping Company, Co.
761
+ shippingTracking: tr00000000001
762
+ shippingTrackingURL: https://www.shippingcompany.com/tracking/tr00000000001
763
+ customerInfo:
764
+ fullName: Arthur Dent
765
+ email: arthur.dent@example.com
766
+ purchasedItems:
767
+ - count: 1
768
+ rowTotal:
769
+ unit: USD
770
+ value: '5892'
771
+ string: ' 55.61 USD'
772
+ productId: 66072fb61b89448912e26791
773
+ productName: Luxurious Fresh Ball
774
+ productSlug: luxurious-fresh-ball
775
+ variantId: 66072fb71b89448912e2683f
776
+ variantName: 'Luxurious Fresh Ball Generic: Bronze, Practical: Plastic'
777
+ variantSlug: luxurious-fresh-ball-generic-bronze-practical-plastic
778
+ variantSKU: luxurious-fresh-ball-generic-bronze-practical-plastic
779
+ variantImage:
780
+ url: >-
781
+ https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2672c_image14.jpeg
782
+ variantPrice:
783
+ unit: USD
784
+ value: '5892'
785
+ string: ' 55.61 USD'
786
+ weight: 11
787
+ width: 82
788
+ height: 70
789
+ length: 9
790
+ - count: 1
791
+ rowTotal:
792
+ unit: USD
793
+ value: '5892'
794
+ string: ' 53.44 USD'
795
+ productId: 66072fb61b89448912e26799
796
+ productName: Recycled Steel Gloves
797
+ productSlug: recycled-steel-gloves
798
+ variantId: 66072fb91b89448912e26ab9
799
+ variantName: 'Recycled Steel Gloves Electronic: Granite, Handcrafted: grey'
800
+ variantSlug: recycled-steel-gloves-electronic-granite-handcrafted-grey
801
+ variantSKU: recycled-steel-gloves-electronic-granite-handcrafted-grey
802
+ variantImage:
803
+ url: >-
804
+ https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2671e_image2.jpeg
805
+ variantPrice:
806
+ unit: USD
807
+ value: '5892'
808
+ string: ' 53.44 USD'
809
+ weight: 38
810
+ width: 76
811
+ height: 85
812
+ length: 40
813
+ purchasedItemsCount: 2
814
+ stripeDetails:
815
+ subscriptionId: sub_1J6xwG2eZvKYlo2CXu9Zt0Tn
816
+ paymentMethod: pm_1OzmzBJYFi4lcbXWHKNdXU7j
817
+ paymentIntentId: pi_3OzmzDJYFi4lcbXW1hTBW6ft
818
+ customerId: cus_PpRsNHwWdUoRKR
819
+ chargeId: ch_3OzmzDJYFi4lcbXW1ndkkrH2
820
+ disputeId: disputeId
821
+ refundId: re_3OzmzDJYFi4lcbXW1kFAmlBk
822
+ refundReason: fraudulent
823
+ stripeCard:
824
+ last4: '4242'
825
+ brand: Visa
826
+ ownerName: Arthur Dent
827
+ expires:
828
+ year: 2024
829
+ month: 4
830
+ paypalDetails:
831
+ orderId: 1a2b3c4d5e6f7g8h9i0j
832
+ payerId: 9k8j7i6h5g4f3e2d1c0b
833
+ captureId: qwe123rty456uio789p
834
+ refundId: abcde12345fghij67890
835
+ refundReason: Customer requested refund
836
+ disputeId: zxcvbnm987poiuytrewq
837
+ customData:
838
+ - key: value
839
+ metadata:
840
+ isBuyNow: false
841
+ isCustomerDeleted: false
842
+ isShippingRequired: true
843
+ hasDownloads: false
844
+ paymentProcessor: stripe
845
+ totals:
846
+ subtotal:
847
+ unit: USD
848
+ value: '5892'
849
+ string: ' 109.05 USD'
850
+ extras:
851
+ - type: tax
852
+ name: State Taxes
853
+ description: NY Taxes (4.00%)
854
+ price:
855
+ unit: USD
856
+ value: '5892'
857
+ string: ' 4.36 USD'
858
+ - type: tax
859
+ name: City Taxes
860
+ description: NEW YORK Taxes (4.88%)
861
+ price:
862
+ unit: USD
863
+ value: '5892'
864
+ string: ' 5.32 USD'
865
+ - type: shipping
866
+ name: Flat
867
+ description: ''
868
+ price:
869
+ unit: USD
870
+ value: '5892'
871
+ string: ' 0.00 USD'
872
+ total:
873
+ unit: USD
874
+ value: '5892'
875
+ string: ' 118.73 USD'
876
+ downloadFiles:
877
+ - id: 5e9a5eba75e0ac242e1b6f64
878
+ name: New product guide
879
+ url: >-
880
+ https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa
881
+ update-fulfill:
882
+ path: /sites/{site_id}/orders/{order_id}/fulfill
883
+ method: POST
884
+ auth: true
885
+ docs: |
886
+ Updates an order's status to fulfilled
887
+
888
+ Required scope | `ecommerce:write`
889
+ source:
890
+ openapi: ../../../referenced-specs/v2.yml
891
+ path-parameters:
892
+ site_id:
893
+ type: string
894
+ docs: Unique identifier for a Site
895
+ order_id:
896
+ type: string
897
+ docs: Unique identifier for an Order
898
+ display-name: Fulfill Order
899
+ request:
900
+ name: OrdersUpdateFulfillRequest
901
+ body:
902
+ properties:
903
+ sendOrderFulfilledEmail:
904
+ type: optional<boolean>
905
+ docs: Whether or not the Order Fulfilled email should be sent
906
+ default: false
907
+ content-type: application/json
908
+ response:
909
+ docs: Request was successful
910
+ type: root.Order
911
+ errors:
912
+ - root.BadRequestError
913
+ - root.UnauthorizedError
914
+ - root.ForbiddenError
915
+ - root.NotFoundError
916
+ - root.ConflictError
917
+ - root.TooManyRequestsError
918
+ - root.InternalServerError
919
+ examples:
920
+ - path-parameters:
921
+ site_id: 580e63e98c9a982ac9b8b741
922
+ order_id: 5e8518516e147040726cc415
923
+ request: {}
924
+ response:
925
+ body:
926
+ orderId: fc7-128
927
+ status: refunded
928
+ comment: >-
929
+ Customer requested gift wrapping and a personalized note saying:
930
+ Happy Birthday, Ford! 🎉 Please ensure the item is packed with
931
+ extra bubble wrap for safe transit.
932
+ orderComment: >-
933
+ Please gift wrap with a personal note saying "Happy Birthday,
934
+ Ford! 🎉
935
+ acceptedOn: '2024-03-29T21:29:21Z'
936
+ fulfilledOn: '2024-03-29T21:29:21Z'
937
+ refundedOn: '2024-04-08T18:25:04Z'
938
+ disputedOn: '2024-03-29T21:29:21Z'
939
+ disputeUpdatedOn: '2024-03-29T21:29:21Z'
940
+ disputeLastStatus: charge_refunded
941
+ customerPaid:
942
+ unit: USD
943
+ value: '5892'
944
+ string: ' 118.73 USD'
945
+ netAmount:
946
+ unit: USD
947
+ value: '5892'
948
+ string: ' 112.62 USD'
949
+ applicationFee:
950
+ unit: USD
951
+ value: '5892'
952
+ string: ' 2.37 USD'
953
+ allAddresses:
954
+ - type: billing
955
+ japanType: kana
956
+ addressee: Arthur Dent
957
+ line1: 20 W 34th St
958
+ line2: Empire State Building
959
+ city: New York
960
+ state: New York
961
+ country: US
962
+ postalCode: '10118'
963
+ - type: shipping
964
+ japanType: kana
965
+ addressee: Arthur Dent
966
+ line1: 20 W 34th St
967
+ line2: Empire State Building
968
+ city: New York
969
+ state: New York
970
+ country: US
971
+ postalCode: '10118'
972
+ shippingAddress:
973
+ type: shipping
974
+ japanType: kanji
975
+ addressee: Arthur Dent
976
+ line1: 20 W 34th St
977
+ line2: Empire State Building
978
+ city: New York
979
+ state: New York
980
+ country: US
981
+ postalCode: '10118'
982
+ billingAddress:
983
+ type: billing
984
+ japanType: kana
985
+ addressee: Arthur Dent
986
+ line1: 20 W 34th St
987
+ line2: Empire State Building
988
+ city: New York
989
+ state: New York
990
+ country: US
991
+ postalCode: '10118'
992
+ shippingProvider: Shipping Company, Co.
993
+ shippingTracking: tr00000000001
994
+ shippingTrackingURL: https://www.shippingcompany.com/tracking/tr00000000001
995
+ customerInfo:
996
+ fullName: Arthur Dent
997
+ email: arthur.dent@example.com
998
+ purchasedItems:
999
+ - count: 1
1000
+ rowTotal:
1001
+ unit: USD
1002
+ value: '5892'
1003
+ string: ' 55.61 USD'
1004
+ productId: 66072fb61b89448912e26791
1005
+ productName: Luxurious Fresh Ball
1006
+ productSlug: luxurious-fresh-ball
1007
+ variantId: 66072fb71b89448912e2683f
1008
+ variantName: 'Luxurious Fresh Ball Generic: Bronze, Practical: Plastic'
1009
+ variantSlug: luxurious-fresh-ball-generic-bronze-practical-plastic
1010
+ variantSKU: luxurious-fresh-ball-generic-bronze-practical-plastic
1011
+ variantImage:
1012
+ url: >-
1013
+ https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2672c_image14.jpeg
1014
+ variantPrice:
1015
+ unit: USD
1016
+ value: '5892'
1017
+ string: ' 55.61 USD'
1018
+ weight: 11
1019
+ width: 82
1020
+ height: 70
1021
+ length: 9
1022
+ - count: 1
1023
+ rowTotal:
1024
+ unit: USD
1025
+ value: '5892'
1026
+ string: ' 53.44 USD'
1027
+ productId: 66072fb61b89448912e26799
1028
+ productName: Recycled Steel Gloves
1029
+ productSlug: recycled-steel-gloves
1030
+ variantId: 66072fb91b89448912e26ab9
1031
+ variantName: 'Recycled Steel Gloves Electronic: Granite, Handcrafted: grey'
1032
+ variantSlug: recycled-steel-gloves-electronic-granite-handcrafted-grey
1033
+ variantSKU: recycled-steel-gloves-electronic-granite-handcrafted-grey
1034
+ variantImage:
1035
+ url: >-
1036
+ https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2671e_image2.jpeg
1037
+ variantPrice:
1038
+ unit: USD
1039
+ value: '5892'
1040
+ string: ' 53.44 USD'
1041
+ weight: 38
1042
+ width: 76
1043
+ height: 85
1044
+ length: 40
1045
+ purchasedItemsCount: 2
1046
+ stripeDetails:
1047
+ subscriptionId: sub_1J6xwG2eZvKYlo2CXu9Zt0Tn
1048
+ paymentMethod: pm_1OzmzBJYFi4lcbXWHKNdXU7j
1049
+ paymentIntentId: pi_3OzmzDJYFi4lcbXW1hTBW6ft
1050
+ customerId: cus_PpRsNHwWdUoRKR
1051
+ chargeId: ch_3OzmzDJYFi4lcbXW1ndkkrH2
1052
+ disputeId: disputeId
1053
+ refundId: re_3OzmzDJYFi4lcbXW1kFAmlBk
1054
+ refundReason: fraudulent
1055
+ stripeCard:
1056
+ last4: '4242'
1057
+ brand: Visa
1058
+ ownerName: Arthur Dent
1059
+ expires:
1060
+ year: 2024
1061
+ month: 4
1062
+ paypalDetails:
1063
+ orderId: 1a2b3c4d5e6f7g8h9i0j
1064
+ payerId: 9k8j7i6h5g4f3e2d1c0b
1065
+ captureId: qwe123rty456uio789p
1066
+ refundId: abcde12345fghij67890
1067
+ refundReason: Customer requested refund
1068
+ disputeId: zxcvbnm987poiuytrewq
1069
+ customData:
1070
+ - key: value
1071
+ metadata:
1072
+ isBuyNow: false
1073
+ isCustomerDeleted: false
1074
+ isShippingRequired: true
1075
+ hasDownloads: false
1076
+ paymentProcessor: stripe
1077
+ totals:
1078
+ subtotal:
1079
+ unit: USD
1080
+ value: '5892'
1081
+ string: ' 109.05 USD'
1082
+ extras:
1083
+ - type: tax
1084
+ name: State Taxes
1085
+ description: NY Taxes (4.00%)
1086
+ price:
1087
+ unit: USD
1088
+ value: '5892'
1089
+ string: ' 4.36 USD'
1090
+ - type: tax
1091
+ name: City Taxes
1092
+ description: NEW YORK Taxes (4.88%)
1093
+ price:
1094
+ unit: USD
1095
+ value: '5892'
1096
+ string: ' 5.32 USD'
1097
+ - type: shipping
1098
+ name: Flat
1099
+ description: ''
1100
+ price:
1101
+ unit: USD
1102
+ value: '5892'
1103
+ string: ' 0.00 USD'
1104
+ total:
1105
+ unit: USD
1106
+ value: '5892'
1107
+ string: ' 118.73 USD'
1108
+ downloadFiles:
1109
+ - id: 5e9a5eba75e0ac242e1b6f64
1110
+ name: New product guide
1111
+ url: >-
1112
+ https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa
1113
+ update-unfulfill:
1114
+ path: /sites/{site_id}/orders/{order_id}/unfulfill
1115
+ method: POST
1116
+ auth: true
1117
+ docs: |
1118
+ Updates an order's status to unfulfilled
1119
+
1120
+ Required scope | `ecommerce:write`
1121
+ source:
1122
+ openapi: ../../../referenced-specs/v2.yml
1123
+ path-parameters:
1124
+ site_id:
1125
+ type: string
1126
+ docs: Unique identifier for a Site
1127
+ order_id:
1128
+ type: string
1129
+ docs: Unique identifier for an Order
1130
+ display-name: Unfulfill Order
1131
+ response:
1132
+ docs: Request was successful
1133
+ type: root.Order
1134
+ errors:
1135
+ - root.BadRequestError
1136
+ - root.UnauthorizedError
1137
+ - root.ForbiddenError
1138
+ - root.NotFoundError
1139
+ - root.ConflictError
1140
+ - root.TooManyRequestsError
1141
+ - root.InternalServerError
1142
+ examples:
1143
+ - path-parameters:
1144
+ site_id: 580e63e98c9a982ac9b8b741
1145
+ order_id: 5e8518516e147040726cc415
1146
+ response:
1147
+ body:
1148
+ orderId: fc7-128
1149
+ status: refunded
1150
+ comment: >-
1151
+ Customer requested gift wrapping and a personalized note saying:
1152
+ Happy Birthday, Ford! 🎉 Please ensure the item is packed with
1153
+ extra bubble wrap for safe transit.
1154
+ orderComment: >-
1155
+ Please gift wrap with a personal note saying "Happy Birthday,
1156
+ Ford! 🎉
1157
+ acceptedOn: '2024-03-29T21:29:21Z'
1158
+ fulfilledOn: '2024-03-29T21:29:21Z'
1159
+ refundedOn: '2024-04-08T18:25:04Z'
1160
+ disputedOn: '2024-03-29T21:29:21Z'
1161
+ disputeUpdatedOn: '2024-03-29T21:29:21Z'
1162
+ disputeLastStatus: charge_refunded
1163
+ customerPaid:
1164
+ unit: USD
1165
+ value: '5892'
1166
+ string: ' 118.73 USD'
1167
+ netAmount:
1168
+ unit: USD
1169
+ value: '5892'
1170
+ string: ' 112.62 USD'
1171
+ applicationFee:
1172
+ unit: USD
1173
+ value: '5892'
1174
+ string: ' 2.37 USD'
1175
+ allAddresses:
1176
+ - type: billing
1177
+ japanType: kana
1178
+ addressee: Arthur Dent
1179
+ line1: 20 W 34th St
1180
+ line2: Empire State Building
1181
+ city: New York
1182
+ state: New York
1183
+ country: US
1184
+ postalCode: '10118'
1185
+ - type: shipping
1186
+ japanType: kana
1187
+ addressee: Arthur Dent
1188
+ line1: 20 W 34th St
1189
+ line2: Empire State Building
1190
+ city: New York
1191
+ state: New York
1192
+ country: US
1193
+ postalCode: '10118'
1194
+ shippingAddress:
1195
+ type: shipping
1196
+ japanType: kanji
1197
+ addressee: Arthur Dent
1198
+ line1: 20 W 34th St
1199
+ line2: Empire State Building
1200
+ city: New York
1201
+ state: New York
1202
+ country: US
1203
+ postalCode: '10118'
1204
+ billingAddress:
1205
+ type: billing
1206
+ japanType: kana
1207
+ addressee: Arthur Dent
1208
+ line1: 20 W 34th St
1209
+ line2: Empire State Building
1210
+ city: New York
1211
+ state: New York
1212
+ country: US
1213
+ postalCode: '10118'
1214
+ shippingProvider: Shipping Company, Co.
1215
+ shippingTracking: tr00000000001
1216
+ shippingTrackingURL: https://www.shippingcompany.com/tracking/tr00000000001
1217
+ customerInfo:
1218
+ fullName: Arthur Dent
1219
+ email: arthur.dent@example.com
1220
+ purchasedItems:
1221
+ - count: 1
1222
+ rowTotal:
1223
+ unit: USD
1224
+ value: '5892'
1225
+ string: ' 55.61 USD'
1226
+ productId: 66072fb61b89448912e26791
1227
+ productName: Luxurious Fresh Ball
1228
+ productSlug: luxurious-fresh-ball
1229
+ variantId: 66072fb71b89448912e2683f
1230
+ variantName: 'Luxurious Fresh Ball Generic: Bronze, Practical: Plastic'
1231
+ variantSlug: luxurious-fresh-ball-generic-bronze-practical-plastic
1232
+ variantSKU: luxurious-fresh-ball-generic-bronze-practical-plastic
1233
+ variantImage:
1234
+ url: >-
1235
+ https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2672c_image14.jpeg
1236
+ variantPrice:
1237
+ unit: USD
1238
+ value: '5892'
1239
+ string: ' 55.61 USD'
1240
+ weight: 11
1241
+ width: 82
1242
+ height: 70
1243
+ length: 9
1244
+ - count: 1
1245
+ rowTotal:
1246
+ unit: USD
1247
+ value: '5892'
1248
+ string: ' 53.44 USD'
1249
+ productId: 66072fb61b89448912e26799
1250
+ productName: Recycled Steel Gloves
1251
+ productSlug: recycled-steel-gloves
1252
+ variantId: 66072fb91b89448912e26ab9
1253
+ variantName: 'Recycled Steel Gloves Electronic: Granite, Handcrafted: grey'
1254
+ variantSlug: recycled-steel-gloves-electronic-granite-handcrafted-grey
1255
+ variantSKU: recycled-steel-gloves-electronic-granite-handcrafted-grey
1256
+ variantImage:
1257
+ url: >-
1258
+ https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2671e_image2.jpeg
1259
+ variantPrice:
1260
+ unit: USD
1261
+ value: '5892'
1262
+ string: ' 53.44 USD'
1263
+ weight: 38
1264
+ width: 76
1265
+ height: 85
1266
+ length: 40
1267
+ purchasedItemsCount: 2
1268
+ stripeDetails:
1269
+ subscriptionId: sub_1J6xwG2eZvKYlo2CXu9Zt0Tn
1270
+ paymentMethod: pm_1OzmzBJYFi4lcbXWHKNdXU7j
1271
+ paymentIntentId: pi_3OzmzDJYFi4lcbXW1hTBW6ft
1272
+ customerId: cus_PpRsNHwWdUoRKR
1273
+ chargeId: ch_3OzmzDJYFi4lcbXW1ndkkrH2
1274
+ disputeId: disputeId
1275
+ refundId: re_3OzmzDJYFi4lcbXW1kFAmlBk
1276
+ refundReason: fraudulent
1277
+ stripeCard:
1278
+ last4: '4242'
1279
+ brand: Visa
1280
+ ownerName: Arthur Dent
1281
+ expires:
1282
+ year: 2024
1283
+ month: 4
1284
+ paypalDetails:
1285
+ orderId: 1a2b3c4d5e6f7g8h9i0j
1286
+ payerId: 9k8j7i6h5g4f3e2d1c0b
1287
+ captureId: qwe123rty456uio789p
1288
+ refundId: abcde12345fghij67890
1289
+ refundReason: Customer requested refund
1290
+ disputeId: zxcvbnm987poiuytrewq
1291
+ customData:
1292
+ - key: value
1293
+ metadata:
1294
+ isBuyNow: false
1295
+ isCustomerDeleted: false
1296
+ isShippingRequired: true
1297
+ hasDownloads: false
1298
+ paymentProcessor: stripe
1299
+ totals:
1300
+ subtotal:
1301
+ unit: USD
1302
+ value: '5892'
1303
+ string: ' 109.05 USD'
1304
+ extras:
1305
+ - type: tax
1306
+ name: State Taxes
1307
+ description: NY Taxes (4.00%)
1308
+ price:
1309
+ unit: USD
1310
+ value: '5892'
1311
+ string: ' 4.36 USD'
1312
+ - type: tax
1313
+ name: City Taxes
1314
+ description: NEW YORK Taxes (4.88%)
1315
+ price:
1316
+ unit: USD
1317
+ value: '5892'
1318
+ string: ' 5.32 USD'
1319
+ - type: shipping
1320
+ name: Flat
1321
+ description: ''
1322
+ price:
1323
+ unit: USD
1324
+ value: '5892'
1325
+ string: ' 0.00 USD'
1326
+ total:
1327
+ unit: USD
1328
+ value: '5892'
1329
+ string: ' 118.73 USD'
1330
+ downloadFiles:
1331
+ - id: 5e9a5eba75e0ac242e1b6f64
1332
+ name: New product guide
1333
+ url: >-
1334
+ https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa
1335
+ refund:
1336
+ path: /sites/{site_id}/orders/{order_id}/refund
1337
+ method: POST
1338
+ auth: true
1339
+ docs: |
1340
+ This API will reverse a Stripe charge and refund an order back to a
1341
+ customer. It will also set the order's status to `refunded`.
1342
+
1343
+ Required scope | `ecommerce:write`
1344
+ source:
1345
+ openapi: ../../../referenced-specs/v2.yml
1346
+ path-parameters:
1347
+ site_id:
1348
+ type: string
1349
+ docs: Unique identifier for a Site
1350
+ order_id:
1351
+ type: string
1352
+ docs: Unique identifier for an Order
1353
+ display-name: Refund Order
1354
+ request:
1355
+ name: OrdersRefundRequest
1356
+ body:
1357
+ properties:
1358
+ reason:
1359
+ type: optional<OrdersRefundRequestReason>
1360
+ docs: The reason for the refund
1361
+ content-type: application/json
1362
+ response:
1363
+ docs: Request was successful
1364
+ type: root.Order
1365
+ errors:
1366
+ - root.BadRequestError
1367
+ - root.UnauthorizedError
1368
+ - root.ForbiddenError
1369
+ - root.NotFoundError
1370
+ - root.ConflictError
1371
+ - root.TooManyRequestsError
1372
+ - root.InternalServerError
1373
+ examples:
1374
+ - path-parameters:
1375
+ site_id: 580e63e98c9a982ac9b8b741
1376
+ order_id: 5e8518516e147040726cc415
1377
+ request: {}
1378
+ response:
1379
+ body:
1380
+ orderId: fc7-128
1381
+ status: refunded
1382
+ comment: >-
1383
+ Customer requested gift wrapping and a personalized note saying:
1384
+ Happy Birthday, Ford! 🎉 Please ensure the item is packed with
1385
+ extra bubble wrap for safe transit.
1386
+ orderComment: >-
1387
+ Please gift wrap with a personal note saying "Happy Birthday,
1388
+ Ford! 🎉
1389
+ acceptedOn: '2024-03-29T21:29:21Z'
1390
+ fulfilledOn: '2024-03-29T21:29:21Z'
1391
+ refundedOn: '2024-04-08T18:25:04Z'
1392
+ disputedOn: '2024-03-29T21:29:21Z'
1393
+ disputeUpdatedOn: '2024-03-29T21:29:21Z'
1394
+ disputeLastStatus: charge_refunded
1395
+ customerPaid:
1396
+ unit: USD
1397
+ value: '5892'
1398
+ string: ' 118.73 USD'
1399
+ netAmount:
1400
+ unit: USD
1401
+ value: '5892'
1402
+ string: ' 112.62 USD'
1403
+ applicationFee:
1404
+ unit: USD
1405
+ value: '5892'
1406
+ string: ' 2.37 USD'
1407
+ allAddresses:
1408
+ - type: billing
1409
+ japanType: kana
1410
+ addressee: Arthur Dent
1411
+ line1: 20 W 34th St
1412
+ line2: Empire State Building
1413
+ city: New York
1414
+ state: New York
1415
+ country: US
1416
+ postalCode: '10118'
1417
+ - type: shipping
1418
+ japanType: kana
1419
+ addressee: Arthur Dent
1420
+ line1: 20 W 34th St
1421
+ line2: Empire State Building
1422
+ city: New York
1423
+ state: New York
1424
+ country: US
1425
+ postalCode: '10118'
1426
+ shippingAddress:
1427
+ type: shipping
1428
+ japanType: kanji
1429
+ addressee: Arthur Dent
1430
+ line1: 20 W 34th St
1431
+ line2: Empire State Building
1432
+ city: New York
1433
+ state: New York
1434
+ country: US
1435
+ postalCode: '10118'
1436
+ billingAddress:
1437
+ type: billing
1438
+ japanType: kana
1439
+ addressee: Arthur Dent
1440
+ line1: 20 W 34th St
1441
+ line2: Empire State Building
1442
+ city: New York
1443
+ state: New York
1444
+ country: US
1445
+ postalCode: '10118'
1446
+ shippingProvider: Shipping Company, Co.
1447
+ shippingTracking: tr00000000001
1448
+ shippingTrackingURL: https://www.shippingcompany.com/tracking/tr00000000001
1449
+ customerInfo:
1450
+ fullName: Arthur Dent
1451
+ email: arthur.dent@example.com
1452
+ purchasedItems:
1453
+ - count: 1
1454
+ rowTotal:
1455
+ unit: USD
1456
+ value: '5892'
1457
+ string: ' 55.61 USD'
1458
+ productId: 66072fb61b89448912e26791
1459
+ productName: Luxurious Fresh Ball
1460
+ productSlug: luxurious-fresh-ball
1461
+ variantId: 66072fb71b89448912e2683f
1462
+ variantName: 'Luxurious Fresh Ball Generic: Bronze, Practical: Plastic'
1463
+ variantSlug: luxurious-fresh-ball-generic-bronze-practical-plastic
1464
+ variantSKU: luxurious-fresh-ball-generic-bronze-practical-plastic
1465
+ variantImage:
1466
+ url: >-
1467
+ https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2672c_image14.jpeg
1468
+ variantPrice:
1469
+ unit: USD
1470
+ value: '5892'
1471
+ string: ' 55.61 USD'
1472
+ weight: 11
1473
+ width: 82
1474
+ height: 70
1475
+ length: 9
1476
+ - count: 1
1477
+ rowTotal:
1478
+ unit: USD
1479
+ value: '5892'
1480
+ string: ' 53.44 USD'
1481
+ productId: 66072fb61b89448912e26799
1482
+ productName: Recycled Steel Gloves
1483
+ productSlug: recycled-steel-gloves
1484
+ variantId: 66072fb91b89448912e26ab9
1485
+ variantName: 'Recycled Steel Gloves Electronic: Granite, Handcrafted: grey'
1486
+ variantSlug: recycled-steel-gloves-electronic-granite-handcrafted-grey
1487
+ variantSKU: recycled-steel-gloves-electronic-granite-handcrafted-grey
1488
+ variantImage:
1489
+ url: >-
1490
+ https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2671e_image2.jpeg
1491
+ variantPrice:
1492
+ unit: USD
1493
+ value: '5892'
1494
+ string: ' 53.44 USD'
1495
+ weight: 38
1496
+ width: 76
1497
+ height: 85
1498
+ length: 40
1499
+ purchasedItemsCount: 2
1500
+ stripeDetails:
1501
+ subscriptionId: sub_1J6xwG2eZvKYlo2CXu9Zt0Tn
1502
+ paymentMethod: pm_1OzmzBJYFi4lcbXWHKNdXU7j
1503
+ paymentIntentId: pi_3OzmzDJYFi4lcbXW1hTBW6ft
1504
+ customerId: cus_PpRsNHwWdUoRKR
1505
+ chargeId: ch_3OzmzDJYFi4lcbXW1ndkkrH2
1506
+ disputeId: disputeId
1507
+ refundId: re_3OzmzDJYFi4lcbXW1kFAmlBk
1508
+ refundReason: fraudulent
1509
+ stripeCard:
1510
+ last4: '4242'
1511
+ brand: Visa
1512
+ ownerName: Arthur Dent
1513
+ expires:
1514
+ year: 2024
1515
+ month: 4
1516
+ paypalDetails:
1517
+ orderId: 1a2b3c4d5e6f7g8h9i0j
1518
+ payerId: 9k8j7i6h5g4f3e2d1c0b
1519
+ captureId: qwe123rty456uio789p
1520
+ refundId: abcde12345fghij67890
1521
+ refundReason: Customer requested refund
1522
+ disputeId: zxcvbnm987poiuytrewq
1523
+ customData:
1524
+ - key: value
1525
+ metadata:
1526
+ isBuyNow: false
1527
+ isCustomerDeleted: false
1528
+ isShippingRequired: true
1529
+ hasDownloads: false
1530
+ paymentProcessor: stripe
1531
+ totals:
1532
+ subtotal:
1533
+ unit: USD
1534
+ value: '5892'
1535
+ string: ' 109.05 USD'
1536
+ extras:
1537
+ - type: tax
1538
+ name: State Taxes
1539
+ description: NY Taxes (4.00%)
1540
+ price:
1541
+ unit: USD
1542
+ value: '5892'
1543
+ string: ' 4.36 USD'
1544
+ - type: tax
1545
+ name: City Taxes
1546
+ description: NEW YORK Taxes (4.88%)
1547
+ price:
1548
+ unit: USD
1549
+ value: '5892'
1550
+ string: ' 5.32 USD'
1551
+ - type: shipping
1552
+ name: Flat
1553
+ description: ''
1554
+ price:
1555
+ unit: USD
1556
+ value: '5892'
1557
+ string: ' 0.00 USD'
1558
+ total:
1559
+ unit: USD
1560
+ value: '5892'
1561
+ string: ' 118.73 USD'
1562
+ downloadFiles:
1563
+ - id: 5e9a5eba75e0ac242e1b6f64
1564
+ name: New product guide
1565
+ url: >-
1566
+ https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa
1567
+ source:
1568
+ openapi: ../../../referenced-specs/v2.yml
1569
+ display-name: Orders