@wix/ecom 1.0.504 → 1.0.506

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 (261) hide show
  1. package/build/cjs/context.d.ts +15 -0
  2. package/build/cjs/context.js +16 -1
  3. package/build/cjs/context.js.map +1 -1
  4. package/build/cjs/index.d.ts +1 -1
  5. package/build/cjs/index.js +2 -2
  6. package/build/cjs/index.js.map +1 -1
  7. package/build/cjs/index.typings.d.ts +1 -1
  8. package/build/cjs/index.typings.js +2 -2
  9. package/build/cjs/index.typings.js.map +1 -1
  10. package/build/cjs/meta.d.ts +1 -1
  11. package/build/cjs/meta.js +2 -2
  12. package/build/cjs/meta.js.map +1 -1
  13. package/build/cjs/src/ecom-discounts-v1-discount-rule.context.d.ts +7 -0
  14. package/build/cjs/src/ecom-discounts-v1-discount-rule.context.js +60 -0
  15. package/build/cjs/src/ecom-discounts-v1-discount-rule.context.js.map +1 -0
  16. package/build/cjs/src/ecom-discounts-v1-discount-rule.universal.d.ts +0 -6
  17. package/build/cjs/src/ecom-discounts-v1-discount-rule.universal.js +1 -18
  18. package/build/cjs/src/ecom-discounts-v1-discount-rule.universal.js.map +1 -1
  19. package/build/cjs/src/ecom-orders-v1-invoice.context.d.ts +3 -0
  20. package/build/cjs/src/ecom-orders-v1-invoice.context.js +16 -0
  21. package/build/cjs/src/ecom-orders-v1-invoice.context.js.map +1 -0
  22. package/build/cjs/src/ecom-orders-v1-invoice.universal.d.ts +0 -6
  23. package/build/cjs/src/ecom-orders-v1-invoice.universal.js +1 -15
  24. package/build/cjs/src/ecom-orders-v1-invoice.universal.js.map +1 -1
  25. package/build/cjs/src/ecom-recommendations-v1-recommendation.context.d.ts +4 -0
  26. package/build/cjs/src/ecom-recommendations-v1-recommendation.context.js +27 -0
  27. package/build/cjs/src/ecom-recommendations-v1-recommendation.context.js.map +1 -0
  28. package/build/cjs/src/ecom-recommendations-v1-recommendation.universal.d.ts +0 -6
  29. package/build/cjs/src/ecom-recommendations-v1-recommendation.universal.js +1 -16
  30. package/build/cjs/src/ecom-recommendations-v1-recommendation.universal.js.map +1 -1
  31. package/build/cjs/src/ecom-v1-abandoned-checkout.context.d.ts +3 -0
  32. package/build/cjs/src/ecom-v1-abandoned-checkout.context.js +16 -0
  33. package/build/cjs/src/ecom-v1-abandoned-checkout.context.js.map +1 -0
  34. package/build/cjs/src/ecom-v1-abandoned-checkout.universal.d.ts +0 -6
  35. package/build/cjs/src/ecom-v1-abandoned-checkout.universal.js +1 -15
  36. package/build/cjs/src/ecom-v1-abandoned-checkout.universal.js.map +1 -1
  37. package/build/cjs/src/ecom-v1-back-in-stock-notification-request.context.d.ts +9 -0
  38. package/build/cjs/src/ecom-v1-back-in-stock-notification-request.context.js +82 -0
  39. package/build/cjs/src/ecom-v1-back-in-stock-notification-request.context.js.map +1 -0
  40. package/build/cjs/src/ecom-v1-back-in-stock-notification-request.universal.d.ts +0 -6
  41. package/build/cjs/src/ecom-v1-back-in-stock-notification-request.universal.js +1 -20
  42. package/build/cjs/src/ecom-v1-back-in-stock-notification-request.universal.js.map +1 -1
  43. package/build/cjs/src/ecom-v1-back-in-stock-settings.context.d.ts +5 -0
  44. package/build/cjs/src/ecom-v1-back-in-stock-settings.context.js +38 -0
  45. package/build/cjs/src/ecom-v1-back-in-stock-settings.context.js.map +1 -0
  46. package/build/cjs/src/ecom-v1-back-in-stock-settings.universal.d.ts +0 -6
  47. package/build/cjs/src/ecom-v1-back-in-stock-settings.universal.js +1 -17
  48. package/build/cjs/src/ecom-v1-back-in-stock-settings.universal.js.map +1 -1
  49. package/build/cjs/src/ecom-v1-cart-cart.context.d.ts +12 -0
  50. package/build/cjs/src/ecom-v1-cart-cart.context.js +115 -0
  51. package/build/cjs/src/ecom-v1-cart-cart.context.js.map +1 -0
  52. package/build/cjs/src/ecom-v1-cart-cart.http.d.ts +1 -1
  53. package/build/cjs/src/ecom-v1-cart-cart.http.js +1 -1
  54. package/build/cjs/src/ecom-v1-cart-cart.types.d.ts +0 -2
  55. package/build/cjs/src/ecom-v1-cart-cart.types.js.map +1 -1
  56. package/build/cjs/src/ecom-v1-cart-cart.universal.d.ts +15 -9
  57. package/build/cjs/src/ecom-v1-cart-cart.universal.js +16 -25
  58. package/build/cjs/src/ecom-v1-cart-cart.universal.js.map +1 -1
  59. package/build/cjs/src/ecom-v1-cart-current-cart.context.d.ts +11 -0
  60. package/build/cjs/src/ecom-v1-cart-current-cart.context.js +104 -0
  61. package/build/cjs/src/ecom-v1-cart-current-cart.context.js.map +1 -0
  62. package/build/cjs/src/ecom-v1-cart-current-cart.http.d.ts +2 -2
  63. package/build/cjs/src/ecom-v1-cart-current-cart.http.js +2 -2
  64. package/build/cjs/src/ecom-v1-cart-current-cart.types.d.ts +0 -2
  65. package/build/cjs/src/ecom-v1-cart-current-cart.types.js.map +1 -1
  66. package/build/cjs/src/ecom-v1-cart-current-cart.universal.d.ts +13 -9
  67. package/build/cjs/src/ecom-v1-cart-current-cart.universal.js +14 -24
  68. package/build/cjs/src/ecom-v1-cart-current-cart.universal.js.map +1 -1
  69. package/build/cjs/src/ecom-v1-checkout-checkout.context.d.ts +14 -0
  70. package/build/cjs/src/ecom-v1-checkout-checkout.context.js +137 -0
  71. package/build/cjs/src/ecom-v1-checkout-checkout.context.js.map +1 -0
  72. package/build/cjs/src/ecom-v1-checkout-checkout.types.d.ts +0 -2
  73. package/build/cjs/src/ecom-v1-checkout-checkout.types.js.map +1 -1
  74. package/build/cjs/src/ecom-v1-checkout-checkout.universal.d.ts +0 -8
  75. package/build/cjs/src/ecom-v1-checkout-checkout.universal.js +1 -26
  76. package/build/cjs/src/ecom-v1-checkout-checkout.universal.js.map +1 -1
  77. package/build/cjs/src/ecom-v1-checkout-settings.context.d.ts +4 -0
  78. package/build/cjs/src/ecom-v1-checkout-settings.context.js +27 -0
  79. package/build/cjs/src/ecom-v1-checkout-settings.context.js.map +1 -0
  80. package/build/cjs/src/ecom-v1-checkout-settings.public.d.ts +1 -1
  81. package/build/cjs/src/ecom-v1-checkout-settings.types.d.ts +48 -8
  82. package/build/cjs/src/ecom-v1-checkout-settings.universal.d.ts +50 -15
  83. package/build/cjs/src/ecom-v1-checkout-settings.universal.js +1 -16
  84. package/build/cjs/src/ecom-v1-checkout-settings.universal.js.map +1 -1
  85. package/build/cjs/src/ecom-v1-checkout-template.context.d.ts +8 -0
  86. package/build/cjs/src/ecom-v1-checkout-template.context.js +71 -0
  87. package/build/cjs/src/ecom-v1-checkout-template.context.js.map +1 -0
  88. package/build/cjs/src/ecom-v1-checkout-template.types.d.ts +0 -2
  89. package/build/cjs/src/ecom-v1-checkout-template.types.js.map +1 -1
  90. package/build/cjs/src/ecom-v1-checkout-template.universal.d.ts +12 -8
  91. package/build/cjs/src/ecom-v1-checkout-template.universal.js +13 -19
  92. package/build/cjs/src/ecom-v1-checkout-template.universal.js.map +1 -1
  93. package/build/cjs/src/ecom-v1-fulfillments.context.d.ts +8 -0
  94. package/build/cjs/src/ecom-v1-fulfillments.context.js +71 -0
  95. package/build/cjs/src/ecom-v1-fulfillments.context.js.map +1 -0
  96. package/build/cjs/src/ecom-v1-fulfillments.universal.d.ts +0 -6
  97. package/build/cjs/src/ecom-v1-fulfillments.universal.js +1 -20
  98. package/build/cjs/src/ecom-v1-fulfillments.universal.js.map +1 -1
  99. package/build/cjs/src/ecom-v1-order-transactions.context.d.ts +7 -0
  100. package/build/cjs/src/ecom-v1-order-transactions.context.js +60 -0
  101. package/build/cjs/src/ecom-v1-order-transactions.context.js.map +1 -0
  102. package/build/cjs/src/ecom-v1-order-transactions.http.js +3 -25
  103. package/build/cjs/src/ecom-v1-order-transactions.http.js.map +1 -1
  104. package/build/cjs/src/ecom-v1-order-transactions.universal.d.ts +0 -6
  105. package/build/cjs/src/ecom-v1-order-transactions.universal.js +1 -19
  106. package/build/cjs/src/ecom-v1-order-transactions.universal.js.map +1 -1
  107. package/build/cjs/src/ecom-v1-order.context.d.ts +8 -0
  108. package/build/cjs/src/ecom-v1-order.context.js +71 -0
  109. package/build/cjs/src/ecom-v1-order.context.js.map +1 -0
  110. package/build/cjs/src/ecom-v1-order.http.d.ts +2 -1
  111. package/build/cjs/src/ecom-v1-order.http.js +95 -17
  112. package/build/cjs/src/ecom-v1-order.http.js.map +1 -1
  113. package/build/cjs/src/ecom-v1-order.meta.d.ts +1 -0
  114. package/build/cjs/src/ecom-v1-order.meta.js +20 -1
  115. package/build/cjs/src/ecom-v1-order.meta.js.map +1 -1
  116. package/build/cjs/src/ecom-v1-order.public.d.ts +28 -3
  117. package/build/cjs/src/ecom-v1-order.public.js +14 -8
  118. package/build/cjs/src/ecom-v1-order.public.js.map +1 -1
  119. package/build/cjs/src/ecom-v1-order.types.d.ts +2017 -1389
  120. package/build/cjs/src/ecom-v1-order.types.js +61 -61
  121. package/build/cjs/src/ecom-v1-order.types.js.map +1 -1
  122. package/build/cjs/src/ecom-v1-order.universal.d.ts +1184 -796
  123. package/build/cjs/src/ecom-v1-order.universal.js +146 -79
  124. package/build/cjs/src/ecom-v1-order.universal.js.map +1 -1
  125. package/build/cjs/src/ecom-v1-orders-settings.context.d.ts +4 -0
  126. package/build/cjs/src/ecom-v1-orders-settings.context.js +27 -0
  127. package/build/cjs/src/ecom-v1-orders-settings.context.js.map +1 -0
  128. package/build/cjs/src/ecom-v1-orders-settings.universal.d.ts +0 -6
  129. package/build/cjs/src/ecom-v1-orders-settings.universal.js +1 -16
  130. package/build/cjs/src/ecom-v1-orders-settings.universal.js.map +1 -1
  131. package/build/es/context.d.ts +15 -0
  132. package/build/es/context.js +15 -0
  133. package/build/es/context.js.map +1 -1
  134. package/build/es/index.d.ts +1 -1
  135. package/build/es/index.js +1 -1
  136. package/build/es/index.js.map +1 -1
  137. package/build/es/index.typings.d.ts +1 -1
  138. package/build/es/index.typings.js +1 -1
  139. package/build/es/index.typings.js.map +1 -1
  140. package/build/es/meta.d.ts +1 -1
  141. package/build/es/meta.js +1 -1
  142. package/build/es/meta.js.map +1 -1
  143. package/build/es/src/ecom-discounts-v1-discount-rule.context.d.ts +7 -0
  144. package/build/es/src/ecom-discounts-v1-discount-rule.context.js +52 -0
  145. package/build/es/src/ecom-discounts-v1-discount-rule.context.js.map +1 -0
  146. package/build/es/src/ecom-discounts-v1-discount-rule.universal.d.ts +0 -6
  147. package/build/es/src/ecom-discounts-v1-discount-rule.universal.js +0 -17
  148. package/build/es/src/ecom-discounts-v1-discount-rule.universal.js.map +1 -1
  149. package/build/es/src/ecom-orders-v1-invoice.context.d.ts +3 -0
  150. package/build/es/src/ecom-orders-v1-invoice.context.js +12 -0
  151. package/build/es/src/ecom-orders-v1-invoice.context.js.map +1 -0
  152. package/build/es/src/ecom-orders-v1-invoice.universal.d.ts +0 -6
  153. package/build/es/src/ecom-orders-v1-invoice.universal.js +0 -14
  154. package/build/es/src/ecom-orders-v1-invoice.universal.js.map +1 -1
  155. package/build/es/src/ecom-recommendations-v1-recommendation.context.d.ts +4 -0
  156. package/build/es/src/ecom-recommendations-v1-recommendation.context.js +22 -0
  157. package/build/es/src/ecom-recommendations-v1-recommendation.context.js.map +1 -0
  158. package/build/es/src/ecom-recommendations-v1-recommendation.universal.d.ts +0 -6
  159. package/build/es/src/ecom-recommendations-v1-recommendation.universal.js +0 -15
  160. package/build/es/src/ecom-recommendations-v1-recommendation.universal.js.map +1 -1
  161. package/build/es/src/ecom-v1-abandoned-checkout.context.d.ts +3 -0
  162. package/build/es/src/ecom-v1-abandoned-checkout.context.js +12 -0
  163. package/build/es/src/ecom-v1-abandoned-checkout.context.js.map +1 -0
  164. package/build/es/src/ecom-v1-abandoned-checkout.universal.d.ts +0 -6
  165. package/build/es/src/ecom-v1-abandoned-checkout.universal.js +0 -14
  166. package/build/es/src/ecom-v1-abandoned-checkout.universal.js.map +1 -1
  167. package/build/es/src/ecom-v1-back-in-stock-notification-request.context.d.ts +9 -0
  168. package/build/es/src/ecom-v1-back-in-stock-notification-request.context.js +72 -0
  169. package/build/es/src/ecom-v1-back-in-stock-notification-request.context.js.map +1 -0
  170. package/build/es/src/ecom-v1-back-in-stock-notification-request.universal.d.ts +0 -6
  171. package/build/es/src/ecom-v1-back-in-stock-notification-request.universal.js +0 -19
  172. package/build/es/src/ecom-v1-back-in-stock-notification-request.universal.js.map +1 -1
  173. package/build/es/src/ecom-v1-back-in-stock-settings.context.d.ts +5 -0
  174. package/build/es/src/ecom-v1-back-in-stock-settings.context.js +32 -0
  175. package/build/es/src/ecom-v1-back-in-stock-settings.context.js.map +1 -0
  176. package/build/es/src/ecom-v1-back-in-stock-settings.universal.d.ts +0 -6
  177. package/build/es/src/ecom-v1-back-in-stock-settings.universal.js +0 -16
  178. package/build/es/src/ecom-v1-back-in-stock-settings.universal.js.map +1 -1
  179. package/build/es/src/ecom-v1-cart-cart.context.d.ts +12 -0
  180. package/build/es/src/ecom-v1-cart-cart.context.js +102 -0
  181. package/build/es/src/ecom-v1-cart-cart.context.js.map +1 -0
  182. package/build/es/src/ecom-v1-cart-cart.http.d.ts +1 -1
  183. package/build/es/src/ecom-v1-cart-cart.http.js +1 -1
  184. package/build/es/src/ecom-v1-cart-cart.types.d.ts +0 -2
  185. package/build/es/src/ecom-v1-cart-cart.types.js.map +1 -1
  186. package/build/es/src/ecom-v1-cart-cart.universal.d.ts +15 -9
  187. package/build/es/src/ecom-v1-cart-cart.universal.js +15 -24
  188. package/build/es/src/ecom-v1-cart-cart.universal.js.map +1 -1
  189. package/build/es/src/ecom-v1-cart-current-cart.context.d.ts +11 -0
  190. package/build/es/src/ecom-v1-cart-current-cart.context.js +92 -0
  191. package/build/es/src/ecom-v1-cart-current-cart.context.js.map +1 -0
  192. package/build/es/src/ecom-v1-cart-current-cart.http.d.ts +2 -2
  193. package/build/es/src/ecom-v1-cart-current-cart.http.js +2 -2
  194. package/build/es/src/ecom-v1-cart-current-cart.types.d.ts +0 -2
  195. package/build/es/src/ecom-v1-cart-current-cart.types.js.map +1 -1
  196. package/build/es/src/ecom-v1-cart-current-cart.universal.d.ts +13 -9
  197. package/build/es/src/ecom-v1-cart-current-cart.universal.js +13 -23
  198. package/build/es/src/ecom-v1-cart-current-cart.universal.js.map +1 -1
  199. package/build/es/src/ecom-v1-checkout-checkout.context.d.ts +14 -0
  200. package/build/es/src/ecom-v1-checkout-checkout.context.js +122 -0
  201. package/build/es/src/ecom-v1-checkout-checkout.context.js.map +1 -0
  202. package/build/es/src/ecom-v1-checkout-checkout.types.d.ts +0 -2
  203. package/build/es/src/ecom-v1-checkout-checkout.types.js.map +1 -1
  204. package/build/es/src/ecom-v1-checkout-checkout.universal.d.ts +0 -8
  205. package/build/es/src/ecom-v1-checkout-checkout.universal.js +0 -25
  206. package/build/es/src/ecom-v1-checkout-checkout.universal.js.map +1 -1
  207. package/build/es/src/ecom-v1-checkout-settings.context.d.ts +4 -0
  208. package/build/es/src/ecom-v1-checkout-settings.context.js +22 -0
  209. package/build/es/src/ecom-v1-checkout-settings.context.js.map +1 -0
  210. package/build/es/src/ecom-v1-checkout-settings.public.d.ts +1 -1
  211. package/build/es/src/ecom-v1-checkout-settings.types.d.ts +48 -8
  212. package/build/es/src/ecom-v1-checkout-settings.universal.d.ts +50 -15
  213. package/build/es/src/ecom-v1-checkout-settings.universal.js +0 -15
  214. package/build/es/src/ecom-v1-checkout-settings.universal.js.map +1 -1
  215. package/build/es/src/ecom-v1-checkout-template.context.d.ts +8 -0
  216. package/build/es/src/ecom-v1-checkout-template.context.js +62 -0
  217. package/build/es/src/ecom-v1-checkout-template.context.js.map +1 -0
  218. package/build/es/src/ecom-v1-checkout-template.types.d.ts +0 -2
  219. package/build/es/src/ecom-v1-checkout-template.types.js.map +1 -1
  220. package/build/es/src/ecom-v1-checkout-template.universal.d.ts +12 -8
  221. package/build/es/src/ecom-v1-checkout-template.universal.js +12 -18
  222. package/build/es/src/ecom-v1-checkout-template.universal.js.map +1 -1
  223. package/build/es/src/ecom-v1-fulfillments.context.d.ts +8 -0
  224. package/build/es/src/ecom-v1-fulfillments.context.js +62 -0
  225. package/build/es/src/ecom-v1-fulfillments.context.js.map +1 -0
  226. package/build/es/src/ecom-v1-fulfillments.universal.d.ts +0 -6
  227. package/build/es/src/ecom-v1-fulfillments.universal.js +0 -19
  228. package/build/es/src/ecom-v1-fulfillments.universal.js.map +1 -1
  229. package/build/es/src/ecom-v1-order-transactions.context.d.ts +7 -0
  230. package/build/es/src/ecom-v1-order-transactions.context.js +52 -0
  231. package/build/es/src/ecom-v1-order-transactions.context.js.map +1 -0
  232. package/build/es/src/ecom-v1-order-transactions.http.js +3 -25
  233. package/build/es/src/ecom-v1-order-transactions.http.js.map +1 -1
  234. package/build/es/src/ecom-v1-order-transactions.universal.d.ts +0 -6
  235. package/build/es/src/ecom-v1-order-transactions.universal.js +0 -18
  236. package/build/es/src/ecom-v1-order-transactions.universal.js.map +1 -1
  237. package/build/es/src/ecom-v1-order.context.d.ts +8 -0
  238. package/build/es/src/ecom-v1-order.context.js +62 -0
  239. package/build/es/src/ecom-v1-order.context.js.map +1 -0
  240. package/build/es/src/ecom-v1-order.http.d.ts +2 -1
  241. package/build/es/src/ecom-v1-order.http.js +93 -16
  242. package/build/es/src/ecom-v1-order.http.js.map +1 -1
  243. package/build/es/src/ecom-v1-order.meta.d.ts +1 -0
  244. package/build/es/src/ecom-v1-order.meta.js +18 -0
  245. package/build/es/src/ecom-v1-order.meta.js.map +1 -1
  246. package/build/es/src/ecom-v1-order.public.d.ts +28 -3
  247. package/build/es/src/ecom-v1-order.public.js +7 -2
  248. package/build/es/src/ecom-v1-order.public.js.map +1 -1
  249. package/build/es/src/ecom-v1-order.types.d.ts +2017 -1389
  250. package/build/es/src/ecom-v1-order.types.js +60 -60
  251. package/build/es/src/ecom-v1-order.types.js.map +1 -1
  252. package/build/es/src/ecom-v1-order.universal.d.ts +1184 -796
  253. package/build/es/src/ecom-v1-order.universal.js +144 -78
  254. package/build/es/src/ecom-v1-order.universal.js.map +1 -1
  255. package/build/es/src/ecom-v1-orders-settings.context.d.ts +4 -0
  256. package/build/es/src/ecom-v1-orders-settings.context.js +22 -0
  257. package/build/es/src/ecom-v1-orders-settings.context.js.map +1 -0
  258. package/build/es/src/ecom-v1-orders-settings.universal.d.ts +0 -6
  259. package/build/es/src/ecom-v1-orders-settings.universal.js +0 -15
  260. package/build/es/src/ecom-v1-orders-settings.universal.js.map +1 -1
  261. package/package.json +2 -2
@@ -120,6 +120,8 @@ export interface Order {
120
120
  * + No shipping option is selected.
121
121
  */
122
122
  recipientInfo?: AddressWithContact;
123
+ /** Tag ids collections associated with current entity. private_tags requires separate permissions to be accessible and modifiable. */
124
+ tags?: Tags;
123
125
  }
124
126
  export interface OrderLineItem {
125
127
  /** Line item ID. */
@@ -1107,6 +1109,38 @@ export interface ExtendedFields {
1107
1109
  */
1108
1110
  namespaces?: Record<string, Record<string, any>>;
1109
1111
  }
1112
+ /**
1113
+ * Common object for tags.
1114
+ * Should be use as in this example:
1115
+ * message Foo {
1116
+ * string id = 1;
1117
+ * ...
1118
+ * Tags tags = 5
1119
+ * }
1120
+ *
1121
+ * example of taggable entity
1122
+ * {
1123
+ * id: "123"
1124
+ * tags: {
1125
+ * tags: {
1126
+ * tag_ids:["11","22"]
1127
+ * },
1128
+ * private_tags: {
1129
+ * tag_ids: ["33", "44"]
1130
+ * }
1131
+ * }
1132
+ * }
1133
+ */
1134
+ export interface Tags {
1135
+ /** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
1136
+ privateTags?: TagList;
1137
+ /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
1138
+ tags?: TagList;
1139
+ }
1140
+ export interface TagList {
1141
+ /** List of tag IDs */
1142
+ tagIds?: string[];
1143
+ }
1110
1144
  export interface TriggerReindexWithConsistencyRequest {
1111
1145
  metasiteId?: string;
1112
1146
  orderId?: string;
@@ -2002,827 +2036,658 @@ export interface PreviewResendDownloadLinksEmailRequest {
2002
2036
  export interface PreviewResendDownloadLinksEmailResponse {
2003
2037
  emailPreview?: string;
2004
2038
  }
2005
- export interface InvoicePaidEvent {
2006
- id?: IdAndVersion;
2007
- /** @readonly */
2008
- data?: InvoiceFields;
2009
- /** @readonly */
2010
- status?: InvoiceStatus;
2011
- }
2012
- export interface IdAndVersion {
2013
- id?: string | null;
2014
- version?: number | null;
2015
- }
2016
- export interface InvoiceFields {
2017
- /** The invoice number allocated the invoice by the server. The number is limited to at most 11 digits. */
2018
- number?: string | null;
2019
- /** The invoice 3-letter currency code in [ISO-4217 alphabetic](https://www.iso.org/iso-4217-currency-codes.html) format. */
2020
- currencyCode?: string | null;
2021
- /** The invoice customer. The customer must be a contact of the site, with an email. */
2022
- customer?: Customer;
2023
- /**
2024
- * Invoice dates: issue date and due date are mandatory and provided when the invoice is created.
2025
- * Last seen date is the optional date when the invoice was last seen be UoU.
2026
- */
2027
- dates?: InvoiceDates;
2028
- /**
2029
- * Line items containing the details of the products or services relevant to the invoice, with their name, prices,
2030
- * and quantity. There must be at least one line item on the invoice.
2031
- */
2032
- lineItems?: LineItems;
2033
- /**
2034
- * Locale of the invoice, containing the language.
2035
- * This field is not mandatory but is used for display purposes, to determine the appearance of numbers and dates
2036
- * on the invoice.
2037
- */
2038
- locale?: Locale;
2039
- /**
2040
- * The totals on the invoice.
2041
- * The totals.subtotal, totals.total and totals.taxed_amount are calculated by the server based on the line items.
2042
- * Alternatively, these fields can be provided in the invoice creation request, in this case, these values are fixed.
2043
- * The totals contain fees and a discount, that apply to the invoice.
2044
- */
2045
- totals?: TotalPrice;
2046
- /** An optional discount on the invoice. */
2047
- discount?: Discount;
2048
- /** The taxes of the invoice. */
2049
- taxes?: CalculatedTaxes;
2050
- /** The payments on the invoice. The invoice has status paid if its payments cover the invoice total. */
2051
- payments?: Payments;
2052
- /** Invoice metadata */
2053
- metaData?: MetaData;
2054
- /** Not used */
2055
- creationAdditional_BIInformation?: string | null;
2039
+ export interface PreparePaymentCollectionRequest {
2040
+ /** Ecom order ID. */
2041
+ ecomOrderId?: string;
2042
+ /** Amount to collect */
2043
+ amount?: Price;
2056
2044
  /**
2057
- * The balance and amount paid on the invoice.
2058
- * This read-only field is calculated based on the invoice totals and payments.
2059
- * @readonly
2045
+ * Optional parameter. When present, payment collection will be performed using given payment gateway order.
2046
+ * Existing payment gateway order will be updated with a new amount.
2047
+ * When parameter is absent, new payment gateway order will be created and used for payment collection.
2060
2048
  */
2061
- dynamicTotals?: InvoiceDynamicPriceTotals;
2062
- /** The invoice title */
2063
- title?: string | null;
2064
- /** Invoice custom fields */
2065
- customFields?: CustomFieldValue[];
2066
- /** Not used */
2067
- designTemplateId?: string | null;
2068
- /** Not used */
2069
- createOrder?: boolean | null;
2070
- /** The optional deposit of the invoice */
2071
- deposit?: Deposit;
2072
- /** associated checkout for this invoice */
2073
- ecomCheckoutId?: string | null;
2074
- }
2075
- export interface Customer {
2076
- contactId?: string | null;
2077
- name?: string | null;
2078
- email?: Email;
2079
- address?: QuotesAddress;
2080
- phone?: Phone;
2081
- company?: Company;
2082
- firstName?: string | null;
2083
- lastName?: string | null;
2084
- billingAddress?: CommonAddress;
2085
- shippingAddress?: CommonAddress;
2049
+ paymentGatewayOrderId?: string | null;
2086
2050
  }
2087
- export interface Email {
2088
- address?: string;
2051
+ export interface PreparePaymentCollectionResponse {
2052
+ /** Payment gateway order id which is associated with given payment */
2053
+ paymentGatewayOrderId?: string;
2089
2054
  }
2090
- export interface QuotesAddress {
2091
- street?: string | null;
2092
- city?: string | null;
2093
- zip?: string | null;
2094
- state?: string | null;
2095
- country?: string | null;
2096
- /** @readonly */
2097
- description?: AddressDescription;
2055
+ export interface GetPaymentCollectabilityStatusRequest {
2056
+ /** Ecom order ID. */
2057
+ ecomOrderId?: string;
2098
2058
  }
2099
- export interface AddressDescription {
2100
- content?: string;
2101
- placement?: Placement;
2059
+ export interface GetPaymentCollectabilityStatusResponse {
2060
+ /** Payment collectability status */
2061
+ status?: PaymentCollectabilityStatus;
2062
+ /** Collectable order amount */
2063
+ amount?: Price;
2102
2064
  }
2103
- export declare enum Placement {
2104
- Unknown = "Unknown",
2105
- Replace = "Replace",
2106
- Before = "Before",
2107
- After = "After"
2065
+ export declare enum PaymentCollectabilityStatus {
2066
+ UNKNOWN = "UNKNOWN",
2067
+ COLLECTABLE = "COLLECTABLE",
2068
+ NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
2069
+ NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
2070
+ NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD"
2108
2071
  }
2109
- export interface Phone {
2110
- number?: string;
2072
+ export interface RecordManuallyCollectedPaymentRequest {
2073
+ /** Order ID. */
2074
+ orderId?: string;
2075
+ /** Amount to be recorded as approved manual payment for given order */
2076
+ amount?: Price;
2111
2077
  }
2112
- export interface Company {
2113
- name?: string;
2114
- id?: string | null;
2078
+ export interface RecordManuallyCollectedPaymentResponse {
2115
2079
  }
2116
- /** Physical address */
2117
- export interface CommonAddress extends CommonAddressStreetOneOf {
2118
- /** Street name and number. */
2119
- streetAddress?: StreetAddress;
2120
- /** Main address line, usually street and number as free text. */
2121
- addressLine?: string | null;
2122
- /** Country code. */
2123
- country?: string | null;
2124
- /** Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
2125
- subdivision?: string | null;
2126
- /** City name. */
2127
- city?: string | null;
2128
- /** Zip/postal code. */
2129
- postalCode?: string | null;
2130
- /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
2131
- addressLine2?: string | null;
2080
+ export interface V1MarkOrderAsPaidRequest {
2081
+ /** Ecom order ID. */
2082
+ ecomOrderId?: string;
2132
2083
  }
2133
- /** @oneof */
2134
- export interface CommonAddressStreetOneOf {
2135
- /** Street name and number. */
2136
- streetAddress?: StreetAddress;
2137
- /** Main address line, usually street and number as free text. */
2138
- addressLine?: string | null;
2084
+ export interface V1MarkOrderAsPaidResponse {
2085
+ /** Updated order. */
2086
+ order?: Order;
2139
2087
  }
2140
- export interface Subdivision {
2141
- /** Short subdivision code. */
2142
- code?: string;
2143
- /** Subdivision full name. */
2144
- name?: string;
2088
+ /** Triggered when the payment status of an order is updated */
2089
+ export interface PaymentStatusUpdated {
2090
+ /** The order that was updated */
2091
+ order?: Order;
2092
+ /** The previous status (before the update) */
2093
+ previousPaymentStatus?: PaymentStatus;
2145
2094
  }
2146
- export declare enum SubdivisionType {
2147
- UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
2148
- /** State */
2149
- ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
2150
- /** County */
2151
- ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
2152
- /** City/town */
2153
- ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
2154
- /** Neighborhood/quarter */
2155
- ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
2156
- /** Street/block */
2157
- ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
2158
- /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
2159
- COUNTRY = "COUNTRY"
2095
+ export interface V1BulkMarkOrdersAsPaidRequest {
2096
+ /** IDs of orders to mark as paid. */
2097
+ ecomOrderIds?: string[];
2160
2098
  }
2161
- export interface InvoiceDates {
2162
- /** use UTC midnight date to set the issue date according to the site time zone */
2163
- issueDate?: Date;
2164
- /** use UTC midnight date to set the due date according to the site time zone */
2165
- dueDate?: Date;
2166
- /** <a href="http://joda-time.sourceforge.net/timezones.html">Valid time zones</a> */
2167
- timeZoneCode?: string | null;
2099
+ export interface V1BulkMarkOrdersAsPaidResponse {
2168
2100
  /**
2169
- * ignored in request use in response to get the site time zone
2170
- * @readonly
2101
+ * Items updated by the bulk action.
2102
+ * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
2171
2103
  */
2172
- lastSeenDate?: Date;
2173
- }
2174
- export interface LineItems {
2175
- lineItems?: LineItem[];
2104
+ results?: BulkOrderResult[];
2105
+ /** Bulk action metadata. */
2106
+ bulkActionMetadata?: BulkActionMetadata;
2176
2107
  }
2177
- export interface LineItem {
2178
- id?: string;
2179
- name?: string;
2180
- description?: string | null;
2181
- price?: BigDecimalWrapper;
2182
- taxedTotal?: BigDecimalWrapper;
2183
- quantity?: BigDecimalWrapper;
2184
- taxes?: LineItemTax[];
2185
- /** The source of the line item */
2186
- source?: Source;
2187
- /** The line-item level metadata. */
2188
- metadata?: LineItemMetaData;
2108
+ export interface BulkOrderResult {
2109
+ /** Item metadata. */
2110
+ itemMetadata?: ItemMetadata;
2111
+ /** Updated item. Optional - returned only if requested with `return_full_entity` set to `true`. */
2112
+ item?: Order;
2189
2113
  }
2190
- export interface BigDecimalWrapper {
2191
- serializedValue?: number;
2114
+ export interface ItemMetadata {
2115
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
2116
+ id?: string | null;
2117
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
2118
+ originalIndex?: number;
2119
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
2120
+ success?: boolean;
2121
+ /** Details about the error in case of failure. */
2122
+ error?: ApplicationError;
2192
2123
  }
2193
- export interface LineItemTax {
2194
- name?: string;
2195
- rate?: BigDecimalWrapper;
2196
- code?: string | null;
2124
+ export interface ApplicationError {
2125
+ /** Error code. */
2126
+ code?: string;
2127
+ /** Description of the error. */
2128
+ description?: string;
2129
+ /** Data related to the error. */
2130
+ data?: Record<string, any> | null;
2197
2131
  }
2198
- export interface Source {
2199
- /**
2200
- * Source app or service ID.
2201
- * @readonly
2202
- */
2203
- sourceId?: string;
2204
- /**
2205
- * App or service type.
2206
- * @readonly
2207
- */
2208
- sourceType?: SourceType;
2132
+ export interface BulkActionMetadata {
2133
+ /** Number of items that were successfully processed. */
2134
+ totalSuccesses?: number;
2135
+ /** Number of items that couldn't be processed. */
2136
+ totalFailures?: number;
2137
+ /** Number of failures without details because detailed failure threshold was exceeded. */
2138
+ undetailedFailures?: number;
2209
2139
  }
2210
- export declare enum SourceType {
2211
- UNKNOWN_SOURCE_TYPE = "UNKNOWN_SOURCE_TYPE",
2212
- WIX_APP = "WIX_APP",
2213
- EXTERNAL = "EXTERNAL",
2214
- ADMIN = "ADMIN",
2215
- OTHER = "OTHER"
2140
+ export interface GetRefundabilityStatusRequest {
2141
+ /** Order ID. */
2142
+ ecomOrderId?: string;
2216
2143
  }
2217
- export interface LineItemMetaData {
2218
- metadata?: Record<string, string>;
2144
+ export interface GetRefundabilityStatusResponse {
2145
+ /** Refundability details. */
2146
+ refundabilities?: Refundability[];
2147
+ /** Whether the order supports refunding per item. */
2148
+ refundablePerItem?: boolean;
2219
2149
  }
2220
- export interface Locale {
2221
- /** ISO 639 alpha-2 or alpha-3 language code, or a language subtag */
2222
- language?: string;
2223
- /** An ISO 3166 alpha-2 country code or a UN M.49 numeric-3 area code. */
2224
- country?: string | null;
2225
- invariant?: string | null;
2150
+ export interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
2151
+ /** Reason why payment is not refundable. */
2152
+ nonRefundableReason?: NonRefundableReason;
2153
+ /** Reason why payment is only refundable manually. */
2154
+ manuallyRefundableReason?: ManuallyRefundableReason;
2155
+ /** Payment ID. */
2156
+ paymentId?: string;
2157
+ /** Payment refundability status. */
2158
+ refundabilityStatus?: RefundableStatus;
2159
+ /** Link to payment provider dashboard. */
2160
+ providerLink?: string | null;
2226
2161
  }
2227
- export interface TotalPrice {
2228
- /** the subtotal of the line items without the tax reduction */
2229
- subtotal?: BigDecimalWrapper;
2230
- /** the total price taking into account the itemized fees and the taxes */
2231
- total?: BigDecimalWrapper;
2232
- fees?: ItemizedFee[];
2233
- discountAmount?: BigDecimalWrapper;
2234
- taxedAmount?: BigDecimalWrapper;
2162
+ /** @oneof */
2163
+ export interface RefundabilityAdditionalRefundabilityInfoOneOf {
2164
+ /** Reason why payment is not refundable. */
2165
+ nonRefundableReason?: NonRefundableReason;
2166
+ /** Reason why payment is only refundable manually. */
2167
+ manuallyRefundableReason?: ManuallyRefundableReason;
2235
2168
  }
2236
- export interface ItemizedFee {
2237
- name?: string;
2238
- price?: BigDecimalWrapper;
2169
+ export declare enum RefundableStatus {
2170
+ NOT_REFUNDABLE = "NOT_REFUNDABLE",
2171
+ MANUAL = "MANUAL",
2172
+ REFUNDABLE = "REFUNDABLE"
2239
2173
  }
2240
- export interface Discount extends DiscountOneDiscountTypeOneOf {
2241
- /** Discount as percentage value. */
2242
- percentage?: BigDecimalWrapper;
2174
+ export declare enum NonRefundableReason {
2175
+ NONE = "NONE",
2176
+ ALREADY_REFUNDED = "ALREADY_REFUNDED",
2177
+ PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
2178
+ INTERNAL_ERROR = "INTERNAL_ERROR",
2179
+ NOT_PAID = "NOT_PAID",
2180
+ ACCESS_DENIED = "ACCESS_DENIED",
2181
+ ZERO_PRICE = "ZERO_PRICE",
2182
+ DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
2183
+ PENDING_REFUND = "PENDING_REFUND",
2184
+ FORBIDDEN = "FORBIDDEN",
2185
+ TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND"
2243
2186
  }
2244
- /** @oneof */
2245
- export interface DiscountOneDiscountTypeOneOf {
2246
- /** Discount as percentage value. */
2247
- percentage?: BigDecimalWrapper;
2187
+ export declare enum ManuallyRefundableReason {
2188
+ EXPIRED = "EXPIRED",
2189
+ NOT_SUPPORTED = "NOT_SUPPORTED",
2190
+ OFFLINE = "OFFLINE"
2248
2191
  }
2249
- export interface CalculatedTaxes {
2250
- /** consider calculated or not - cannot enforce set */
2251
- taxes?: CalculatedTax[];
2192
+ export interface V1CreatePaymentGatewayOrderRequest {
2193
+ /** Ecom order ID. */
2194
+ ecomOrderId?: string;
2195
+ /** Information about the user who initiated the payment. */
2196
+ chargedBy?: ChargedBy;
2252
2197
  }
2253
- export interface CalculatedTax {
2254
- name?: string;
2255
- rate?: BigDecimalWrapper;
2256
- /** the costs on which the taxes are applied */
2257
- taxable?: BigDecimalWrapper;
2258
- /** the taxes as a result of the */
2259
- taxed?: BigDecimalWrapper;
2260
- code?: string | null;
2198
+ export interface ChargedBy {
2199
+ /** ID - id of the user who initiated the payment */
2200
+ id?: string;
2201
+ /** Full name - name of the user who initiated the payment */
2202
+ fullName?: string | null;
2261
2203
  }
2262
- export interface Payments {
2263
- payments?: Payment[];
2204
+ export interface V1CreatePaymentGatewayOrderResponse {
2205
+ /** ID of the order created in the payment gateway */
2206
+ paymentGatewayOrderId?: string;
2264
2207
  }
2265
- export interface Payment {
2266
- /** document */
2267
- id?: string;
2268
- type?: string;
2269
- amount?: BigDecimalWrapper;
2270
- date?: Date;
2208
+ export interface ChargeMembershipsRequest {
2209
+ /** Order ID. */
2210
+ ecomOrderId?: string;
2271
2211
  /**
2272
- * The orderId of the order in cashier associated with the payment.
2273
- * This field is populated for external payments that are charged by invoices via AddPayment endpoint.
2212
+ * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
2213
+ * but a user which is using the membership on behalf of the a member
2274
2214
  */
2275
- orderId?: string | null;
2215
+ memberId?: string;
2216
+ /** List of items to be paid by memberships */
2217
+ membershipCharges?: MembershipChargeItem[];
2218
+ }
2219
+ export interface MembershipChargeItem {
2220
+ /** The id of used membership */
2221
+ membershipId?: string;
2222
+ /** ID of the application providing this payment option */
2223
+ appId?: string;
2224
+ /** The name of used membership */
2225
+ membershipName?: MembershipName;
2226
+ /** Additional data about this membership */
2227
+ membershipAdditionalData?: Record<string, any> | null;
2228
+ /** Catalog and item reference info. */
2229
+ catalogReference?: CatalogReference;
2230
+ /** Properties of the service. When relevant, contains information such as date and number of participants. */
2231
+ serviceProperties?: ServiceProperties;
2276
2232
  /**
2277
- * The transactionId corresponding to the orderId of the payment which are returned by cashier.
2278
- * This field is populated for external payments that are charged by invoices via AddPayment endpoint as well.
2233
+ * Usually would be the same as catalogReference.catalogItemId
2234
+ * For cases when these are not the same, this field would return the actual id of the item in the catalog
2235
+ * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
2279
2236
  */
2280
- transactionId?: string | null;
2281
- }
2282
- export interface MetaData {
2283
- notes?: string | null;
2284
- legalTerms?: string | null;
2285
- sourceUrl?: string | null;
2286
- sourceProperties?: Record<string, string>;
2287
- source?: string | null;
2288
- sourceRefId?: string | null;
2289
- /** Optional indicator whether to allow editing of the invoice by other applications other than the source. Default is true. */
2290
- allowEditByOthers?: boolean | null;
2291
- }
2292
- export interface InvoiceDynamicPriceTotals {
2293
- paidAmount?: BigDecimalWrapper;
2294
- balance?: BigDecimalWrapper;
2237
+ rootCatalogItemId?: string | null;
2238
+ /** line item id of Checkout/Order line item */
2239
+ lineItemId?: string;
2295
2240
  }
2296
- /**
2297
- * A custom field value is used to add additional data to a financial document or to a financial document template.
2298
- * The custom field value may be based on a custom field definition.
2299
- */
2300
- export interface CustomFieldValue {
2241
+ export interface ServiceProperties {
2301
2242
  /**
2302
- * The unique id of the custom field value
2303
- * @readonly
2243
+ * Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
2244
+ * For example, the start time of a class.
2304
2245
  */
2305
- id?: string | null;
2306
- /** The display name of the custom field value */
2307
- displayName?: string;
2308
- /** The optional namespace of the custom field value. This field may be used to indicate intended usage or source. */
2309
- namespace?: string | null;
2310
- /** The group of the custom field indicates its intended placement in the financial document */
2311
- group?: CustomFieldGroup;
2312
- /** The value of the custom field */
2313
- value?: Value;
2314
- /** The optional key of the custom field definition on which the custom field value is based */
2315
- originCustomFieldKey?: string | null;
2316
- }
2317
- export declare enum CustomFieldGroup {
2318
- UNKNOWN_CUSTOM_FIELD_GROUP = "UNKNOWN_CUSTOM_FIELD_GROUP",
2319
- BUSINESS_DETAILS = "BUSINESS_DETAILS",
2320
- CUSTOMER_DETAILS = "CUSTOMER_DETAILS",
2321
- DOCUMENT = "DOCUMENT",
2322
- FOOTER = "FOOTER",
2323
- OTHER = "OTHER"
2246
+ scheduledDate?: Date;
2247
+ /** The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room. */
2248
+ numberOfParticipants?: number | null;
2324
2249
  }
2325
- export interface Value {
2326
- value?: string;
2327
- valueType?: ValueType;
2250
+ export interface ChargeMembershipsResponse {
2328
2251
  }
2329
- export declare enum ValueType {
2330
- UNKNOWN_VALUE_TYPE = "UNKNOWN_VALUE_TYPE",
2331
- STRING = "STRING",
2332
- DATE = "DATE",
2333
- BOOLEAN = "BOOLEAN",
2334
- NUMBER = "NUMBER"
2252
+ export interface TriggerRefundRequest {
2253
+ /** The order this refund related to */
2254
+ ecomOrderId?: string;
2255
+ /** Refund operations information */
2256
+ payments?: PaymentRefund[];
2257
+ /** Business model of a refund */
2258
+ details?: RefundDetails;
2259
+ /** Side effect details related to refund */
2260
+ sideEffects?: RefundSideEffects;
2335
2261
  }
2336
- export interface Deposit {
2337
- /** The flat amount of the deposit. The flat amount of the deposit must be less than the invoice total. */
2338
- flatAmount?: string;
2262
+ export interface PaymentRefund {
2263
+ /** Specific payment within the order to refund */
2264
+ paymentId?: string;
2265
+ /** Refund amount. Not relevant for membership refunds. */
2266
+ amount?: Price;
2339
2267
  /**
2340
- * The read-only percentage value of the deposit.
2341
- * It is computed according to the flat_amount and the invoice total and is rounded to 2 digits precision.
2342
- * @readonly
2268
+ * Whether refund is made externally and manually (on the payment provider's side)
2269
+ * When false (default), the payment gateway will be called in order to make an actual refund, and then the payment will be marked as refunded.
2270
+ * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
2343
2271
  */
2344
- percentage?: string;
2345
- /** The type of the deposit. The default is FLAT. */
2346
- type?: DepositType;
2272
+ externalRefund?: boolean;
2347
2273
  }
2348
- export declare enum DepositType {
2349
- UNKNOWN = "UNKNOWN",
2350
- FLAT = "FLAT",
2351
- PERCENTAGE = "PERCENTAGE"
2274
+ export interface RefundSideEffects {
2275
+ /** Inventory restock details as part of this refund. */
2276
+ restockInfo?: RestockInfo;
2277
+ /** Whether to send a refund confirmation email to the customer. */
2278
+ sendOrderRefundedEmail?: boolean;
2279
+ /** Custom message added to the refund confirmation email. */
2280
+ customMessage?: string | null;
2352
2281
  }
2353
- /**
2354
- * InvoiceStatus allowed transitions based on current status:
2355
- * Draft -> Deleted, Paid, Partially Paid, Sent
2356
- * Sent -> Draft, Deleted, Void, Paid, Partially Paid, Processing, (Overdue)
2357
- * Processing -> PartiallyPaid, Paid, Sent
2358
- * Paid -> Void
2359
- * PartiallyPaid -> Void, (PartialAndOverdue)
2360
- * Void -> Deleted
2361
- * Deleted
2362
- */
2363
- export declare enum InvoiceStatus {
2364
- Draft = "Draft",
2365
- Sent = "Sent",
2366
- Processing = "Processing",
2367
- Paid = "Paid",
2368
- Overdue = "Overdue",
2369
- Void = "Void",
2370
- Deleted = "Deleted",
2371
- PartiallyPaid = "PartiallyPaid",
2372
- PartialAndOverdue = "PartialAndOverdue"
2282
+ export interface RestockInfo {
2283
+ /** Restock type. */
2284
+ type?: RestockType;
2285
+ /** Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`. */
2286
+ items?: V1RestockItem[];
2373
2287
  }
2374
- export interface PreparePaymentCollectionRequest {
2375
- /** Ecom order ID. */
2376
- ecomOrderId?: string;
2377
- /** Amount to collect */
2378
- amount?: Price;
2379
- /**
2380
- * Optional parameter. When present, payment collection will be performed using given payment gateway order.
2381
- * Existing payment gateway order will be updated with a new amount.
2382
- * When parameter is absent, new payment gateway order will be created and used for payment collection.
2383
- */
2384
- paymentGatewayOrderId?: string | null;
2288
+ export declare enum RestockType {
2289
+ NO_ITEMS = "NO_ITEMS",
2290
+ ALL_ITEMS = "ALL_ITEMS",
2291
+ SOME_ITEMS = "SOME_ITEMS"
2385
2292
  }
2386
- export interface PreparePaymentCollectionResponse {
2387
- /** Payment gateway order id which is associated with given payment */
2388
- paymentGatewayOrderId?: string;
2293
+ export interface V1RestockItem {
2294
+ /** ID of the line item being restocked. */
2295
+ lineItemId?: string;
2296
+ /** Line item quantity being restocked. */
2297
+ quantity?: number;
2389
2298
  }
2390
- export interface GetPaymentCollectabilityStatusRequest {
2391
- /** Ecom order ID. */
2299
+ export interface TriggerRefundResponse {
2300
+ /** All order's transactions after the refunds were added */
2301
+ orderTransactions?: OrderTransactions;
2302
+ /** Created refund ID */
2303
+ refundId?: string | null;
2304
+ /** Payment ID's that the refund execution had failed for */
2305
+ failedPaymentIds?: ItemMetadata[];
2306
+ }
2307
+ /** Triggered when a refund is created. */
2308
+ export interface RefundCreated {
2309
+ /** Updated order transactions. */
2310
+ orderTransactions?: OrderTransactions;
2311
+ /** ID of the created refund. */
2312
+ refundId?: string;
2313
+ /** Inventory restock details as part of this refund.. */
2314
+ restockInfo?: RestockInfo;
2315
+ /** Whether to send a refund confirmation email to the customer. */
2316
+ sendOrderRefundedEmail?: boolean;
2317
+ /** Custom message added to the refund confirmation email. */
2318
+ customMessage?: string | null;
2319
+ /** Refunded line items and quantities that are part of the created refund. */
2320
+ refundItems?: RefundItem[];
2321
+ }
2322
+ export interface CalculateRefundRequest {
2323
+ /** Order ID */
2392
2324
  ecomOrderId?: string;
2325
+ /** Refunded line items and quantity */
2326
+ refundItems?: CalculateRefundItemRequest[];
2327
+ /** Should include shipping in refund calculation */
2328
+ refundShipping?: boolean;
2393
2329
  }
2394
- export interface GetPaymentCollectabilityStatusResponse {
2395
- /** Payment collectability status */
2396
- status?: PaymentCollectabilityStatus;
2397
- /** Collectable order amount */
2398
- amount?: Price;
2330
+ export interface CalculateRefundItemRequest {
2331
+ /** ID of the line item being refunded */
2332
+ id?: string;
2333
+ /** How much of that line item is being refunded */
2334
+ quantity?: number;
2399
2335
  }
2400
- export declare enum PaymentCollectabilityStatus {
2401
- UNKNOWN = "UNKNOWN",
2402
- COLLECTABLE = "COLLECTABLE",
2403
- NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
2404
- NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
2405
- NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD"
2336
+ export interface CalculateRefundResponse {
2337
+ /** Total refundable amount */
2338
+ total?: Price;
2339
+ /** Tax cost of the order */
2340
+ tax?: Price;
2341
+ /** Discount given for this order */
2342
+ discount?: Price;
2343
+ /** Total cost of the order (without tax) */
2344
+ subtotal?: Price;
2345
+ /** Total shipping cost for order */
2346
+ shipping?: Price;
2347
+ /** Previous refund given on that order */
2348
+ previouslyRefundedAmount?: Price;
2349
+ /** The refundable items of that order */
2350
+ items?: CalculateRefundItemResponse[];
2406
2351
  }
2407
- export interface RecordManuallyCollectedPaymentRequest {
2408
- /** Order ID. */
2352
+ export interface CalculateRefundItemResponse {
2353
+ /** Line item ID */
2354
+ id?: string;
2355
+ /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
2356
+ price?: Price;
2357
+ }
2358
+ export interface DiffmatokyPayload {
2359
+ left?: string;
2360
+ right?: string;
2361
+ compareChannel?: string;
2362
+ entityId?: string;
2363
+ errorInformation?: ErrorInformation;
2364
+ tags?: string[];
2365
+ }
2366
+ export interface ErrorInformation {
2367
+ stackTrace?: string;
2368
+ }
2369
+ export interface ContinueSideEffectsFlowInLegacyData {
2370
+ storeId?: string;
2409
2371
  orderId?: string;
2410
- /** Amount to be recorded as approved manual payment for given order */
2411
- amount?: Price;
2372
+ ordersExperiments?: OrdersExperiments;
2412
2373
  }
2413
- export interface RecordManuallyCollectedPaymentResponse {
2374
+ export interface OrdersExperiments {
2375
+ epCommitTax?: boolean;
2376
+ moveMerchantEmailToEp?: boolean;
2377
+ moveBuyerOrderConfirmationEmailToEp?: boolean;
2378
+ producedByEpBridge?: boolean;
2379
+ enableRewrittenSideEffects?: boolean;
2414
2380
  }
2415
- export interface V1MarkOrderAsPaidRequest {
2416
- /** Ecom order ID. */
2417
- ecomOrderId?: string;
2381
+ export interface IndexingMessage {
2382
+ id?: string;
2383
+ opType?: number;
2384
+ requiredVersions?: string[];
2418
2385
  }
2419
- export interface V1MarkOrderAsPaidResponse {
2420
- /** Updated order. */
2421
- order?: Order;
2386
+ export interface GetOrderRequest {
2387
+ /** ID of the order to retrieve. */
2388
+ id: string;
2422
2389
  }
2423
- /** Triggered when the payment status of an order is updated */
2424
- export interface PaymentStatusUpdated {
2425
- /** The order that was updated */
2390
+ export interface GetOrderResponse {
2391
+ /** The requested order. */
2426
2392
  order?: Order;
2427
- /** The previous status (before the update) */
2428
- previousPaymentStatus?: PaymentStatus;
2429
2393
  }
2430
- export interface V1BulkMarkOrdersAsPaidRequest {
2431
- /** IDs of orders to mark as paid. */
2432
- ecomOrderIds?: string[];
2394
+ export interface ListOrdersResponse {
2395
+ /** The requested order. */
2396
+ orders?: Order[];
2397
+ /** Details on the paged set of results returned. */
2398
+ pagingMetadata?: CursorPagingMetadata;
2433
2399
  }
2434
- export interface V1BulkMarkOrdersAsPaidResponse {
2435
- /**
2436
- * Items updated by the bulk action.
2437
- * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
2438
- */
2439
- results?: BulkOrderResult[];
2440
- /** Bulk action metadata. */
2441
- bulkActionMetadata?: BulkActionMetadata;
2400
+ export interface InternalQueryOrdersResponse {
2401
+ /** List of orders. */
2402
+ orders?: Order[];
2403
+ /** Details on the paged set of results returned. */
2404
+ metadata?: PlatformPagingMetadata;
2442
2405
  }
2443
- export interface BulkOrderResult {
2444
- /** Item metadata. */
2445
- itemMetadata?: ItemMetadata;
2446
- /** Updated item. Optional - returned only if requested with `return_full_entity` set to `true`. */
2447
- item?: Order;
2406
+ export interface QueryOrderRequest {
2407
+ /** Query options. */
2408
+ query?: PlatformQuery;
2448
2409
  }
2449
- export interface ItemMetadata {
2450
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
2451
- id?: string | null;
2452
- /** Index of the item within the request array. Allows for correlation between request and response items. */
2453
- originalIndex?: number;
2454
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
2455
- success?: boolean;
2456
- /** Details about the error in case of failure. */
2457
- error?: ApplicationError;
2410
+ export interface QueryOrderResponse {
2411
+ /** List of orders. */
2412
+ orders?: Order[];
2413
+ /** Details on the paged set of results returned. */
2414
+ metadata?: PlatformPagingMetadata;
2458
2415
  }
2459
- export interface ApplicationError {
2460
- /** Error code. */
2461
- code?: string;
2462
- /** Description of the error. */
2463
- description?: string;
2464
- /** Data related to the error. */
2465
- data?: Record<string, any> | null;
2416
+ export interface SearchOrdersRequest {
2417
+ /** Search options. */
2418
+ search?: CursorSearch;
2466
2419
  }
2467
- export interface BulkActionMetadata {
2468
- /** Number of items that were successfully processed. */
2469
- totalSuccesses?: number;
2470
- /** Number of items that couldn't be processed. */
2471
- totalFailures?: number;
2472
- /** Number of failures without details because detailed failure threshold was exceeded. */
2473
- undetailedFailures?: number;
2420
+ export interface CursorSearch extends CursorSearchPagingMethodOneOf {
2421
+ /** Cursor pointing to page of results. `cursorPaging.cursor` cannot be used with 'filter' or 'sort'. */
2422
+ cursorPaging?: CursorPaging;
2423
+ /**
2424
+ * Filter object.
2425
+ *
2426
+ * For example, the following `filter` object will only return orders with payment statuses of paid and/or partially paid:
2427
+ * `"filter": {"paymentStatus": {"$in": ["PAID", "PARTIALLY_PAID"]}}`
2428
+ *
2429
+ * Learn more about the filter format [here](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
2430
+ */
2431
+ filter?: Record<string, any> | null;
2432
+ /**
2433
+ * Array of sort objects that specify the order in which results should be sorted.
2434
+ *
2435
+ * For example, the following `sort` array will sort by `createdDate` in descending order:
2436
+ * `"sort": [{"fieldName": "createdDate", "order":"DESC"}]`.
2437
+ *
2438
+ * Learn more about the sort format [here](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
2439
+ */
2440
+ sort?: Sorting[];
2474
2441
  }
2475
- export interface GetRefundabilityStatusRequest {
2476
- /** Order ID. */
2477
- ecomOrderId?: string;
2442
+ /** @oneof */
2443
+ export interface CursorSearchPagingMethodOneOf {
2444
+ /** Cursor pointing to page of results. `cursorPaging.cursor` cannot be used with 'filter' or 'sort'. */
2445
+ cursorPaging?: CursorPaging;
2478
2446
  }
2479
- export interface GetRefundabilityStatusResponse {
2480
- /** Refundability details. */
2481
- refundabilities?: Refundability[];
2482
- /** Whether the order supports refunding per item. */
2483
- refundablePerItem?: boolean;
2447
+ export interface SearchOrdersResponse {
2448
+ /** List of orders. */
2449
+ orders?: Order[];
2450
+ /** Details on the paged set of results returned. */
2451
+ metadata?: CursorPagingMetadata;
2484
2452
  }
2485
- export interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
2486
- /** Reason why payment is not refundable. */
2487
- nonRefundableReason?: NonRefundableReason;
2488
- /** Reason why payment is only refundable manually. */
2489
- manuallyRefundableReason?: ManuallyRefundableReason;
2490
- /** Payment ID. */
2491
- paymentId?: string;
2492
- /** Payment refundability status. */
2493
- refundabilityStatus?: RefundableStatus;
2494
- /** Link to payment provider dashboard. */
2495
- providerLink?: string | null;
2496
- }
2497
- /** @oneof */
2498
- export interface RefundabilityAdditionalRefundabilityInfoOneOf {
2499
- /** Reason why payment is not refundable. */
2500
- nonRefundableReason?: NonRefundableReason;
2501
- /** Reason why payment is only refundable manually. */
2502
- manuallyRefundableReason?: ManuallyRefundableReason;
2453
+ export interface CreateOrderRequest {
2454
+ /** Order info. */
2455
+ order: Order;
2503
2456
  }
2504
- export declare enum RefundableStatus {
2505
- NOT_REFUNDABLE = "NOT_REFUNDABLE",
2506
- MANUAL = "MANUAL",
2507
- REFUNDABLE = "REFUNDABLE"
2457
+ export interface CreateOrderResponse {
2458
+ /** Newly created order. */
2459
+ order?: Order;
2508
2460
  }
2509
- export declare enum NonRefundableReason {
2510
- NONE = "NONE",
2511
- ALREADY_REFUNDED = "ALREADY_REFUNDED",
2512
- PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
2513
- INTERNAL_ERROR = "INTERNAL_ERROR",
2514
- NOT_PAID = "NOT_PAID",
2515
- ACCESS_DENIED = "ACCESS_DENIED",
2516
- ZERO_PRICE = "ZERO_PRICE",
2517
- DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
2518
- PENDING_REFUND = "PENDING_REFUND",
2519
- FORBIDDEN = "FORBIDDEN",
2520
- TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND"
2461
+ export interface UpdateOrderRequest {
2462
+ /** Order to be updated. */
2463
+ order: Order;
2521
2464
  }
2522
- export declare enum ManuallyRefundableReason {
2523
- EXPIRED = "EXPIRED",
2524
- NOT_SUPPORTED = "NOT_SUPPORTED",
2525
- OFFLINE = "OFFLINE"
2465
+ export interface UpdateOrderResponse {
2466
+ /** Newly created order. */
2467
+ order?: Order;
2526
2468
  }
2527
- export interface V1CreatePaymentGatewayOrderRequest {
2528
- /** Ecom order ID. */
2529
- ecomOrderId?: string;
2530
- /** Information about the user who initiated the payment. */
2531
- chargedBy?: ChargedBy;
2469
+ export interface BulkUpdateOrderRequest {
2470
+ /** Orders to be updated. */
2471
+ orders: MaskedOrder[];
2472
+ /** Set to `true` if you wish to receive back the updated orders in the response */
2473
+ returnEntity?: boolean;
2532
2474
  }
2533
- export interface ChargedBy {
2534
- /** ID - id of the user who initiated the payment */
2535
- id?: string;
2536
- /** Full name - name of the user who initiated the payment */
2537
- fullName?: string | null;
2475
+ export interface MaskedOrder {
2476
+ /** Order to be updated. */
2477
+ order?: Order;
2538
2478
  }
2539
- export interface V1CreatePaymentGatewayOrderResponse {
2540
- /** ID of the order created in the payment gateway */
2541
- paymentGatewayOrderId?: string;
2479
+ export interface BulkUpdateOrderResponse {
2480
+ results?: BulkOrderResult[];
2481
+ bulkActionMetadata?: BulkActionMetadata;
2542
2482
  }
2543
- export interface ChargeMembershipsRequest {
2544
- /** Order ID. */
2545
- ecomOrderId?: string;
2483
+ export interface CommitDeltasRequest {
2484
+ /** Order id to be updated */
2485
+ id?: string;
2546
2486
  /**
2547
- * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
2548
- * but a user which is using the membership on behalf of the a member
2487
+ * Draft order Id representing this change.
2488
+ * Use this ID to get this specific draft content. call .../v1/draft-orders/{draft_order_id}/get
2549
2489
  */
2550
- memberId?: string;
2551
- /** List of items to be paid by memberships */
2552
- membershipCharges?: MembershipChargeItem[];
2490
+ draftOrderId?: string;
2491
+ /** Draft order changes to be applied */
2492
+ changes?: DraftOrderDiffs;
2493
+ /** Side-effects to happen after order is updated */
2494
+ commitSettings?: DraftOrderCommitSettings;
2495
+ /** Reason for edit, given by user (optional). */
2496
+ reason?: string | null;
2553
2497
  }
2554
- export interface MembershipChargeItem {
2555
- /** The id of used membership */
2556
- membershipId?: string;
2557
- /** ID of the application providing this payment option */
2558
- appId?: string;
2559
- /** The name of used membership */
2560
- membershipName?: MembershipName;
2561
- /** Additional data about this membership */
2562
- membershipAdditionalData?: Record<string, any> | null;
2563
- /** Catalog and item reference info. */
2564
- catalogReference?: CatalogReference;
2565
- /** Properties of the service. When relevant, contains information such as date and number of participants. */
2566
- serviceProperties?: ServiceProperties;
2498
+ export interface DraftOrderDiffs extends DraftOrderDiffsShippingUpdateInfoOneOf {
2499
+ /** Shipping info and selected shipping option details. */
2500
+ changedShippingInfo?: ShippingInformation;
2501
+ /** Remove existing shipping info. */
2502
+ shippingInfoRemoved?: boolean;
2503
+ /** Added/updated/removed order line items. */
2504
+ lineItems?: LineItemDelta[];
2567
2505
  /**
2568
- * Usually would be the same as catalogReference.catalogItemId
2569
- * For cases when these are not the same, this field would return the actual id of the item in the catalog
2570
- * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
2506
+ * Added/updated/removed discounts.
2507
+ * todo: set (.wix.api.maxSize). need to find it. existing : merchant can have 100 + 1 coupon + ? due to automatic discounts
2571
2508
  */
2572
- rootCatalogItemId?: string | null;
2573
- /** line item id of Checkout/Order line item */
2574
- lineItemId?: string;
2575
- }
2576
- export interface ServiceProperties {
2509
+ appliedDiscounts?: AppliedDiscountDelta[];
2510
+ /** Added/updated/removed additional fee. */
2511
+ additionalFees?: AdditionalFeeDelta[];
2512
+ /** Updated Tax summary. overwrites existing tax summary. */
2513
+ taxSummary?: TaxSummary;
2577
2514
  /**
2578
- * Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
2579
- * For example, the start time of a class.
2515
+ * Updated order price summary. overwrites existing price summary.
2516
+ * balance will be updated automatically.
2580
2517
  */
2581
- scheduledDate?: Date;
2582
- /** The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room. */
2583
- numberOfParticipants?: number | null;
2518
+ priceSummary?: PriceSummary;
2584
2519
  }
2585
- export interface ChargeMembershipsResponse {
2520
+ /** @oneof */
2521
+ export interface DraftOrderDiffsShippingUpdateInfoOneOf {
2522
+ /** Shipping info and selected shipping option details. */
2523
+ changedShippingInfo?: ShippingInformation;
2524
+ /** Remove existing shipping info. */
2525
+ shippingInfoRemoved?: boolean;
2586
2526
  }
2587
- export interface TriggerRefundRequest {
2588
- /** The order this refund related to */
2589
- ecomOrderId?: string;
2590
- /** Refund operations information */
2591
- payments?: PaymentRefund[];
2592
- /** Business model of a refund */
2593
- details?: RefundDetails;
2594
- /** Side effect details related to refund */
2595
- sideEffects?: RefundSideEffects;
2527
+ export interface LineItemDelta extends LineItemDeltaDeltaOneOf {
2528
+ /** The line item was added. */
2529
+ lineItemAdded?: boolean;
2530
+ /** The line item was modified. */
2531
+ changedDetails?: ItemChangedDetails;
2532
+ /** The line item was added. */
2533
+ lineItemRemoved?: boolean;
2534
+ /** Line item ID. */
2535
+ lineItemId?: string;
2536
+ lineItem?: OrderLineItemChangedDetails;
2596
2537
  }
2597
- export interface PaymentRefund {
2598
- /** Specific payment within the order to refund */
2599
- paymentId?: string;
2600
- /** Refund amount. Not relevant for membership refunds. */
2601
- amount?: Price;
2538
+ /** @oneof */
2539
+ export interface LineItemDeltaDeltaOneOf {
2540
+ /** The line item was added. */
2541
+ lineItemAdded?: boolean;
2542
+ /** The line item was modified. */
2543
+ changedDetails?: ItemChangedDetails;
2544
+ /** The line item was added. */
2545
+ lineItemRemoved?: boolean;
2546
+ }
2547
+ export interface OrderLineItemChangedDetails {
2602
2548
  /**
2603
- * Whether refund is made externally and manually (on the payment provider's side)
2604
- * When false (default), the payment gateway will be called in order to make an actual refund, and then the payment will be marked as refunded.
2605
- * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
2549
+ * Item name.
2550
+ * + Stores - `product.name`
2551
+ * + Bookings - `service.info.name`
2552
+ * + Events - `ticket.name`
2606
2553
  */
2607
- externalRefund?: boolean;
2608
- }
2609
- export interface RefundSideEffects {
2610
- /** Inventory restock details as part of this refund. */
2611
- restockInfo?: RestockInfo;
2612
- /** Whether to send a refund confirmation email to the customer. */
2613
- sendOrderRefundedEmail?: boolean;
2614
- /** Custom message added to the refund confirmation email. */
2615
- customMessage?: string | null;
2554
+ productName?: ProductName;
2555
+ /**
2556
+ * References to the line item's origin catalog.
2557
+ * This field is empty in the case of a custom line item.
2558
+ */
2559
+ catalogReference?: CatalogReference;
2560
+ /** Line item quantity. */
2561
+ quantity?: number;
2562
+ /** Total discount for this line item's entire quantity. */
2563
+ totalDiscount?: Price;
2564
+ /** Line item description lines. Used for display purposes for the cart, checkout and order. */
2565
+ descriptionLines?: DescriptionLine[];
2566
+ /** Line item image. */
2567
+ image?: Image;
2568
+ /** Physical properties of the item. When relevant, contains information such as SKU and item weight. */
2569
+ physicalProperties?: PhysicalProperties;
2570
+ /** Item type. Either a preset type or custom. */
2571
+ itemType?: ItemType;
2572
+ /**
2573
+ * Fulfiller ID. Field is empty when the line item is self-fulfilled.
2574
+ * To get fulfillment information, pass this order's ID to [List Fulfillments For Single Order](https://bo.wix.com/wix-docs/rest/ecommerce/order-fulfillments/list-fulfillments-for-single-order).
2575
+ */
2576
+ fulfillerId?: string | null;
2577
+ /** Line item price after line item discounts for display purposes. */
2578
+ price?: Price;
2579
+ /** Line item price before line item discounts for display purposes. Defaults to `price` when not provided. */
2580
+ priceBeforeDiscounts?: Price;
2581
+ /** Total price after all discounts and tax. */
2582
+ totalPriceAfterTax?: Price;
2583
+ /**
2584
+ * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
2585
+ * + `FULL_PAYMENT_OFFLINE` - The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
2586
+ * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
2587
+ */
2588
+ paymentOption?: DeltaPaymentOptionType;
2589
+ /** Tax details for this line item. */
2590
+ taxDetails?: ItemTaxFullDetails;
2591
+ /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
2592
+ priceDescription?: PriceDescription;
2593
+ /** Total price after all discounts excluding tax. */
2594
+ totalPriceBeforeTax?: Price;
2616
2595
  }
2617
- export interface RestockInfo {
2618
- /** Restock type. */
2619
- type?: RestockType;
2620
- /** Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`. */
2621
- items?: V1RestockItem[];
2596
+ /** Type of selected payment option for catalog item */
2597
+ export declare enum DeltaPaymentOptionType {
2598
+ /** irrelevant */
2599
+ UNKNOWN_PAYMENT_OPTION = "UNKNOWN_PAYMENT_OPTION",
2600
+ /** The entire payment for given item will happen after the checkout. */
2601
+ FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
2602
+ /**
2603
+ * Payment for this item can only be done using a membership and must be manually redeemed in the dashboard by the site owner.
2604
+ * Note: when this option is used, price will be 0.
2605
+ */
2606
+ MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
2622
2607
  }
2623
- export declare enum RestockType {
2624
- NO_ITEMS = "NO_ITEMS",
2625
- ALL_ITEMS = "ALL_ITEMS",
2626
- SOME_ITEMS = "SOME_ITEMS"
2608
+ export interface ItemChangedDetails {
2609
+ /** The quantity before the change. */
2610
+ quantityBeforeChange?: number | null;
2611
+ /** The price before the change. */
2612
+ priceBeforeChange?: Price;
2613
+ /** The price description before the change */
2614
+ priceDescriptionBeforeChange?: PriceDescription;
2627
2615
  }
2628
- export interface V1RestockItem {
2629
- /** ID of the line item being restocked. */
2630
- lineItemId?: string;
2631
- /** Line item quantity being restocked. */
2632
- quantity?: number;
2633
- }
2634
- export interface TriggerRefundResponse {
2635
- /** All order's transactions after the refunds were added */
2636
- orderTransactions?: OrderTransactions;
2637
- /** Created refund ID */
2638
- refundId?: string | null;
2639
- /** Payment ID's that the refund execution had failed for */
2640
- failedPaymentIds?: ItemMetadata[];
2641
- }
2642
- /** Triggered when a refund is created. */
2643
- export interface RefundCreated {
2644
- /** Updated order transactions. */
2645
- orderTransactions?: OrderTransactions;
2646
- /** ID of the created refund. */
2647
- refundId?: string;
2648
- /** Inventory restock details as part of this refund.. */
2649
- restockInfo?: RestockInfo;
2650
- /** Whether to send a refund confirmation email to the customer. */
2651
- sendOrderRefundedEmail?: boolean;
2652
- /** Custom message added to the refund confirmation email. */
2653
- customMessage?: string | null;
2654
- /** Refunded line items and quantities that are part of the created refund. */
2655
- refundItems?: RefundItem[];
2656
- }
2657
- export interface CalculateRefundRequest {
2658
- /** Order ID */
2659
- ecomOrderId?: string;
2660
- /** Refunded line items and quantity */
2661
- refundItems?: CalculateRefundItemRequest[];
2662
- /** Should include shipping in refund calculation */
2663
- refundShipping?: boolean;
2664
- }
2665
- export interface CalculateRefundItemRequest {
2666
- /** ID of the line item being refunded */
2667
- id?: string;
2668
- /** How much of that line item is being refunded */
2669
- quantity?: number;
2670
- }
2671
- export interface CalculateRefundResponse {
2672
- /** Total refundable amount */
2673
- total?: Price;
2674
- /** Tax cost of the order */
2675
- tax?: Price;
2676
- /** Discount given for this order */
2677
- discount?: Price;
2678
- /** Total cost of the order (without tax) */
2679
- subtotal?: Price;
2680
- /** Total shipping cost for order */
2681
- shipping?: Price;
2682
- /** Previous refund given on that order */
2683
- previouslyRefundedAmount?: Price;
2684
- /** The refundable items of that order */
2685
- items?: CalculateRefundItemResponse[];
2686
- }
2687
- export interface CalculateRefundItemResponse {
2688
- /** Line item ID */
2689
- id?: string;
2690
- /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
2691
- price?: Price;
2692
- }
2693
- export interface DiffmatokyPayload {
2694
- left?: string;
2695
- right?: string;
2696
- compareChannel?: string;
2697
- entityId?: string;
2698
- errorInformation?: ErrorInformation;
2699
- tags?: string[];
2700
- }
2701
- export interface ErrorInformation {
2702
- stackTrace?: string;
2703
- }
2704
- export interface ContinueSideEffectsFlowInLegacyData {
2705
- storeId?: string;
2706
- orderId?: string;
2707
- ordersExperiments?: OrdersExperiments;
2708
- }
2709
- export interface OrdersExperiments {
2710
- epCommitTax?: boolean;
2711
- moveMerchantEmailToEp?: boolean;
2712
- moveBuyerOrderConfirmationEmailToEp?: boolean;
2713
- producedByEpBridge?: boolean;
2714
- enableRewrittenSideEffects?: boolean;
2715
- }
2716
- export interface IndexingMessage {
2717
- id?: string;
2718
- opType?: number;
2719
- requiredVersions?: string[];
2720
- }
2721
- export interface GetOrderRequest {
2722
- /** ID of the order to retrieve. */
2723
- id: string;
2724
- }
2725
- export interface GetOrderResponse {
2726
- /** The requested order. */
2727
- order?: Order;
2728
- }
2729
- export interface ListOrdersResponse {
2730
- /** The requested order. */
2731
- orders?: Order[];
2732
- /** Details on the paged set of results returned. */
2733
- pagingMetadata?: CursorPagingMetadata;
2734
- }
2735
- export interface InternalQueryOrdersResponse {
2736
- /** List of orders. */
2737
- orders?: Order[];
2738
- /** Details on the paged set of results returned. */
2739
- metadata?: PlatformPagingMetadata;
2740
- }
2741
- export interface QueryOrderRequest {
2742
- /** Query options. */
2743
- query?: PlatformQuery;
2744
- }
2745
- export interface QueryOrderResponse {
2746
- /** List of orders. */
2747
- orders?: Order[];
2748
- /** Details on the paged set of results returned. */
2749
- metadata?: PlatformPagingMetadata;
2616
+ export interface AppliedDiscountDelta extends AppliedDiscountDeltaDeltaOneOf {
2617
+ editedDiscount?: AppliedDiscount;
2618
+ discountRemoved?: boolean;
2619
+ /** Discount id. */
2620
+ discountId?: string;
2750
2621
  }
2751
- export interface SearchOrdersRequest {
2752
- /** Search options. */
2753
- search?: CursorSearch;
2622
+ /** @oneof */
2623
+ export interface AppliedDiscountDeltaDeltaOneOf {
2624
+ editedDiscount?: AppliedDiscount;
2625
+ discountRemoved?: boolean;
2754
2626
  }
2755
- export interface CursorSearch extends CursorSearchPagingMethodOneOf {
2756
- /** Cursor pointing to page of results. `cursorPaging.cursor` cannot be used with 'filter' or 'sort'. */
2757
- cursorPaging?: CursorPaging;
2758
- /**
2759
- * Filter object.
2760
- *
2761
- * For example, the following `filter` object will only return orders with payment statuses of paid and/or partially paid:
2762
- * `"filter": {"paymentStatus": {"$in": ["PAID", "PARTIALLY_PAID"]}}`
2763
- *
2764
- * Learn more about the filter format [here](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
2765
- */
2766
- filter?: Record<string, any> | null;
2767
- /**
2768
- * Array of sort objects that specify the order in which results should be sorted.
2769
- *
2770
- * For example, the following `sort` array will sort by `createdDate` in descending order:
2771
- * `"sort": [{"fieldName": "createdDate", "order":"DESC"}]`.
2772
- *
2773
- * Learn more about the sort format [here](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
2774
- */
2775
- sort?: Sorting[];
2627
+ export interface AdditionalFeeDelta extends AdditionalFeeDeltaDeltaOneOf {
2628
+ editedAdditionalFee?: AdditionalFee;
2629
+ additionalFeeRemoved?: boolean;
2630
+ /** Additional fee id. */
2631
+ additionalFeeId?: string;
2776
2632
  }
2777
2633
  /** @oneof */
2778
- export interface CursorSearchPagingMethodOneOf {
2779
- /** Cursor pointing to page of results. `cursorPaging.cursor` cannot be used with 'filter' or 'sort'. */
2780
- cursorPaging?: CursorPaging;
2781
- }
2782
- export interface SearchOrdersResponse {
2783
- /** List of orders. */
2784
- orders?: Order[];
2785
- /** Details on the paged set of results returned. */
2786
- metadata?: CursorPagingMetadata;
2634
+ export interface AdditionalFeeDeltaDeltaOneOf {
2635
+ editedAdditionalFee?: AdditionalFee;
2636
+ additionalFeeRemoved?: boolean;
2787
2637
  }
2788
- export interface CreateOrderRequest {
2789
- /** Order info. */
2790
- order: Order;
2638
+ export interface DraftOrderCommitSettings {
2639
+ /** If false, do not send notifications to buyer. Default is true. */
2640
+ sendNotificationsToBuyer?: boolean | null;
2641
+ /** If false, do not send notifications to business. Default is true. */
2642
+ sendNotificationsToBusiness?: boolean | null;
2643
+ /** If false,do not add activities to the order. Default is true. */
2644
+ addActivitiesToOrder?: boolean | null;
2645
+ /** If false, do not send mails to custom fulfillers in case of a change of shippable items fulfilled by custom fulfillers. Default is true. */
2646
+ sendNotificationsToCustomFulfillers?: boolean | null;
2647
+ /** Inventory changes to be applied. Either to restock, or decrease. */
2648
+ inventoryUpdates?: InventoryUpdateDetails[];
2791
2649
  }
2792
- export interface CreateOrderResponse {
2793
- /** Newly created order. */
2794
- order?: Order;
2650
+ export interface InventoryUpdateDetails {
2651
+ /** Action to be applied - decrease or restock */
2652
+ actionType?: InventoryAction;
2653
+ /** Order line item id */
2654
+ lineItemId?: string;
2655
+ /** The amount to be increased or restocked */
2656
+ quantityChange?: number;
2795
2657
  }
2796
- export interface UpdateOrderRequest {
2797
- /** Order to be updated. */
2798
- order: Order;
2658
+ export declare enum InventoryAction {
2659
+ /** Restock inventory */
2660
+ RESTOCK = "RESTOCK",
2661
+ /** Decrease inventory. Without failing on negative inventory. */
2662
+ DECREASE = "DECREASE"
2799
2663
  }
2800
- export interface UpdateOrderResponse {
2801
- /** Newly created order. */
2664
+ export interface CommitDeltasResponse {
2665
+ /** Order after deltas are applied */
2802
2666
  order?: Order;
2803
2667
  }
2804
- export interface CommitDeltasRequest {
2805
- /** Order id to be updated */
2806
- id?: string;
2807
- /**
2808
- * Draft order Id representing this change.
2809
- * Use this ID to get this specific draft content. call .../v1/draft-orders/{draft_order_id}/get
2810
- */
2668
+ /** Triggered when order is edited by draftOrders */
2669
+ export interface OrderDeltasCommitted {
2670
+ /** The order after committed changes. */
2671
+ order?: Order;
2672
+ /** Draft order Id representing this change. */
2811
2673
  draftOrderId?: string;
2812
- /** Draft order changes to be applied */
2813
- changes?: DraftOrderDiffs;
2814
- /** Side-effects to happen after order is updated */
2674
+ /** Applied changes. */
2675
+ changes?: CommittedDiffs;
2676
+ /** Side-effects requested to happen as a result of this edit. */
2815
2677
  commitSettings?: DraftOrderCommitSettings;
2816
- /** Reason for edit, given by user (optional). */
2817
- reason?: string | null;
2678
+ /**
2679
+ * Date and time when order deltas were committed.
2680
+ * @readonly
2681
+ */
2682
+ commitDate?: Date;
2818
2683
  }
2819
- export interface DraftOrderDiffs extends DraftOrderDiffsShippingUpdateInfoOneOf {
2684
+ export interface CommittedDiffs extends CommittedDiffsShippingUpdateInfoOneOf {
2820
2685
  /** Shipping info and selected shipping option details. */
2821
2686
  changedShippingInfo?: ShippingInformation;
2822
2687
  /** Remove existing shipping info. */
2823
2688
  shippingInfoRemoved?: boolean;
2824
2689
  /** Added/updated/removed order line items. */
2825
- lineItems?: LineItemDelta[];
2690
+ lineItems?: CommittedDiffsLineItemDelta[];
2826
2691
  /**
2827
2692
  * Added/updated/removed discounts.
2828
2693
  * todo: set (.wix.api.maxSize). need to find it. existing : merchant can have 100 + 1 coupon + ? due to automatic discounts
@@ -2830,209 +2695,23 @@ export interface DraftOrderDiffs extends DraftOrderDiffsShippingUpdateInfoOneOf
2830
2695
  appliedDiscounts?: AppliedDiscountDelta[];
2831
2696
  /** Added/updated/removed additional fee. */
2832
2697
  additionalFees?: AdditionalFeeDelta[];
2833
- /** Updated Tax summary. overwrites existing tax summary. */
2834
- taxSummary?: TaxSummary;
2835
- /**
2836
- * Updated order price summary. overwrites existing price summary.
2837
- * balance will be updated automatically.
2838
- */
2839
- priceSummary?: PriceSummary;
2840
2698
  }
2841
2699
  /** @oneof */
2842
- export interface DraftOrderDiffsShippingUpdateInfoOneOf {
2700
+ export interface CommittedDiffsShippingUpdateInfoOneOf {
2843
2701
  /** Shipping info and selected shipping option details. */
2844
2702
  changedShippingInfo?: ShippingInformation;
2845
2703
  /** Remove existing shipping info. */
2846
2704
  shippingInfoRemoved?: boolean;
2847
2705
  }
2848
- export interface LineItemDelta extends LineItemDeltaDeltaOneOf {
2849
- /** The line item was added. */
2706
+ export interface CommittedDiffsLineItemDelta extends CommittedDiffsLineItemDeltaDeltaOneOf {
2850
2707
  lineItemAdded?: boolean;
2851
- /** The line item was modified. */
2852
2708
  changedDetails?: ItemChangedDetails;
2853
- /** The line item was added. */
2854
- lineItemRemoved?: boolean;
2709
+ lineItemRemoved?: OrderLineItemChangedDetails;
2855
2710
  /** Line item ID. */
2856
2711
  lineItemId?: string;
2857
- lineItem?: OrderLineItemChangedDetails;
2858
2712
  }
2859
2713
  /** @oneof */
2860
- export interface LineItemDeltaDeltaOneOf {
2861
- /** The line item was added. */
2862
- lineItemAdded?: boolean;
2863
- /** The line item was modified. */
2864
- changedDetails?: ItemChangedDetails;
2865
- /** The line item was added. */
2866
- lineItemRemoved?: boolean;
2867
- }
2868
- export interface OrderLineItemChangedDetails {
2869
- /**
2870
- * Item name.
2871
- * + Stores - `product.name`
2872
- * + Bookings - `service.info.name`
2873
- * + Events - `ticket.name`
2874
- */
2875
- productName?: ProductName;
2876
- /**
2877
- * References to the line item's origin catalog.
2878
- * This field is empty in the case of a custom line item.
2879
- */
2880
- catalogReference?: CatalogReference;
2881
- /** Line item quantity. */
2882
- quantity?: number;
2883
- /** Total discount for this line item's entire quantity. */
2884
- totalDiscount?: Price;
2885
- /** Line item description lines. Used for display purposes for the cart, checkout and order. */
2886
- descriptionLines?: DescriptionLine[];
2887
- /** Line item image. */
2888
- image?: Image;
2889
- /** Physical properties of the item. When relevant, contains information such as SKU and item weight. */
2890
- physicalProperties?: PhysicalProperties;
2891
- /** Item type. Either a preset type or custom. */
2892
- itemType?: ItemType;
2893
- /**
2894
- * Fulfiller ID. Field is empty when the line item is self-fulfilled.
2895
- * To get fulfillment information, pass this order's ID to [List Fulfillments For Single Order](https://bo.wix.com/wix-docs/rest/ecommerce/order-fulfillments/list-fulfillments-for-single-order).
2896
- */
2897
- fulfillerId?: string | null;
2898
- /** Line item price after line item discounts for display purposes. */
2899
- price?: Price;
2900
- /** Line item price before line item discounts for display purposes. Defaults to `price` when not provided. */
2901
- priceBeforeDiscounts?: Price;
2902
- /** Total price after all discounts and tax. */
2903
- totalPriceAfterTax?: Price;
2904
- /**
2905
- * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
2906
- * + `FULL_PAYMENT_OFFLINE` - The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
2907
- * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
2908
- */
2909
- paymentOption?: DeltaPaymentOptionType;
2910
- /** Tax details for this line item. */
2911
- taxDetails?: ItemTaxFullDetails;
2912
- /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
2913
- priceDescription?: PriceDescription;
2914
- /** Total price after all discounts excluding tax. */
2915
- totalPriceBeforeTax?: Price;
2916
- }
2917
- /** Type of selected payment option for catalog item */
2918
- export declare enum DeltaPaymentOptionType {
2919
- /** irrelevant */
2920
- UNKNOWN_PAYMENT_OPTION = "UNKNOWN_PAYMENT_OPTION",
2921
- /** The entire payment for given item will happen after the checkout. */
2922
- FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
2923
- /**
2924
- * Payment for this item can only be done using a membership and must be manually redeemed in the dashboard by the site owner.
2925
- * Note: when this option is used, price will be 0.
2926
- */
2927
- MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
2928
- }
2929
- export interface ItemChangedDetails {
2930
- /** The quantity before the change. */
2931
- quantityBeforeChange?: number | null;
2932
- /** The price before the change. */
2933
- priceBeforeChange?: Price;
2934
- /** The price description before the change */
2935
- priceDescriptionBeforeChange?: PriceDescription;
2936
- }
2937
- export interface AppliedDiscountDelta extends AppliedDiscountDeltaDeltaOneOf {
2938
- editedDiscount?: AppliedDiscount;
2939
- discountRemoved?: boolean;
2940
- /** Discount id. */
2941
- discountId?: string;
2942
- }
2943
- /** @oneof */
2944
- export interface AppliedDiscountDeltaDeltaOneOf {
2945
- editedDiscount?: AppliedDiscount;
2946
- discountRemoved?: boolean;
2947
- }
2948
- export interface AdditionalFeeDelta extends AdditionalFeeDeltaDeltaOneOf {
2949
- editedAdditionalFee?: AdditionalFee;
2950
- additionalFeeRemoved?: boolean;
2951
- /** Additional fee id. */
2952
- additionalFeeId?: string;
2953
- }
2954
- /** @oneof */
2955
- export interface AdditionalFeeDeltaDeltaOneOf {
2956
- editedAdditionalFee?: AdditionalFee;
2957
- additionalFeeRemoved?: boolean;
2958
- }
2959
- export interface DraftOrderCommitSettings {
2960
- /** If false, do not send notifications to buyer. Default is true. */
2961
- sendNotificationsToBuyer?: boolean | null;
2962
- /** If false, do not send notifications to business. Default is true. */
2963
- sendNotificationsToBusiness?: boolean | null;
2964
- /** If false,do not add activities to the order. Default is true. */
2965
- addActivitiesToOrder?: boolean | null;
2966
- /** If false, do not send mails to custom fulfillers in case of a change of shippable items fulfilled by custom fulfillers. Default is true. */
2967
- sendNotificationsToCustomFulfillers?: boolean | null;
2968
- /** Inventory changes to be applied. Either to restock, or decrease. */
2969
- inventoryUpdates?: InventoryUpdateDetails[];
2970
- }
2971
- export interface InventoryUpdateDetails {
2972
- /** Action to be applied - decrease or restock */
2973
- actionType?: InventoryAction;
2974
- /** Order line item id */
2975
- lineItemId?: string;
2976
- /** The amount to be increased or restocked */
2977
- quantityChange?: number;
2978
- }
2979
- export declare enum InventoryAction {
2980
- /** Restock inventory */
2981
- RESTOCK = "RESTOCK",
2982
- /** Decrease inventory. Without failing on negative inventory. */
2983
- DECREASE = "DECREASE"
2984
- }
2985
- export interface CommitDeltasResponse {
2986
- /** Order after deltas are applied */
2987
- order?: Order;
2988
- }
2989
- /** Triggered when order is edited by draftOrders */
2990
- export interface OrderDeltasCommitted {
2991
- /** The order after committed changes. */
2992
- order?: Order;
2993
- /** Draft order Id representing this change. */
2994
- draftOrderId?: string;
2995
- /** Applied changes. */
2996
- changes?: CommittedDiffs;
2997
- /** Side-effects requested to happen as a result of this edit. */
2998
- commitSettings?: DraftOrderCommitSettings;
2999
- /**
3000
- * Date and time when order deltas were committed.
3001
- * @readonly
3002
- */
3003
- commitDate?: Date;
3004
- }
3005
- export interface CommittedDiffs extends CommittedDiffsShippingUpdateInfoOneOf {
3006
- /** Shipping info and selected shipping option details. */
3007
- changedShippingInfo?: ShippingInformation;
3008
- /** Remove existing shipping info. */
3009
- shippingInfoRemoved?: boolean;
3010
- /** Added/updated/removed order line items. */
3011
- lineItems?: CommittedDiffsLineItemDelta[];
3012
- /**
3013
- * Added/updated/removed discounts.
3014
- * todo: set (.wix.api.maxSize). need to find it. existing : merchant can have 100 + 1 coupon + ? due to automatic discounts
3015
- */
3016
- appliedDiscounts?: AppliedDiscountDelta[];
3017
- /** Added/updated/removed additional fee. */
3018
- additionalFees?: AdditionalFeeDelta[];
3019
- }
3020
- /** @oneof */
3021
- export interface CommittedDiffsShippingUpdateInfoOneOf {
3022
- /** Shipping info and selected shipping option details. */
3023
- changedShippingInfo?: ShippingInformation;
3024
- /** Remove existing shipping info. */
3025
- shippingInfoRemoved?: boolean;
3026
- }
3027
- export interface CommittedDiffsLineItemDelta extends CommittedDiffsLineItemDeltaDeltaOneOf {
3028
- lineItemAdded?: boolean;
3029
- changedDetails?: ItemChangedDetails;
3030
- lineItemRemoved?: OrderLineItemChangedDetails;
3031
- /** Line item ID. */
3032
- lineItemId?: string;
3033
- }
3034
- /** @oneof */
3035
- export interface CommittedDiffsLineItemDeltaDeltaOneOf {
2714
+ export interface CommittedDiffsLineItemDeltaDeltaOneOf {
3036
2715
  lineItemAdded?: boolean;
3037
2716
  changedDetails?: ItemChangedDetails;
3038
2717
  lineItemRemoved?: OrderLineItemChangedDetails;
@@ -3637,13 +3316,907 @@ export interface InvoiceSentEvent {
3637
3316
  /** @readonly */
3638
3317
  status?: InvoiceStatus;
3639
3318
  }
3640
- export interface TriggerSideEffectsFromLegacyData {
3641
- storeId?: string;
3642
- orderId?: string;
3643
- ordersExperiments?: OrdersExperiments;
3319
+ export interface IdAndVersion {
3320
+ id?: string | null;
3321
+ version?: number | null;
3322
+ }
3323
+ export interface InvoiceFields {
3324
+ /** The invoice number allocated the invoice by the server. The number is limited to at most 11 digits. */
3325
+ number?: string | null;
3326
+ /** The invoice 3-letter currency code in [ISO-4217 alphabetic](https://www.iso.org/iso-4217-currency-codes.html) format. */
3327
+ currencyCode?: string | null;
3328
+ /** The invoice customer. The customer must be a contact of the site, with an email. */
3329
+ customer?: Customer;
3330
+ /**
3331
+ * Invoice dates: issue date and due date are mandatory and provided when the invoice is created.
3332
+ * Last seen date is the optional date when the invoice was last seen be UoU.
3333
+ */
3334
+ dates?: InvoiceDates;
3335
+ /**
3336
+ * Line items containing the details of the products or services relevant to the invoice, with their name, prices,
3337
+ * and quantity. There must be at least one line item on the invoice.
3338
+ */
3339
+ lineItems?: LineItems;
3340
+ /**
3341
+ * Locale of the invoice, containing the language.
3342
+ * This field is not mandatory but is used for display purposes, to determine the appearance of numbers and dates
3343
+ * on the invoice.
3344
+ */
3345
+ locale?: Locale;
3346
+ /**
3347
+ * The totals on the invoice.
3348
+ * The totals.subtotal, totals.total and totals.taxed_amount are calculated by the server based on the line items.
3349
+ * Alternatively, these fields can be provided in the invoice creation request, in this case, these values are fixed.
3350
+ * The totals contain fees and a discount, that apply to the invoice.
3351
+ */
3352
+ totals?: TotalPrice;
3353
+ /** An optional discount on the invoice. */
3354
+ discount?: Discount;
3355
+ /** The taxes of the invoice. */
3356
+ taxes?: CalculatedTaxes;
3357
+ /** The payments on the invoice. The invoice has status paid if its payments cover the invoice total. */
3358
+ payments?: Payments;
3359
+ /** Invoice metadata */
3360
+ metaData?: MetaData;
3361
+ /** Not used */
3362
+ creationAdditional_BIInformation?: string | null;
3363
+ /**
3364
+ * The balance and amount paid on the invoice.
3365
+ * This read-only field is calculated based on the invoice totals and payments.
3366
+ * @readonly
3367
+ */
3368
+ dynamicTotals?: InvoiceDynamicPriceTotals;
3369
+ /** The invoice title */
3370
+ title?: string | null;
3371
+ /** Invoice custom fields */
3372
+ customFields?: CustomFieldValue[];
3373
+ /** Not used */
3374
+ designTemplateId?: string | null;
3375
+ /** Not used */
3376
+ createOrder?: boolean | null;
3377
+ /** The optional deposit of the invoice */
3378
+ deposit?: Deposit;
3379
+ /** associated checkout for this invoice */
3380
+ ecomCheckoutId?: string | null;
3381
+ }
3382
+ export interface Customer {
3383
+ contactId?: string | null;
3384
+ name?: string | null;
3385
+ email?: Email;
3386
+ address?: QuotesAddress;
3387
+ phone?: Phone;
3388
+ company?: Company;
3389
+ firstName?: string | null;
3390
+ lastName?: string | null;
3391
+ billingAddress?: CommonAddress;
3392
+ shippingAddress?: CommonAddress;
3393
+ }
3394
+ export interface Email {
3395
+ address?: string;
3396
+ }
3397
+ export interface QuotesAddress {
3398
+ street?: string | null;
3399
+ city?: string | null;
3400
+ zip?: string | null;
3401
+ state?: string | null;
3402
+ country?: string | null;
3403
+ /** @readonly */
3404
+ description?: AddressDescription;
3405
+ }
3406
+ export interface AddressDescription {
3407
+ content?: string;
3408
+ placement?: Placement;
3409
+ }
3410
+ export declare enum Placement {
3411
+ Unknown = "Unknown",
3412
+ Replace = "Replace",
3413
+ Before = "Before",
3414
+ After = "After"
3415
+ }
3416
+ export interface Phone {
3417
+ number?: string;
3418
+ }
3419
+ export interface Company {
3420
+ name?: string;
3421
+ id?: string | null;
3422
+ }
3423
+ /** Physical address */
3424
+ export interface CommonAddress extends CommonAddressStreetOneOf {
3425
+ /** Street name and number. */
3426
+ streetAddress?: StreetAddress;
3427
+ /** Main address line, usually street and number as free text. */
3428
+ addressLine?: string | null;
3429
+ /** Country code. */
3430
+ country?: string | null;
3431
+ /** Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
3432
+ subdivision?: string | null;
3433
+ /** City name. */
3434
+ city?: string | null;
3435
+ /** Zip/postal code. */
3436
+ postalCode?: string | null;
3437
+ /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
3438
+ addressLine2?: string | null;
3439
+ }
3440
+ /** @oneof */
3441
+ export interface CommonAddressStreetOneOf {
3442
+ /** Street name and number. */
3443
+ streetAddress?: StreetAddress;
3444
+ /** Main address line, usually street and number as free text. */
3445
+ addressLine?: string | null;
3446
+ }
3447
+ export interface Subdivision {
3448
+ /** Short subdivision code. */
3449
+ code?: string;
3450
+ /** Subdivision full name. */
3451
+ name?: string;
3452
+ }
3453
+ export declare enum SubdivisionType {
3454
+ UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
3455
+ /** State */
3456
+ ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
3457
+ /** County */
3458
+ ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
3459
+ /** City/town */
3460
+ ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
3461
+ /** Neighborhood/quarter */
3462
+ ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
3463
+ /** Street/block */
3464
+ ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
3465
+ /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
3466
+ COUNTRY = "COUNTRY"
3467
+ }
3468
+ export interface InvoiceDates {
3469
+ /** use UTC midnight date to set the issue date according to the site time zone */
3470
+ issueDate?: Date;
3471
+ /** use UTC midnight date to set the due date according to the site time zone */
3472
+ dueDate?: Date;
3473
+ /** <a href="http://joda-time.sourceforge.net/timezones.html">Valid time zones</a> */
3474
+ timeZoneCode?: string | null;
3475
+ /**
3476
+ * ignored in request use in response to get the site time zone
3477
+ * @readonly
3478
+ */
3479
+ lastSeenDate?: Date;
3480
+ }
3481
+ export interface LineItems {
3482
+ lineItems?: LineItem[];
3483
+ }
3484
+ export interface LineItem {
3485
+ id?: string;
3486
+ name?: string;
3487
+ description?: string | null;
3488
+ price?: BigDecimalWrapper;
3489
+ taxedTotal?: BigDecimalWrapper;
3490
+ quantity?: BigDecimalWrapper;
3491
+ taxes?: LineItemTax[];
3492
+ /** The source of the line item */
3493
+ source?: Source;
3494
+ /** The line-item level metadata. */
3495
+ metadata?: LineItemMetaData;
3496
+ }
3497
+ export interface BigDecimalWrapper {
3498
+ serializedValue?: number;
3499
+ }
3500
+ export interface LineItemTax {
3501
+ name?: string;
3502
+ rate?: BigDecimalWrapper;
3503
+ code?: string | null;
3504
+ }
3505
+ export interface Source {
3506
+ /**
3507
+ * Source app or service ID.
3508
+ * @readonly
3509
+ */
3510
+ sourceId?: string;
3511
+ /**
3512
+ * App or service type.
3513
+ * @readonly
3514
+ */
3515
+ sourceType?: SourceType;
3516
+ }
3517
+ export declare enum SourceType {
3518
+ UNKNOWN_SOURCE_TYPE = "UNKNOWN_SOURCE_TYPE",
3519
+ WIX_APP = "WIX_APP",
3520
+ EXTERNAL = "EXTERNAL",
3521
+ ADMIN = "ADMIN",
3522
+ OTHER = "OTHER"
3523
+ }
3524
+ export interface LineItemMetaData {
3525
+ metadata?: Record<string, string>;
3526
+ }
3527
+ export interface Locale {
3528
+ /** ISO 639 alpha-2 or alpha-3 language code, or a language subtag */
3529
+ language?: string;
3530
+ /** An ISO 3166 alpha-2 country code or a UN M.49 numeric-3 area code. */
3531
+ country?: string | null;
3532
+ invariant?: string | null;
3533
+ }
3534
+ export interface TotalPrice {
3535
+ /** the subtotal of the line items without the tax reduction */
3536
+ subtotal?: BigDecimalWrapper;
3537
+ /** the total price taking into account the itemized fees and the taxes */
3538
+ total?: BigDecimalWrapper;
3539
+ fees?: ItemizedFee[];
3540
+ discountAmount?: BigDecimalWrapper;
3541
+ taxedAmount?: BigDecimalWrapper;
3542
+ }
3543
+ export interface ItemizedFee {
3544
+ name?: string;
3545
+ price?: BigDecimalWrapper;
3546
+ }
3547
+ export interface Discount extends DiscountOneDiscountTypeOneOf {
3548
+ /** Discount as percentage value. */
3549
+ percentage?: BigDecimalWrapper;
3550
+ }
3551
+ /** @oneof */
3552
+ export interface DiscountOneDiscountTypeOneOf {
3553
+ /** Discount as percentage value. */
3554
+ percentage?: BigDecimalWrapper;
3555
+ }
3556
+ export interface CalculatedTaxes {
3557
+ /** consider calculated or not - cannot enforce set */
3558
+ taxes?: CalculatedTax[];
3559
+ }
3560
+ export interface CalculatedTax {
3561
+ name?: string;
3562
+ rate?: BigDecimalWrapper;
3563
+ /** the costs on which the taxes are applied */
3564
+ taxable?: BigDecimalWrapper;
3565
+ /** the taxes as a result of the */
3566
+ taxed?: BigDecimalWrapper;
3567
+ code?: string | null;
3568
+ }
3569
+ export interface Payments {
3570
+ payments?: Payment[];
3571
+ }
3572
+ export interface Payment {
3573
+ /** document */
3574
+ id?: string;
3575
+ type?: string;
3576
+ amount?: BigDecimalWrapper;
3577
+ date?: Date;
3578
+ /**
3579
+ * The orderId of the order in cashier associated with the payment.
3580
+ * This field is populated for external payments that are charged by invoices via AddPayment endpoint.
3581
+ */
3582
+ orderId?: string | null;
3583
+ /**
3584
+ * The transactionId corresponding to the orderId of the payment which are returned by cashier.
3585
+ * This field is populated for external payments that are charged by invoices via AddPayment endpoint as well.
3586
+ */
3587
+ transactionId?: string | null;
3588
+ }
3589
+ export interface MetaData {
3590
+ notes?: string | null;
3591
+ legalTerms?: string | null;
3592
+ sourceUrl?: string | null;
3593
+ sourceProperties?: Record<string, string>;
3594
+ source?: string | null;
3595
+ sourceRefId?: string | null;
3596
+ /** Optional indicator whether to allow editing of the invoice by other applications other than the source. Default is true. */
3597
+ allowEditByOthers?: boolean | null;
3598
+ }
3599
+ export interface InvoiceDynamicPriceTotals {
3600
+ paidAmount?: BigDecimalWrapper;
3601
+ balance?: BigDecimalWrapper;
3602
+ }
3603
+ /**
3604
+ * A custom field value is used to add additional data to a financial document or to a financial document template.
3605
+ * The custom field value may be based on a custom field definition.
3606
+ */
3607
+ export interface CustomFieldValue {
3608
+ /**
3609
+ * The unique id of the custom field value
3610
+ * @readonly
3611
+ */
3612
+ id?: string | null;
3613
+ /** The display name of the custom field value */
3614
+ displayName?: string;
3615
+ /** The optional namespace of the custom field value. This field may be used to indicate intended usage or source. */
3616
+ namespace?: string | null;
3617
+ /** The group of the custom field indicates its intended placement in the financial document */
3618
+ group?: CustomFieldGroup;
3619
+ /** The value of the custom field */
3620
+ value?: Value;
3621
+ /** The optional key of the custom field definition on which the custom field value is based */
3622
+ originCustomFieldKey?: string | null;
3623
+ }
3624
+ export declare enum CustomFieldGroup {
3625
+ UNKNOWN_CUSTOM_FIELD_GROUP = "UNKNOWN_CUSTOM_FIELD_GROUP",
3626
+ BUSINESS_DETAILS = "BUSINESS_DETAILS",
3627
+ CUSTOMER_DETAILS = "CUSTOMER_DETAILS",
3628
+ DOCUMENT = "DOCUMENT",
3629
+ FOOTER = "FOOTER",
3630
+ OTHER = "OTHER"
3631
+ }
3632
+ export interface Value {
3633
+ value?: string;
3634
+ valueType?: ValueType;
3635
+ }
3636
+ export declare enum ValueType {
3637
+ UNKNOWN_VALUE_TYPE = "UNKNOWN_VALUE_TYPE",
3638
+ STRING = "STRING",
3639
+ DATE = "DATE",
3640
+ BOOLEAN = "BOOLEAN",
3641
+ NUMBER = "NUMBER"
3642
+ }
3643
+ export interface Deposit {
3644
+ /** The flat amount of the deposit. The flat amount of the deposit must be less than the invoice total. */
3645
+ flatAmount?: string;
3646
+ /**
3647
+ * The read-only percentage value of the deposit.
3648
+ * It is computed according to the flat_amount and the invoice total and is rounded to 2 digits precision.
3649
+ * @readonly
3650
+ */
3651
+ percentage?: string;
3652
+ /** The type of the deposit. The default is FLAT. */
3653
+ type?: DepositType;
3654
+ }
3655
+ export declare enum DepositType {
3656
+ UNKNOWN = "UNKNOWN",
3657
+ FLAT = "FLAT",
3658
+ PERCENTAGE = "PERCENTAGE"
3659
+ }
3660
+ /**
3661
+ * InvoiceStatus allowed transitions based on current status:
3662
+ * Draft -> Deleted, Paid, Partially Paid, Sent
3663
+ * Sent -> Draft, Deleted, Void, Paid, Partially Paid, Processing, (Overdue)
3664
+ * Processing -> PartiallyPaid, Paid, Sent
3665
+ * Paid -> Void
3666
+ * PartiallyPaid -> Void, (PartialAndOverdue)
3667
+ * Void -> Deleted
3668
+ * Deleted
3669
+ */
3670
+ export declare enum InvoiceStatus {
3671
+ Draft = "Draft",
3672
+ Sent = "Sent",
3673
+ Processing = "Processing",
3674
+ Paid = "Paid",
3675
+ Overdue = "Overdue",
3676
+ Void = "Void",
3677
+ Deleted = "Deleted",
3678
+ PartiallyPaid = "PartiallyPaid",
3679
+ PartialAndOverdue = "PartialAndOverdue"
3680
+ }
3681
+ export interface TriggerSideEffectsFromLegacyData {
3682
+ storeId?: string;
3683
+ orderId?: string;
3684
+ ordersExperiments?: OrdersExperiments;
3685
+ }
3686
+ export interface GetOrderResponseNonNullableFields {
3687
+ order?: {
3688
+ number: string;
3689
+ lineItems: {
3690
+ id: string;
3691
+ productName?: {
3692
+ original: string;
3693
+ };
3694
+ catalogReference?: {
3695
+ catalogItemId: string;
3696
+ appId: string;
3697
+ };
3698
+ quantity: number;
3699
+ totalDiscount?: {
3700
+ amount: string;
3701
+ formattedAmount: string;
3702
+ };
3703
+ descriptionLines: {
3704
+ plainText?: {
3705
+ original: string;
3706
+ };
3707
+ colorInfo?: {
3708
+ original: string;
3709
+ };
3710
+ plainTextValue?: {
3711
+ original: string;
3712
+ };
3713
+ color: string;
3714
+ name?: {
3715
+ original: string;
3716
+ };
3717
+ lineType: DescriptionLineType;
3718
+ }[];
3719
+ image?: {
3720
+ id: string;
3721
+ url: string;
3722
+ height: number;
3723
+ width: number;
3724
+ };
3725
+ physicalProperties?: {
3726
+ shippable: boolean;
3727
+ };
3728
+ itemType?: {
3729
+ preset: ItemTypeItemType;
3730
+ custom: string;
3731
+ };
3732
+ price?: {
3733
+ amount: string;
3734
+ formattedAmount: string;
3735
+ };
3736
+ priceBeforeDiscounts?: {
3737
+ amount: string;
3738
+ formattedAmount: string;
3739
+ };
3740
+ totalPriceBeforeTax?: {
3741
+ amount: string;
3742
+ formattedAmount: string;
3743
+ };
3744
+ totalPriceAfterTax?: {
3745
+ amount: string;
3746
+ formattedAmount: string;
3747
+ };
3748
+ paymentOption: PaymentOptionType;
3749
+ taxDetails?: {
3750
+ taxableAmount?: {
3751
+ amount: string;
3752
+ formattedAmount: string;
3753
+ };
3754
+ taxRate: string;
3755
+ totalTax?: {
3756
+ amount: string;
3757
+ formattedAmount: string;
3758
+ };
3759
+ };
3760
+ digitalFile?: {
3761
+ fileId: string;
3762
+ };
3763
+ subscriptionInfo?: {
3764
+ cycleNumber: number;
3765
+ subscriptionOptionTitle: string;
3766
+ subscriptionSettings?: {
3767
+ frequency: SubscriptionFrequency;
3768
+ autoRenewal: boolean;
3769
+ };
3770
+ };
3771
+ priceDescription?: {
3772
+ original: string;
3773
+ };
3774
+ depositAmount?: {
3775
+ amount: string;
3776
+ formattedAmount: string;
3777
+ };
3778
+ locations: {
3779
+ id: string;
3780
+ quantity: number;
3781
+ }[];
3782
+ lineItemPrice?: {
3783
+ amount: string;
3784
+ formattedAmount: string;
3785
+ };
3786
+ }[];
3787
+ buyerInfo?: {
3788
+ visitorId: string;
3789
+ memberId: string;
3790
+ };
3791
+ paymentStatus: PaymentStatus;
3792
+ fulfillmentStatus: FulfillmentStatus;
3793
+ weightUnit: WeightUnit;
3794
+ taxIncludedInPrices: boolean;
3795
+ priceSummary?: {
3796
+ subtotal?: {
3797
+ amount: string;
3798
+ formattedAmount: string;
3799
+ };
3800
+ shipping?: {
3801
+ amount: string;
3802
+ formattedAmount: string;
3803
+ };
3804
+ tax?: {
3805
+ amount: string;
3806
+ formattedAmount: string;
3807
+ };
3808
+ discount?: {
3809
+ amount: string;
3810
+ formattedAmount: string;
3811
+ };
3812
+ totalPrice?: {
3813
+ amount: string;
3814
+ formattedAmount: string;
3815
+ };
3816
+ total?: {
3817
+ amount: string;
3818
+ formattedAmount: string;
3819
+ };
3820
+ totalWithGiftCard?: {
3821
+ amount: string;
3822
+ formattedAmount: string;
3823
+ };
3824
+ totalWithoutGiftCard?: {
3825
+ amount: string;
3826
+ formattedAmount: string;
3827
+ };
3828
+ totalAdditionalFees?: {
3829
+ amount: string;
3830
+ formattedAmount: string;
3831
+ };
3832
+ };
3833
+ billingInfo?: {
3834
+ address?: {
3835
+ streetAddress?: {
3836
+ number: string;
3837
+ name: string;
3838
+ apt: string;
3839
+ };
3840
+ };
3841
+ contactDetails?: {
3842
+ vatId?: {
3843
+ id: string;
3844
+ type: VatType;
3845
+ };
3846
+ };
3847
+ };
3848
+ shippingInfo?: {
3849
+ title: string;
3850
+ logistics?: {
3851
+ shippingDestination?: {
3852
+ address?: {
3853
+ streetAddress?: {
3854
+ number: string;
3855
+ name: string;
3856
+ apt: string;
3857
+ };
3858
+ };
3859
+ contactDetails?: {
3860
+ vatId?: {
3861
+ id: string;
3862
+ type: VatType;
3863
+ };
3864
+ };
3865
+ };
3866
+ pickupDetails?: {
3867
+ address?: {
3868
+ streetAddress?: {
3869
+ number: string;
3870
+ name: string;
3871
+ apt: string;
3872
+ };
3873
+ };
3874
+ pickupMethod: PickupMethod;
3875
+ };
3876
+ };
3877
+ cost?: {
3878
+ price?: {
3879
+ amount: string;
3880
+ formattedAmount: string;
3881
+ };
3882
+ totalPriceBeforeTax?: {
3883
+ amount: string;
3884
+ formattedAmount: string;
3885
+ };
3886
+ totalPriceAfterTax?: {
3887
+ amount: string;
3888
+ formattedAmount: string;
3889
+ };
3890
+ taxDetails?: {
3891
+ taxableAmount?: {
3892
+ amount: string;
3893
+ formattedAmount: string;
3894
+ };
3895
+ taxRate: string;
3896
+ totalTax?: {
3897
+ amount: string;
3898
+ formattedAmount: string;
3899
+ };
3900
+ };
3901
+ discount?: {
3902
+ amount: string;
3903
+ formattedAmount: string;
3904
+ };
3905
+ };
3906
+ };
3907
+ status: OrderStatus;
3908
+ taxSummary?: {
3909
+ totalTax?: {
3910
+ amount: string;
3911
+ formattedAmount: string;
3912
+ };
3913
+ };
3914
+ appliedDiscounts: {
3915
+ coupon?: {
3916
+ id: string;
3917
+ code: string;
3918
+ name: string;
3919
+ amount?: {
3920
+ amount: string;
3921
+ formattedAmount: string;
3922
+ };
3923
+ };
3924
+ merchantDiscount?: {
3925
+ discountReason: DiscountReason;
3926
+ amount?: {
3927
+ amount: string;
3928
+ formattedAmount: string;
3929
+ };
3930
+ };
3931
+ discountRule?: {
3932
+ id: string;
3933
+ name?: {
3934
+ original: string;
3935
+ };
3936
+ amount?: {
3937
+ amount: string;
3938
+ formattedAmount: string;
3939
+ };
3940
+ };
3941
+ discountType: DiscountType;
3942
+ lineItemIds: string[];
3943
+ }[];
3944
+ activities: {
3945
+ customActivity?: {
3946
+ appId: string;
3947
+ type: string;
3948
+ };
3949
+ merchantComment?: {
3950
+ message: string;
3951
+ };
3952
+ orderRefunded?: {
3953
+ manual: boolean;
3954
+ amount?: {
3955
+ amount: string;
3956
+ formattedAmount: string;
3957
+ };
3958
+ reason: string;
3959
+ };
3960
+ orderCreatedFromExchange?: {
3961
+ originalOrderId: string;
3962
+ };
3963
+ newExchangeOrderCreated?: {
3964
+ exchangeOrderId: string;
3965
+ lineItems: {
3966
+ lineItemId: string;
3967
+ quantity: number;
3968
+ }[];
3969
+ };
3970
+ draftOrderChangesApplied?: {
3971
+ draftOrderId: string;
3972
+ changes: {
3973
+ lineItemChanged?: {
3974
+ id: string;
3975
+ name?: {
3976
+ original: string;
3977
+ };
3978
+ quantity?: {
3979
+ originalQuantity: number;
3980
+ newQuantity: number;
3981
+ diff: number;
3982
+ deltaType: LineItemQuantityChangeType;
3983
+ };
3984
+ price?: {
3985
+ originalPrice?: {
3986
+ amount: string;
3987
+ formattedAmount: string;
3988
+ };
3989
+ newPrice?: {
3990
+ amount: string;
3991
+ formattedAmount: string;
3992
+ };
3993
+ };
3994
+ };
3995
+ lineItemAdded?: {
3996
+ id: string;
3997
+ name?: {
3998
+ original: string;
3999
+ };
4000
+ quantity: number;
4001
+ };
4002
+ lineItemRemoved?: {
4003
+ id: string;
4004
+ name?: {
4005
+ original: string;
4006
+ };
4007
+ quantity: number;
4008
+ };
4009
+ discountAdded?: {
4010
+ id: string;
4011
+ name?: {
4012
+ original: string;
4013
+ };
4014
+ affectedLineItems: {
4015
+ id: string;
4016
+ name?: {
4017
+ original: string;
4018
+ };
4019
+ amount?: {
4020
+ amount: string;
4021
+ formattedAmount: string;
4022
+ };
4023
+ }[];
4024
+ totalAmount?: {
4025
+ amount: string;
4026
+ formattedAmount: string;
4027
+ };
4028
+ };
4029
+ discountRemoved?: {
4030
+ id: string;
4031
+ name?: {
4032
+ original: string;
4033
+ };
4034
+ affectedLineItems: {
4035
+ id: string;
4036
+ name?: {
4037
+ original: string;
4038
+ };
4039
+ amount?: {
4040
+ amount: string;
4041
+ formattedAmount: string;
4042
+ };
4043
+ }[];
4044
+ totalAmount?: {
4045
+ amount: string;
4046
+ formattedAmount: string;
4047
+ };
4048
+ };
4049
+ additionalFeeAdded?: {
4050
+ id: string;
4051
+ name?: {
4052
+ original: string;
4053
+ };
4054
+ affectedLineItems: {
4055
+ id: string;
4056
+ name?: {
4057
+ original: string;
4058
+ };
4059
+ amount?: {
4060
+ amount: string;
4061
+ formattedAmount: string;
4062
+ };
4063
+ }[];
4064
+ totalAmount?: {
4065
+ amount: string;
4066
+ formattedAmount: string;
4067
+ };
4068
+ };
4069
+ additionalFeeRemoved?: {
4070
+ id: string;
4071
+ name?: {
4072
+ original: string;
4073
+ };
4074
+ affectedLineItems: {
4075
+ id: string;
4076
+ name?: {
4077
+ original: string;
4078
+ };
4079
+ amount?: {
4080
+ amount: string;
4081
+ formattedAmount: string;
4082
+ };
4083
+ }[];
4084
+ totalAmount?: {
4085
+ amount: string;
4086
+ formattedAmount: string;
4087
+ };
4088
+ };
4089
+ totalPriceChanged?: {
4090
+ originalTotal?: {
4091
+ amount: string;
4092
+ formattedAmount: string;
4093
+ };
4094
+ newTotal?: {
4095
+ amount: string;
4096
+ formattedAmount: string;
4097
+ };
4098
+ };
4099
+ }[];
4100
+ };
4101
+ type: ActivityType;
4102
+ }[];
4103
+ attributionSource: AttributionSource;
4104
+ createdBy?: {
4105
+ userId: string;
4106
+ memberId: string;
4107
+ visitorId: string;
4108
+ appId: string;
4109
+ };
4110
+ channelInfo?: {
4111
+ type: ChannelType;
4112
+ };
4113
+ customFields: {
4114
+ title: string;
4115
+ }[];
4116
+ isInternalOrderCreate: boolean;
4117
+ payNow?: {
4118
+ subtotal?: {
4119
+ amount: string;
4120
+ formattedAmount: string;
4121
+ };
4122
+ shipping?: {
4123
+ amount: string;
4124
+ formattedAmount: string;
4125
+ };
4126
+ tax?: {
4127
+ amount: string;
4128
+ formattedAmount: string;
4129
+ };
4130
+ discount?: {
4131
+ amount: string;
4132
+ formattedAmount: string;
4133
+ };
4134
+ totalPrice?: {
4135
+ amount: string;
4136
+ formattedAmount: string;
4137
+ };
4138
+ total?: {
4139
+ amount: string;
4140
+ formattedAmount: string;
4141
+ };
4142
+ totalWithGiftCard?: {
4143
+ amount: string;
4144
+ formattedAmount: string;
4145
+ };
4146
+ totalWithoutGiftCard?: {
4147
+ amount: string;
4148
+ formattedAmount: string;
4149
+ };
4150
+ totalAdditionalFees?: {
4151
+ amount: string;
4152
+ formattedAmount: string;
4153
+ };
4154
+ };
4155
+ balanceSummary?: {
4156
+ balance?: {
4157
+ amount: string;
4158
+ formattedAmount: string;
4159
+ };
4160
+ paid?: {
4161
+ amount: string;
4162
+ formattedAmount: string;
4163
+ };
4164
+ refunded?: {
4165
+ amount: string;
4166
+ formattedAmount: string;
4167
+ };
4168
+ };
4169
+ additionalFees: {
4170
+ name: string;
4171
+ price?: {
4172
+ amount: string;
4173
+ formattedAmount: string;
4174
+ };
4175
+ taxDetails?: {
4176
+ taxableAmount?: {
4177
+ amount: string;
4178
+ formattedAmount: string;
4179
+ };
4180
+ taxRate: string;
4181
+ totalTax?: {
4182
+ amount: string;
4183
+ formattedAmount: string;
4184
+ };
4185
+ };
4186
+ priceBeforeTax?: {
4187
+ amount: string;
4188
+ formattedAmount: string;
4189
+ };
4190
+ id: string;
4191
+ lineItemIds: string[];
4192
+ }[];
4193
+ recipientInfo?: {
4194
+ address?: {
4195
+ streetAddress?: {
4196
+ number: string;
4197
+ name: string;
4198
+ apt: string;
4199
+ };
4200
+ };
4201
+ contactDetails?: {
4202
+ vatId?: {
4203
+ id: string;
4204
+ type: VatType;
4205
+ };
4206
+ };
4207
+ };
4208
+ tags?: {
4209
+ privateTags?: {
4210
+ tagIds: string[];
4211
+ };
4212
+ tags?: {
4213
+ tagIds: string[];
4214
+ };
4215
+ };
4216
+ };
3644
4217
  }
3645
- export interface GetOrderResponseNonNullableFields {
3646
- order?: {
4218
+ export interface SearchOrdersResponseNonNullableFields {
4219
+ orders: {
3647
4220
  number: string;
3648
4221
  lineItems: {
3649
4222
  id: string;
@@ -4164,10 +4737,18 @@ export interface GetOrderResponseNonNullableFields {
4164
4737
  };
4165
4738
  };
4166
4739
  };
4167
- };
4740
+ tags?: {
4741
+ privateTags?: {
4742
+ tagIds: string[];
4743
+ };
4744
+ tags?: {
4745
+ tagIds: string[];
4746
+ };
4747
+ };
4748
+ }[];
4168
4749
  }
4169
- export interface SearchOrdersResponseNonNullableFields {
4170
- orders: {
4750
+ export interface CreateOrderResponseNonNullableFields {
4751
+ order?: {
4171
4752
  number: string;
4172
4753
  lineItems: {
4173
4754
  id: string;
@@ -4688,9 +5269,17 @@ export interface SearchOrdersResponseNonNullableFields {
4688
5269
  };
4689
5270
  };
4690
5271
  };
4691
- }[];
5272
+ tags?: {
5273
+ privateTags?: {
5274
+ tagIds: string[];
5275
+ };
5276
+ tags?: {
5277
+ tagIds: string[];
5278
+ };
5279
+ };
5280
+ };
4692
5281
  }
4693
- export interface CreateOrderResponseNonNullableFields {
5282
+ export interface UpdateOrderResponseNonNullableFields {
4694
5283
  order?: {
4695
5284
  number: string;
4696
5285
  lineItems: {
@@ -5109,221 +5698,19 @@ export interface CreateOrderResponseNonNullableFields {
5109
5698
  }[];
5110
5699
  attributionSource: AttributionSource;
5111
5700
  createdBy?: {
5112
- userId: string;
5113
- memberId: string;
5114
- visitorId: string;
5115
- appId: string;
5116
- };
5117
- channelInfo?: {
5118
- type: ChannelType;
5119
- };
5120
- customFields: {
5121
- title: string;
5122
- }[];
5123
- isInternalOrderCreate: boolean;
5124
- payNow?: {
5125
- subtotal?: {
5126
- amount: string;
5127
- formattedAmount: string;
5128
- };
5129
- shipping?: {
5130
- amount: string;
5131
- formattedAmount: string;
5132
- };
5133
- tax?: {
5134
- amount: string;
5135
- formattedAmount: string;
5136
- };
5137
- discount?: {
5138
- amount: string;
5139
- formattedAmount: string;
5140
- };
5141
- totalPrice?: {
5142
- amount: string;
5143
- formattedAmount: string;
5144
- };
5145
- total?: {
5146
- amount: string;
5147
- formattedAmount: string;
5148
- };
5149
- totalWithGiftCard?: {
5150
- amount: string;
5151
- formattedAmount: string;
5152
- };
5153
- totalWithoutGiftCard?: {
5154
- amount: string;
5155
- formattedAmount: string;
5156
- };
5157
- totalAdditionalFees?: {
5158
- amount: string;
5159
- formattedAmount: string;
5160
- };
5161
- };
5162
- balanceSummary?: {
5163
- balance?: {
5164
- amount: string;
5165
- formattedAmount: string;
5166
- };
5167
- paid?: {
5168
- amount: string;
5169
- formattedAmount: string;
5170
- };
5171
- refunded?: {
5172
- amount: string;
5173
- formattedAmount: string;
5174
- };
5175
- };
5176
- additionalFees: {
5177
- name: string;
5178
- price?: {
5179
- amount: string;
5180
- formattedAmount: string;
5181
- };
5182
- taxDetails?: {
5183
- taxableAmount?: {
5184
- amount: string;
5185
- formattedAmount: string;
5186
- };
5187
- taxRate: string;
5188
- totalTax?: {
5189
- amount: string;
5190
- formattedAmount: string;
5191
- };
5192
- };
5193
- priceBeforeTax?: {
5194
- amount: string;
5195
- formattedAmount: string;
5196
- };
5197
- id: string;
5198
- lineItemIds: string[];
5199
- }[];
5200
- recipientInfo?: {
5201
- address?: {
5202
- streetAddress?: {
5203
- number: string;
5204
- name: string;
5205
- apt: string;
5206
- };
5207
- };
5208
- contactDetails?: {
5209
- vatId?: {
5210
- id: string;
5211
- type: VatType;
5212
- };
5213
- };
5214
- };
5215
- };
5216
- }
5217
- export interface UpdateOrderResponseNonNullableFields {
5218
- order?: {
5219
- number: string;
5220
- lineItems: {
5221
- id: string;
5222
- productName?: {
5223
- original: string;
5224
- };
5225
- catalogReference?: {
5226
- catalogItemId: string;
5227
- appId: string;
5228
- };
5229
- quantity: number;
5230
- totalDiscount?: {
5231
- amount: string;
5232
- formattedAmount: string;
5233
- };
5234
- descriptionLines: {
5235
- plainText?: {
5236
- original: string;
5237
- };
5238
- colorInfo?: {
5239
- original: string;
5240
- };
5241
- plainTextValue?: {
5242
- original: string;
5243
- };
5244
- color: string;
5245
- name?: {
5246
- original: string;
5247
- };
5248
- lineType: DescriptionLineType;
5249
- }[];
5250
- image?: {
5251
- id: string;
5252
- url: string;
5253
- height: number;
5254
- width: number;
5255
- };
5256
- physicalProperties?: {
5257
- shippable: boolean;
5258
- };
5259
- itemType?: {
5260
- preset: ItemTypeItemType;
5261
- custom: string;
5262
- };
5263
- price?: {
5264
- amount: string;
5265
- formattedAmount: string;
5266
- };
5267
- priceBeforeDiscounts?: {
5268
- amount: string;
5269
- formattedAmount: string;
5270
- };
5271
- totalPriceBeforeTax?: {
5272
- amount: string;
5273
- formattedAmount: string;
5274
- };
5275
- totalPriceAfterTax?: {
5276
- amount: string;
5277
- formattedAmount: string;
5278
- };
5279
- paymentOption: PaymentOptionType;
5280
- taxDetails?: {
5281
- taxableAmount?: {
5282
- amount: string;
5283
- formattedAmount: string;
5284
- };
5285
- taxRate: string;
5286
- totalTax?: {
5287
- amount: string;
5288
- formattedAmount: string;
5289
- };
5290
- };
5291
- digitalFile?: {
5292
- fileId: string;
5293
- };
5294
- subscriptionInfo?: {
5295
- cycleNumber: number;
5296
- subscriptionOptionTitle: string;
5297
- subscriptionSettings?: {
5298
- frequency: SubscriptionFrequency;
5299
- autoRenewal: boolean;
5300
- };
5301
- };
5302
- priceDescription?: {
5303
- original: string;
5304
- };
5305
- depositAmount?: {
5306
- amount: string;
5307
- formattedAmount: string;
5308
- };
5309
- locations: {
5310
- id: string;
5311
- quantity: number;
5312
- }[];
5313
- lineItemPrice?: {
5314
- amount: string;
5315
- formattedAmount: string;
5316
- };
5317
- }[];
5318
- buyerInfo?: {
5319
- visitorId: string;
5701
+ userId: string;
5320
5702
  memberId: string;
5703
+ visitorId: string;
5704
+ appId: string;
5321
5705
  };
5322
- paymentStatus: PaymentStatus;
5323
- fulfillmentStatus: FulfillmentStatus;
5324
- weightUnit: WeightUnit;
5325
- taxIncludedInPrices: boolean;
5326
- priceSummary?: {
5706
+ channelInfo?: {
5707
+ type: ChannelType;
5708
+ };
5709
+ customFields: {
5710
+ title: string;
5711
+ }[];
5712
+ isInternalOrderCreate: boolean;
5713
+ payNow?: {
5327
5714
  subtotal?: {
5328
5715
  amount: string;
5329
5716
  formattedAmount: string;
@@ -5361,7 +5748,45 @@ export interface UpdateOrderResponseNonNullableFields {
5361
5748
  formattedAmount: string;
5362
5749
  };
5363
5750
  };
5364
- billingInfo?: {
5751
+ balanceSummary?: {
5752
+ balance?: {
5753
+ amount: string;
5754
+ formattedAmount: string;
5755
+ };
5756
+ paid?: {
5757
+ amount: string;
5758
+ formattedAmount: string;
5759
+ };
5760
+ refunded?: {
5761
+ amount: string;
5762
+ formattedAmount: string;
5763
+ };
5764
+ };
5765
+ additionalFees: {
5766
+ name: string;
5767
+ price?: {
5768
+ amount: string;
5769
+ formattedAmount: string;
5770
+ };
5771
+ taxDetails?: {
5772
+ taxableAmount?: {
5773
+ amount: string;
5774
+ formattedAmount: string;
5775
+ };
5776
+ taxRate: string;
5777
+ totalTax?: {
5778
+ amount: string;
5779
+ formattedAmount: string;
5780
+ };
5781
+ };
5782
+ priceBeforeTax?: {
5783
+ amount: string;
5784
+ formattedAmount: string;
5785
+ };
5786
+ id: string;
5787
+ lineItemIds: string[];
5788
+ }[];
5789
+ recipientInfo?: {
5365
5790
  address?: {
5366
5791
  streetAddress?: {
5367
5792
  number: string;
@@ -5376,40 +5801,79 @@ export interface UpdateOrderResponseNonNullableFields {
5376
5801
  };
5377
5802
  };
5378
5803
  };
5379
- shippingInfo?: {
5380
- title: string;
5381
- logistics?: {
5382
- shippingDestination?: {
5383
- address?: {
5384
- streetAddress?: {
5385
- number: string;
5386
- name: string;
5387
- apt: string;
5388
- };
5804
+ tags?: {
5805
+ privateTags?: {
5806
+ tagIds: string[];
5807
+ };
5808
+ tags?: {
5809
+ tagIds: string[];
5810
+ };
5811
+ };
5812
+ };
5813
+ }
5814
+ export interface BulkUpdateOrderResponseNonNullableFields {
5815
+ results: {
5816
+ itemMetadata?: {
5817
+ originalIndex: number;
5818
+ success: boolean;
5819
+ error?: {
5820
+ code: string;
5821
+ description: string;
5822
+ };
5823
+ };
5824
+ item?: {
5825
+ number: string;
5826
+ lineItems: {
5827
+ id: string;
5828
+ productName?: {
5829
+ original: string;
5830
+ };
5831
+ catalogReference?: {
5832
+ catalogItemId: string;
5833
+ appId: string;
5834
+ };
5835
+ quantity: number;
5836
+ totalDiscount?: {
5837
+ amount: string;
5838
+ formattedAmount: string;
5839
+ };
5840
+ descriptionLines: {
5841
+ plainText?: {
5842
+ original: string;
5389
5843
  };
5390
- contactDetails?: {
5391
- vatId?: {
5392
- id: string;
5393
- type: VatType;
5394
- };
5844
+ colorInfo?: {
5845
+ original: string;
5395
5846
  };
5396
- };
5397
- pickupDetails?: {
5398
- address?: {
5399
- streetAddress?: {
5400
- number: string;
5401
- name: string;
5402
- apt: string;
5403
- };
5847
+ plainTextValue?: {
5848
+ original: string;
5404
5849
  };
5405
- pickupMethod: PickupMethod;
5850
+ color: string;
5851
+ name?: {
5852
+ original: string;
5853
+ };
5854
+ lineType: DescriptionLineType;
5855
+ }[];
5856
+ image?: {
5857
+ id: string;
5858
+ url: string;
5859
+ height: number;
5860
+ width: number;
5861
+ };
5862
+ physicalProperties?: {
5863
+ shippable: boolean;
5864
+ };
5865
+ itemType?: {
5866
+ preset: ItemTypeItemType;
5867
+ custom: string;
5406
5868
  };
5407
- };
5408
- cost?: {
5409
5869
  price?: {
5410
5870
  amount: string;
5411
5871
  formattedAmount: string;
5412
5872
  };
5873
+ priceBeforeDiscounts?: {
5874
+ amount: string;
5875
+ formattedAmount: string;
5876
+ };
5413
5877
  totalPriceBeforeTax?: {
5414
5878
  amount: string;
5415
5879
  formattedAmount: string;
@@ -5418,6 +5882,7 @@ export interface UpdateOrderResponseNonNullableFields {
5418
5882
  amount: string;
5419
5883
  formattedAmount: string;
5420
5884
  };
5885
+ paymentOption: PaymentOptionType;
5421
5886
  taxDetails?: {
5422
5887
  taxableAmount?: {
5423
5888
  amount: string;
@@ -5429,313 +5894,468 @@ export interface UpdateOrderResponseNonNullableFields {
5429
5894
  formattedAmount: string;
5430
5895
  };
5431
5896
  };
5897
+ digitalFile?: {
5898
+ fileId: string;
5899
+ };
5900
+ subscriptionInfo?: {
5901
+ cycleNumber: number;
5902
+ subscriptionOptionTitle: string;
5903
+ subscriptionSettings?: {
5904
+ frequency: SubscriptionFrequency;
5905
+ autoRenewal: boolean;
5906
+ };
5907
+ };
5908
+ priceDescription?: {
5909
+ original: string;
5910
+ };
5911
+ depositAmount?: {
5912
+ amount: string;
5913
+ formattedAmount: string;
5914
+ };
5915
+ locations: {
5916
+ id: string;
5917
+ quantity: number;
5918
+ }[];
5919
+ lineItemPrice?: {
5920
+ amount: string;
5921
+ formattedAmount: string;
5922
+ };
5923
+ }[];
5924
+ buyerInfo?: {
5925
+ visitorId: string;
5926
+ memberId: string;
5927
+ };
5928
+ paymentStatus: PaymentStatus;
5929
+ fulfillmentStatus: FulfillmentStatus;
5930
+ weightUnit: WeightUnit;
5931
+ taxIncludedInPrices: boolean;
5932
+ priceSummary?: {
5933
+ subtotal?: {
5934
+ amount: string;
5935
+ formattedAmount: string;
5936
+ };
5937
+ shipping?: {
5938
+ amount: string;
5939
+ formattedAmount: string;
5940
+ };
5941
+ tax?: {
5942
+ amount: string;
5943
+ formattedAmount: string;
5944
+ };
5432
5945
  discount?: {
5433
5946
  amount: string;
5434
5947
  formattedAmount: string;
5435
5948
  };
5436
- };
5437
- };
5438
- status: OrderStatus;
5439
- taxSummary?: {
5440
- totalTax?: {
5441
- amount: string;
5442
- formattedAmount: string;
5443
- };
5444
- };
5445
- appliedDiscounts: {
5446
- coupon?: {
5447
- id: string;
5448
- code: string;
5449
- name: string;
5450
- amount?: {
5949
+ totalPrice?: {
5451
5950
  amount: string;
5452
5951
  formattedAmount: string;
5453
5952
  };
5454
- };
5455
- merchantDiscount?: {
5456
- discountReason: DiscountReason;
5457
- amount?: {
5953
+ total?: {
5458
5954
  amount: string;
5459
5955
  formattedAmount: string;
5460
5956
  };
5461
- };
5462
- discountRule?: {
5463
- id: string;
5464
- name?: {
5465
- original: string;
5957
+ totalWithGiftCard?: {
5958
+ amount: string;
5959
+ formattedAmount: string;
5466
5960
  };
5467
- amount?: {
5961
+ totalWithoutGiftCard?: {
5468
5962
  amount: string;
5469
5963
  formattedAmount: string;
5470
5964
  };
5471
- };
5472
- discountType: DiscountType;
5473
- lineItemIds: string[];
5474
- }[];
5475
- activities: {
5476
- customActivity?: {
5477
- appId: string;
5478
- type: string;
5479
- };
5480
- merchantComment?: {
5481
- message: string;
5482
- };
5483
- orderRefunded?: {
5484
- manual: boolean;
5485
- amount?: {
5965
+ totalAdditionalFees?: {
5486
5966
  amount: string;
5487
5967
  formattedAmount: string;
5488
5968
  };
5489
- reason: string;
5490
- };
5491
- orderCreatedFromExchange?: {
5492
- originalOrderId: string;
5493
5969
  };
5494
- newExchangeOrderCreated?: {
5495
- exchangeOrderId: string;
5496
- lineItems: {
5497
- lineItemId: string;
5498
- quantity: number;
5499
- }[];
5500
- };
5501
- draftOrderChangesApplied?: {
5502
- draftOrderId: string;
5503
- changes: {
5504
- lineItemChanged?: {
5970
+ billingInfo?: {
5971
+ address?: {
5972
+ streetAddress?: {
5973
+ number: string;
5974
+ name: string;
5975
+ apt: string;
5976
+ };
5977
+ };
5978
+ contactDetails?: {
5979
+ vatId?: {
5505
5980
  id: string;
5506
- name?: {
5507
- original: string;
5981
+ type: VatType;
5982
+ };
5983
+ };
5984
+ };
5985
+ shippingInfo?: {
5986
+ title: string;
5987
+ logistics?: {
5988
+ shippingDestination?: {
5989
+ address?: {
5990
+ streetAddress?: {
5991
+ number: string;
5992
+ name: string;
5993
+ apt: string;
5994
+ };
5508
5995
  };
5509
- quantity?: {
5510
- originalQuantity: number;
5511
- newQuantity: number;
5512
- diff: number;
5513
- deltaType: LineItemQuantityChangeType;
5996
+ contactDetails?: {
5997
+ vatId?: {
5998
+ id: string;
5999
+ type: VatType;
6000
+ };
5514
6001
  };
5515
- price?: {
5516
- originalPrice?: {
5517
- amount: string;
5518
- formattedAmount: string;
6002
+ };
6003
+ pickupDetails?: {
6004
+ address?: {
6005
+ streetAddress?: {
6006
+ number: string;
6007
+ name: string;
6008
+ apt: string;
6009
+ };
6010
+ };
6011
+ pickupMethod: PickupMethod;
6012
+ };
6013
+ };
6014
+ cost?: {
6015
+ price?: {
6016
+ amount: string;
6017
+ formattedAmount: string;
6018
+ };
6019
+ totalPriceBeforeTax?: {
6020
+ amount: string;
6021
+ formattedAmount: string;
6022
+ };
6023
+ totalPriceAfterTax?: {
6024
+ amount: string;
6025
+ formattedAmount: string;
6026
+ };
6027
+ taxDetails?: {
6028
+ taxableAmount?: {
6029
+ amount: string;
6030
+ formattedAmount: string;
6031
+ };
6032
+ taxRate: string;
6033
+ totalTax?: {
6034
+ amount: string;
6035
+ formattedAmount: string;
6036
+ };
6037
+ };
6038
+ discount?: {
6039
+ amount: string;
6040
+ formattedAmount: string;
6041
+ };
6042
+ };
6043
+ };
6044
+ status: OrderStatus;
6045
+ taxSummary?: {
6046
+ totalTax?: {
6047
+ amount: string;
6048
+ formattedAmount: string;
6049
+ };
6050
+ };
6051
+ appliedDiscounts: {
6052
+ coupon?: {
6053
+ id: string;
6054
+ code: string;
6055
+ name: string;
6056
+ amount?: {
6057
+ amount: string;
6058
+ formattedAmount: string;
6059
+ };
6060
+ };
6061
+ merchantDiscount?: {
6062
+ discountReason: DiscountReason;
6063
+ amount?: {
6064
+ amount: string;
6065
+ formattedAmount: string;
6066
+ };
6067
+ };
6068
+ discountRule?: {
6069
+ id: string;
6070
+ name?: {
6071
+ original: string;
6072
+ };
6073
+ amount?: {
6074
+ amount: string;
6075
+ formattedAmount: string;
6076
+ };
6077
+ };
6078
+ discountType: DiscountType;
6079
+ lineItemIds: string[];
6080
+ }[];
6081
+ activities: {
6082
+ customActivity?: {
6083
+ appId: string;
6084
+ type: string;
6085
+ };
6086
+ merchantComment?: {
6087
+ message: string;
6088
+ };
6089
+ orderRefunded?: {
6090
+ manual: boolean;
6091
+ amount?: {
6092
+ amount: string;
6093
+ formattedAmount: string;
6094
+ };
6095
+ reason: string;
6096
+ };
6097
+ orderCreatedFromExchange?: {
6098
+ originalOrderId: string;
6099
+ };
6100
+ newExchangeOrderCreated?: {
6101
+ exchangeOrderId: string;
6102
+ lineItems: {
6103
+ lineItemId: string;
6104
+ quantity: number;
6105
+ }[];
6106
+ };
6107
+ draftOrderChangesApplied?: {
6108
+ draftOrderId: string;
6109
+ changes: {
6110
+ lineItemChanged?: {
6111
+ id: string;
6112
+ name?: {
6113
+ original: string;
5519
6114
  };
5520
- newPrice?: {
5521
- amount: string;
5522
- formattedAmount: string;
6115
+ quantity?: {
6116
+ originalQuantity: number;
6117
+ newQuantity: number;
6118
+ diff: number;
6119
+ deltaType: LineItemQuantityChangeType;
6120
+ };
6121
+ price?: {
6122
+ originalPrice?: {
6123
+ amount: string;
6124
+ formattedAmount: string;
6125
+ };
6126
+ newPrice?: {
6127
+ amount: string;
6128
+ formattedAmount: string;
6129
+ };
5523
6130
  };
5524
6131
  };
5525
- };
5526
- lineItemAdded?: {
5527
- id: string;
5528
- name?: {
5529
- original: string;
5530
- };
5531
- quantity: number;
5532
- };
5533
- lineItemRemoved?: {
5534
- id: string;
5535
- name?: {
5536
- original: string;
6132
+ lineItemAdded?: {
6133
+ id: string;
6134
+ name?: {
6135
+ original: string;
6136
+ };
6137
+ quantity: number;
5537
6138
  };
5538
- quantity: number;
5539
- };
5540
- discountAdded?: {
5541
- id: string;
5542
- name?: {
5543
- original: string;
6139
+ lineItemRemoved?: {
6140
+ id: string;
6141
+ name?: {
6142
+ original: string;
6143
+ };
6144
+ quantity: number;
5544
6145
  };
5545
- affectedLineItems: {
6146
+ discountAdded?: {
5546
6147
  id: string;
5547
6148
  name?: {
5548
6149
  original: string;
5549
6150
  };
5550
- amount?: {
6151
+ affectedLineItems: {
6152
+ id: string;
6153
+ name?: {
6154
+ original: string;
6155
+ };
6156
+ amount?: {
6157
+ amount: string;
6158
+ formattedAmount: string;
6159
+ };
6160
+ }[];
6161
+ totalAmount?: {
5551
6162
  amount: string;
5552
6163
  formattedAmount: string;
5553
6164
  };
5554
- }[];
5555
- totalAmount?: {
5556
- amount: string;
5557
- formattedAmount: string;
5558
- };
5559
- };
5560
- discountRemoved?: {
5561
- id: string;
5562
- name?: {
5563
- original: string;
5564
6165
  };
5565
- affectedLineItems: {
6166
+ discountRemoved?: {
5566
6167
  id: string;
5567
6168
  name?: {
5568
6169
  original: string;
5569
6170
  };
5570
- amount?: {
6171
+ affectedLineItems: {
6172
+ id: string;
6173
+ name?: {
6174
+ original: string;
6175
+ };
6176
+ amount?: {
6177
+ amount: string;
6178
+ formattedAmount: string;
6179
+ };
6180
+ }[];
6181
+ totalAmount?: {
5571
6182
  amount: string;
5572
6183
  formattedAmount: string;
5573
6184
  };
5574
- }[];
5575
- totalAmount?: {
5576
- amount: string;
5577
- formattedAmount: string;
5578
- };
5579
- };
5580
- additionalFeeAdded?: {
5581
- id: string;
5582
- name?: {
5583
- original: string;
5584
6185
  };
5585
- affectedLineItems: {
6186
+ additionalFeeAdded?: {
5586
6187
  id: string;
5587
6188
  name?: {
5588
6189
  original: string;
5589
6190
  };
5590
- amount?: {
6191
+ affectedLineItems: {
6192
+ id: string;
6193
+ name?: {
6194
+ original: string;
6195
+ };
6196
+ amount?: {
6197
+ amount: string;
6198
+ formattedAmount: string;
6199
+ };
6200
+ }[];
6201
+ totalAmount?: {
5591
6202
  amount: string;
5592
6203
  formattedAmount: string;
5593
6204
  };
5594
- }[];
5595
- totalAmount?: {
5596
- amount: string;
5597
- formattedAmount: string;
5598
- };
5599
- };
5600
- additionalFeeRemoved?: {
5601
- id: string;
5602
- name?: {
5603
- original: string;
5604
6205
  };
5605
- affectedLineItems: {
6206
+ additionalFeeRemoved?: {
5606
6207
  id: string;
5607
6208
  name?: {
5608
6209
  original: string;
5609
6210
  };
5610
- amount?: {
6211
+ affectedLineItems: {
6212
+ id: string;
6213
+ name?: {
6214
+ original: string;
6215
+ };
6216
+ amount?: {
6217
+ amount: string;
6218
+ formattedAmount: string;
6219
+ };
6220
+ }[];
6221
+ totalAmount?: {
5611
6222
  amount: string;
5612
6223
  formattedAmount: string;
5613
6224
  };
5614
- }[];
5615
- totalAmount?: {
5616
- amount: string;
5617
- formattedAmount: string;
5618
- };
5619
- };
5620
- totalPriceChanged?: {
5621
- originalTotal?: {
5622
- amount: string;
5623
- formattedAmount: string;
5624
6225
  };
5625
- newTotal?: {
5626
- amount: string;
5627
- formattedAmount: string;
6226
+ totalPriceChanged?: {
6227
+ originalTotal?: {
6228
+ amount: string;
6229
+ formattedAmount: string;
6230
+ };
6231
+ newTotal?: {
6232
+ amount: string;
6233
+ formattedAmount: string;
6234
+ };
5628
6235
  };
5629
- };
5630
- }[];
5631
- };
5632
- type: ActivityType;
5633
- }[];
5634
- attributionSource: AttributionSource;
5635
- createdBy?: {
5636
- userId: string;
5637
- memberId: string;
5638
- visitorId: string;
5639
- appId: string;
5640
- };
5641
- channelInfo?: {
5642
- type: ChannelType;
5643
- };
5644
- customFields: {
5645
- title: string;
5646
- }[];
5647
- isInternalOrderCreate: boolean;
5648
- payNow?: {
5649
- subtotal?: {
5650
- amount: string;
5651
- formattedAmount: string;
5652
- };
5653
- shipping?: {
5654
- amount: string;
5655
- formattedAmount: string;
5656
- };
5657
- tax?: {
5658
- amount: string;
5659
- formattedAmount: string;
5660
- };
5661
- discount?: {
5662
- amount: string;
5663
- formattedAmount: string;
5664
- };
5665
- totalPrice?: {
5666
- amount: string;
5667
- formattedAmount: string;
5668
- };
5669
- total?: {
5670
- amount: string;
5671
- formattedAmount: string;
5672
- };
5673
- totalWithGiftCard?: {
5674
- amount: string;
5675
- formattedAmount: string;
5676
- };
5677
- totalWithoutGiftCard?: {
5678
- amount: string;
5679
- formattedAmount: string;
5680
- };
5681
- totalAdditionalFees?: {
5682
- amount: string;
5683
- formattedAmount: string;
5684
- };
5685
- };
5686
- balanceSummary?: {
5687
- balance?: {
5688
- amount: string;
5689
- formattedAmount: string;
5690
- };
5691
- paid?: {
5692
- amount: string;
5693
- formattedAmount: string;
5694
- };
5695
- refunded?: {
5696
- amount: string;
5697
- formattedAmount: string;
6236
+ }[];
6237
+ };
6238
+ type: ActivityType;
6239
+ }[];
6240
+ attributionSource: AttributionSource;
6241
+ createdBy?: {
6242
+ userId: string;
6243
+ memberId: string;
6244
+ visitorId: string;
6245
+ appId: string;
5698
6246
  };
5699
- };
5700
- additionalFees: {
5701
- name: string;
5702
- price?: {
5703
- amount: string;
5704
- formattedAmount: string;
6247
+ channelInfo?: {
6248
+ type: ChannelType;
5705
6249
  };
5706
- taxDetails?: {
5707
- taxableAmount?: {
6250
+ customFields: {
6251
+ title: string;
6252
+ }[];
6253
+ isInternalOrderCreate: boolean;
6254
+ payNow?: {
6255
+ subtotal?: {
5708
6256
  amount: string;
5709
6257
  formattedAmount: string;
5710
6258
  };
5711
- taxRate: string;
5712
- totalTax?: {
6259
+ shipping?: {
6260
+ amount: string;
6261
+ formattedAmount: string;
6262
+ };
6263
+ tax?: {
6264
+ amount: string;
6265
+ formattedAmount: string;
6266
+ };
6267
+ discount?: {
6268
+ amount: string;
6269
+ formattedAmount: string;
6270
+ };
6271
+ totalPrice?: {
6272
+ amount: string;
6273
+ formattedAmount: string;
6274
+ };
6275
+ total?: {
6276
+ amount: string;
6277
+ formattedAmount: string;
6278
+ };
6279
+ totalWithGiftCard?: {
6280
+ amount: string;
6281
+ formattedAmount: string;
6282
+ };
6283
+ totalWithoutGiftCard?: {
6284
+ amount: string;
6285
+ formattedAmount: string;
6286
+ };
6287
+ totalAdditionalFees?: {
5713
6288
  amount: string;
5714
6289
  formattedAmount: string;
5715
6290
  };
5716
6291
  };
5717
- priceBeforeTax?: {
5718
- amount: string;
5719
- formattedAmount: string;
6292
+ balanceSummary?: {
6293
+ balance?: {
6294
+ amount: string;
6295
+ formattedAmount: string;
6296
+ };
6297
+ paid?: {
6298
+ amount: string;
6299
+ formattedAmount: string;
6300
+ };
6301
+ refunded?: {
6302
+ amount: string;
6303
+ formattedAmount: string;
6304
+ };
5720
6305
  };
5721
- id: string;
5722
- lineItemIds: string[];
5723
- }[];
5724
- recipientInfo?: {
5725
- address?: {
5726
- streetAddress?: {
5727
- number: string;
5728
- name: string;
5729
- apt: string;
6306
+ additionalFees: {
6307
+ name: string;
6308
+ price?: {
6309
+ amount: string;
6310
+ formattedAmount: string;
6311
+ };
6312
+ taxDetails?: {
6313
+ taxableAmount?: {
6314
+ amount: string;
6315
+ formattedAmount: string;
6316
+ };
6317
+ taxRate: string;
6318
+ totalTax?: {
6319
+ amount: string;
6320
+ formattedAmount: string;
6321
+ };
6322
+ };
6323
+ priceBeforeTax?: {
6324
+ amount: string;
6325
+ formattedAmount: string;
6326
+ };
6327
+ id: string;
6328
+ lineItemIds: string[];
6329
+ }[];
6330
+ recipientInfo?: {
6331
+ address?: {
6332
+ streetAddress?: {
6333
+ number: string;
6334
+ name: string;
6335
+ apt: string;
6336
+ };
6337
+ };
6338
+ contactDetails?: {
6339
+ vatId?: {
6340
+ id: string;
6341
+ type: VatType;
6342
+ };
5730
6343
  };
5731
6344
  };
5732
- contactDetails?: {
5733
- vatId?: {
5734
- id: string;
5735
- type: VatType;
6345
+ tags?: {
6346
+ privateTags?: {
6347
+ tagIds: string[];
6348
+ };
6349
+ tags?: {
6350
+ tagIds: string[];
5736
6351
  };
5737
6352
  };
5738
6353
  };
6354
+ }[];
6355
+ bulkActionMetadata?: {
6356
+ totalSuccesses: number;
6357
+ totalFailures: number;
6358
+ undetailedFailures: number;
5739
6359
  };
5740
6360
  }
5741
6361
  export interface CancelOrderResponseNonNullableFields {
@@ -6260,5 +6880,13 @@ export interface CancelOrderResponseNonNullableFields {
6260
6880
  };
6261
6881
  };
6262
6882
  };
6883
+ tags?: {
6884
+ privateTags?: {
6885
+ tagIds: string[];
6886
+ };
6887
+ tags?: {
6888
+ tagIds: string[];
6889
+ };
6890
+ };
6263
6891
  };
6264
6892
  }