@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
@@ -1,9 +1,3 @@
1
- export declare const __debug: {
2
- verboseLogging: {
3
- on: () => boolean;
4
- off: () => boolean;
5
- };
6
- };
7
1
  export interface Order {
8
2
  /**
9
3
  * Order ID.
@@ -126,6 +120,8 @@ export interface Order {
126
120
  * + No shipping option is selected.
127
121
  */
128
122
  recipientInfo?: AddressWithContact;
123
+ /** Tag ids collections associated with current entity. private_tags requires separate permissions to be accessible and modifiable. */
124
+ tags?: Tags;
129
125
  }
130
126
  export interface OrderLineItem {
131
127
  /** Line item ID. */
@@ -1075,6 +1071,38 @@ export interface ExtendedFields {
1075
1071
  */
1076
1072
  namespaces?: Record<string, Record<string, any>>;
1077
1073
  }
1074
+ /**
1075
+ * Common object for tags.
1076
+ * Should be use as in this example:
1077
+ * message Foo {
1078
+ * string id = 1;
1079
+ * ...
1080
+ * Tags tags = 5
1081
+ * }
1082
+ *
1083
+ * example of taggable entity
1084
+ * {
1085
+ * id: "123"
1086
+ * tags: {
1087
+ * tags: {
1088
+ * tag_ids:["11","22"]
1089
+ * },
1090
+ * private_tags: {
1091
+ * tag_ids: ["33", "44"]
1092
+ * }
1093
+ * }
1094
+ * }
1095
+ */
1096
+ export interface Tags {
1097
+ /** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
1098
+ privateTags?: TagList;
1099
+ /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
1100
+ tags?: TagList;
1101
+ }
1102
+ export interface TagList {
1103
+ /** List of tag IDs */
1104
+ tagIds?: string[];
1105
+ }
1078
1106
  export interface TriggerReindexWithConsistencyRequest {
1079
1107
  metasiteId?: string;
1080
1108
  orderId?: string;
@@ -1970,617 +1998,248 @@ export interface PreviewResendDownloadLinksEmailRequest {
1970
1998
  export interface PreviewResendDownloadLinksEmailResponse {
1971
1999
  emailPreview?: string;
1972
2000
  }
1973
- export interface InvoicePaidEvent {
1974
- _id?: IdAndVersion;
1975
- /** @readonly */
1976
- data?: InvoiceFields;
1977
- /** @readonly */
1978
- status?: InvoiceStatus;
1979
- }
1980
- export interface IdAndVersion {
1981
- _id?: string | null;
1982
- version?: number | null;
1983
- }
1984
- export interface InvoiceFields {
1985
- /** The invoice number allocated the invoice by the server. The number is limited to at most 11 digits. */
1986
- number?: string | null;
1987
- /** The invoice 3-letter currency code in [ISO-4217 alphabetic](https://www.iso.org/iso-4217-currency-codes.html) format. */
1988
- currencyCode?: string | null;
1989
- /** The invoice customer. The customer must be a contact of the site, with an email. */
1990
- customer?: Customer;
1991
- /**
1992
- * Invoice dates: issue date and due date are mandatory and provided when the invoice is created.
1993
- * Last seen date is the optional date when the invoice was last seen be UoU.
1994
- */
1995
- dates?: InvoiceDates;
1996
- /**
1997
- * Line items containing the details of the products or services relevant to the invoice, with their name, prices,
1998
- * and quantity. There must be at least one line item on the invoice.
1999
- */
2000
- lineItems?: LineItems;
2001
- /**
2002
- * Locale of the invoice, containing the language.
2003
- * This field is not mandatory but is used for display purposes, to determine the appearance of numbers and dates
2004
- * on the invoice.
2005
- */
2006
- locale?: Locale;
2007
- /**
2008
- * The totals on the invoice.
2009
- * The totals.subtotal, totals.total and totals.taxed_amount are calculated by the server based on the line items.
2010
- * Alternatively, these fields can be provided in the invoice creation request, in this case, these values are fixed.
2011
- * The totals contain fees and a discount, that apply to the invoice.
2012
- */
2013
- totals?: TotalPrice;
2014
- /** An optional discount on the invoice. */
2015
- discount?: Discount;
2016
- /** The taxes of the invoice. */
2017
- taxes?: CalculatedTaxes;
2018
- /** The payments on the invoice. The invoice has status paid if its payments cover the invoice total. */
2019
- payments?: Payments;
2020
- /** Invoice metadata */
2021
- metaData?: MetaData;
2022
- /** Not used */
2023
- creationAdditional_BIInformation?: string | null;
2001
+ export interface PreparePaymentCollectionRequest {
2002
+ /** Ecom order ID. */
2003
+ ecomOrderId?: string;
2004
+ /** Amount to collect */
2005
+ amount?: Price;
2024
2006
  /**
2025
- * The balance and amount paid on the invoice.
2026
- * This read-only field is calculated based on the invoice totals and payments.
2027
- * @readonly
2007
+ * Optional parameter. When present, payment collection will be performed using given payment gateway order.
2008
+ * Existing payment gateway order will be updated with a new amount.
2009
+ * When parameter is absent, new payment gateway order will be created and used for payment collection.
2028
2010
  */
2029
- dynamicTotals?: InvoiceDynamicPriceTotals;
2030
- /** The invoice title */
2031
- title?: string | null;
2032
- /** Invoice custom fields */
2033
- customFields?: CustomFieldValue[];
2034
- /** Not used */
2035
- designTemplateId?: string | null;
2036
- /** Not used */
2037
- createOrder?: boolean | null;
2038
- /** The optional deposit of the invoice */
2039
- deposit?: Deposit;
2040
- /** associated checkout for this invoice */
2041
- ecomCheckoutId?: string | null;
2042
- }
2043
- export interface Customer {
2044
- contactId?: string | null;
2045
- name?: string | null;
2046
- email?: Email;
2047
- address?: QuotesAddress;
2048
- phone?: Phone;
2049
- company?: Company;
2050
- firstName?: string | null;
2051
- lastName?: string | null;
2052
- billingAddress?: CommonAddress;
2053
- shippingAddress?: CommonAddress;
2011
+ paymentGatewayOrderId?: string | null;
2054
2012
  }
2055
- export interface Email {
2056
- address?: string;
2013
+ export interface PreparePaymentCollectionResponse {
2014
+ /** Payment gateway order id which is associated with given payment */
2015
+ paymentGatewayOrderId?: string;
2057
2016
  }
2058
- export interface QuotesAddress {
2059
- street?: string | null;
2060
- city?: string | null;
2061
- zip?: string | null;
2062
- state?: string | null;
2063
- country?: string | null;
2064
- /** @readonly */
2065
- description?: AddressDescription;
2017
+ export interface GetPaymentCollectabilityStatusRequest {
2018
+ /** Ecom order ID. */
2019
+ ecomOrderId?: string;
2066
2020
  }
2067
- export interface AddressDescription {
2068
- content?: string;
2069
- placement?: Placement;
2021
+ export interface GetPaymentCollectabilityStatusResponse {
2022
+ /** Payment collectability status */
2023
+ status?: PaymentCollectabilityStatus;
2024
+ /** Collectable order amount */
2025
+ amount?: Price;
2070
2026
  }
2071
- export declare enum Placement {
2072
- Unknown = "Unknown",
2073
- Replace = "Replace",
2074
- Before = "Before",
2075
- After = "After"
2027
+ export declare enum PaymentCollectabilityStatus {
2028
+ UNKNOWN = "UNKNOWN",
2029
+ COLLECTABLE = "COLLECTABLE",
2030
+ NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
2031
+ NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
2032
+ NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD"
2076
2033
  }
2077
- export interface Phone {
2078
- number?: string;
2034
+ export interface RecordManuallyCollectedPaymentRequest {
2035
+ /** Order ID. */
2036
+ orderId?: string;
2037
+ /** Amount to be recorded as approved manual payment for given order */
2038
+ amount?: Price;
2079
2039
  }
2080
- export interface Company {
2081
- name?: string;
2082
- _id?: string | null;
2040
+ export interface RecordManuallyCollectedPaymentResponse {
2083
2041
  }
2084
- /** Physical address */
2085
- export interface CommonAddress extends CommonAddressStreetOneOf {
2086
- /** Street name and number. */
2087
- streetAddress?: StreetAddress;
2088
- /** Main address line, usually street and number as free text. */
2089
- addressLine1?: string | null;
2090
- /** Country code. */
2091
- country?: string | null;
2092
- /** Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
2093
- subdivision?: string | null;
2094
- /** City name. */
2095
- city?: string | null;
2096
- /** Zip/postal code. */
2097
- postalCode?: string | null;
2098
- /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
2099
- addressLine2?: string | null;
2042
+ export interface V1MarkOrderAsPaidRequest {
2043
+ /** Ecom order ID. */
2044
+ ecomOrderId?: string;
2100
2045
  }
2101
- /** @oneof */
2102
- export interface CommonAddressStreetOneOf {
2103
- /** Street name and number. */
2104
- streetAddress?: StreetAddress;
2105
- /** Main address line, usually street and number as free text. */
2106
- addressLine?: string | null;
2046
+ export interface V1MarkOrderAsPaidResponse {
2047
+ /** Updated order. */
2048
+ order?: Order;
2107
2049
  }
2108
- export interface Subdivision {
2109
- /** Short subdivision code. */
2110
- code?: string;
2111
- /** Subdivision full name. */
2112
- name?: string;
2050
+ /** Triggered when the payment status of an order is updated */
2051
+ export interface PaymentStatusUpdated {
2052
+ /** The order that was updated */
2053
+ order?: Order;
2054
+ /** The previous status (before the update) */
2055
+ previousPaymentStatus?: PaymentStatus;
2113
2056
  }
2114
- export declare enum SubdivisionType {
2115
- UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
2116
- /** State */
2117
- ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
2118
- /** County */
2119
- ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
2120
- /** City/town */
2121
- ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
2122
- /** Neighborhood/quarter */
2123
- ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
2124
- /** Street/block */
2125
- ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
2126
- /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
2127
- COUNTRY = "COUNTRY"
2057
+ export interface V1BulkMarkOrdersAsPaidRequest {
2058
+ /** IDs of orders to mark as paid. */
2059
+ ecomOrderIds?: string[];
2128
2060
  }
2129
- export interface InvoiceDates {
2130
- /** use UTC midnight date to set the issue date according to the site time zone */
2131
- issueDate?: Date;
2132
- /** use UTC midnight date to set the due date according to the site time zone */
2133
- dueDate?: Date;
2134
- /** <a href="http://joda-time.sourceforge.net/timezones.html">Valid time zones</a> */
2135
- timeZoneCode?: string | null;
2061
+ export interface V1BulkMarkOrdersAsPaidResponse {
2136
2062
  /**
2137
- * ignored in request use in response to get the site time zone
2138
- * @readonly
2063
+ * Items updated by the bulk action.
2064
+ * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
2139
2065
  */
2140
- lastSeenDate?: Date;
2141
- }
2142
- export interface LineItems {
2143
- lineItems?: LineItem[];
2066
+ results?: BulkOrderResult[];
2067
+ /** Bulk action metadata. */
2068
+ bulkActionMetadata?: BulkActionMetadata;
2144
2069
  }
2145
- export interface LineItem {
2146
- _id?: string;
2147
- name?: string;
2148
- description?: string | null;
2149
- price?: BigDecimalWrapper;
2150
- taxedTotal?: BigDecimalWrapper;
2151
- quantity?: BigDecimalWrapper;
2152
- taxes?: LineItemTax[];
2153
- /** The source of the line item */
2154
- source?: Source;
2155
- /** The line-item level metadata. */
2156
- metadata?: LineItemMetaData;
2070
+ export interface BulkOrderResult {
2071
+ /** Item metadata. */
2072
+ itemMetadata?: ItemMetadata;
2073
+ /** Updated item. Optional - returned only if requested with `return_full_entity` set to `true`. */
2074
+ item?: Order;
2157
2075
  }
2158
- export interface BigDecimalWrapper {
2159
- serializedValue?: number;
2076
+ export interface ItemMetadata {
2077
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
2078
+ _id?: string | null;
2079
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
2080
+ originalIndex?: number;
2081
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
2082
+ success?: boolean;
2083
+ /** Details about the error in case of failure. */
2084
+ error?: ApplicationError;
2160
2085
  }
2161
- export interface LineItemTax {
2162
- name?: string;
2163
- rate?: BigDecimalWrapper;
2164
- code?: string | null;
2086
+ export interface ApplicationError {
2087
+ /** Error code. */
2088
+ code?: string;
2089
+ /** Description of the error. */
2090
+ description?: string;
2091
+ /** Data related to the error. */
2092
+ data?: Record<string, any> | null;
2165
2093
  }
2166
- export interface Source {
2167
- /**
2168
- * Source app or service ID.
2169
- * @readonly
2170
- */
2171
- sourceId?: string;
2172
- /**
2173
- * App or service type.
2174
- * @readonly
2175
- */
2176
- sourceType?: SourceType;
2094
+ export interface BulkActionMetadata {
2095
+ /** Number of items that were successfully processed. */
2096
+ totalSuccesses?: number;
2097
+ /** Number of items that couldn't be processed. */
2098
+ totalFailures?: number;
2099
+ /** Number of failures without details because detailed failure threshold was exceeded. */
2100
+ undetailedFailures?: number;
2177
2101
  }
2178
- export declare enum SourceType {
2179
- UNKNOWN_SOURCE_TYPE = "UNKNOWN_SOURCE_TYPE",
2180
- WIX_APP = "WIX_APP",
2181
- EXTERNAL = "EXTERNAL",
2182
- ADMIN = "ADMIN",
2183
- OTHER = "OTHER"
2102
+ export interface GetRefundabilityStatusRequest {
2103
+ /** Order ID. */
2104
+ ecomOrderId?: string;
2184
2105
  }
2185
- export interface LineItemMetaData {
2186
- metadata?: Record<string, string>;
2106
+ export interface GetRefundabilityStatusResponse {
2107
+ /** Refundability details. */
2108
+ refundabilities?: Refundability[];
2109
+ /** Whether the order supports refunding per item. */
2110
+ refundablePerItem?: boolean;
2187
2111
  }
2188
- export interface Locale {
2189
- /** ISO 639 alpha-2 or alpha-3 language code, or a language subtag */
2190
- language?: string;
2191
- /** An ISO 3166 alpha-2 country code or a UN M.49 numeric-3 area code. */
2192
- country?: string | null;
2193
- invariant?: string | null;
2112
+ export interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
2113
+ /** Reason why payment is not refundable. */
2114
+ nonRefundableReason?: NonRefundableReason;
2115
+ /** Reason why payment is only refundable manually. */
2116
+ manuallyRefundableReason?: ManuallyRefundableReason;
2117
+ /** Payment ID. */
2118
+ paymentId?: string;
2119
+ /** Payment refundability status. */
2120
+ refundabilityStatus?: RefundableStatus;
2121
+ /** Link to payment provider dashboard. */
2122
+ providerLink?: string | null;
2194
2123
  }
2195
- export interface TotalPrice {
2196
- /** the subtotal of the line items without the tax reduction */
2197
- subtotal?: BigDecimalWrapper;
2198
- /** the total price taking into account the itemized fees and the taxes */
2199
- total?: BigDecimalWrapper;
2200
- fees?: ItemizedFee[];
2201
- discountAmount?: BigDecimalWrapper;
2202
- taxedAmount?: BigDecimalWrapper;
2124
+ /** @oneof */
2125
+ export interface RefundabilityAdditionalRefundabilityInfoOneOf {
2126
+ /** Reason why payment is not refundable. */
2127
+ nonRefundableReason?: NonRefundableReason;
2128
+ /** Reason why payment is only refundable manually. */
2129
+ manuallyRefundableReason?: ManuallyRefundableReason;
2203
2130
  }
2204
- export interface ItemizedFee {
2205
- name?: string;
2206
- price?: BigDecimalWrapper;
2131
+ export declare enum RefundableStatus {
2132
+ NOT_REFUNDABLE = "NOT_REFUNDABLE",
2133
+ MANUAL = "MANUAL",
2134
+ REFUNDABLE = "REFUNDABLE"
2207
2135
  }
2208
- export interface Discount extends DiscountOneDiscountTypeOneOf {
2209
- /** Discount as percentage value. */
2210
- percentage?: BigDecimalWrapper;
2136
+ export declare enum NonRefundableReason {
2137
+ NONE = "NONE",
2138
+ ALREADY_REFUNDED = "ALREADY_REFUNDED",
2139
+ PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
2140
+ INTERNAL_ERROR = "INTERNAL_ERROR",
2141
+ NOT_PAID = "NOT_PAID",
2142
+ ACCESS_DENIED = "ACCESS_DENIED",
2143
+ ZERO_PRICE = "ZERO_PRICE",
2144
+ DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
2145
+ PENDING_REFUND = "PENDING_REFUND",
2146
+ FORBIDDEN = "FORBIDDEN",
2147
+ TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND"
2211
2148
  }
2212
- /** @oneof */
2213
- export interface DiscountOneDiscountTypeOneOf {
2214
- /** Discount as percentage value. */
2215
- percentage?: BigDecimalWrapper;
2149
+ export declare enum ManuallyRefundableReason {
2150
+ EXPIRED = "EXPIRED",
2151
+ NOT_SUPPORTED = "NOT_SUPPORTED",
2152
+ OFFLINE = "OFFLINE"
2216
2153
  }
2217
- export interface CalculatedTaxes {
2218
- /** consider calculated or not - cannot enforce set */
2219
- taxes?: CalculatedTax[];
2154
+ export interface V1CreatePaymentGatewayOrderRequest {
2155
+ /** Ecom order ID. */
2156
+ ecomOrderId?: string;
2157
+ /** Information about the user who initiated the payment. */
2158
+ chargedBy?: ChargedBy;
2220
2159
  }
2221
- export interface CalculatedTax {
2222
- name?: string;
2223
- rate?: BigDecimalWrapper;
2224
- /** the costs on which the taxes are applied */
2225
- taxable?: BigDecimalWrapper;
2226
- /** the taxes as a result of the */
2227
- taxed?: BigDecimalWrapper;
2228
- code?: string | null;
2160
+ export interface ChargedBy {
2161
+ /** ID - id of the user who initiated the payment */
2162
+ _id?: string;
2163
+ /** Full name - name of the user who initiated the payment */
2164
+ fullName?: string | null;
2229
2165
  }
2230
- export interface Payments {
2231
- payments?: Payment[];
2166
+ export interface V1CreatePaymentGatewayOrderResponse {
2167
+ /** ID of the order created in the payment gateway */
2168
+ paymentGatewayOrderId?: string;
2232
2169
  }
2233
- export interface Payment {
2234
- /** document */
2235
- _id?: string;
2236
- type?: string;
2237
- amount?: BigDecimalWrapper;
2238
- date?: Date;
2170
+ export interface ChargeMembershipsRequest {
2171
+ /** Order ID. */
2172
+ ecomOrderId?: string;
2239
2173
  /**
2240
- * The orderId of the order in cashier associated with the payment.
2241
- * This field is populated for external payments that are charged by invoices via AddPayment endpoint.
2174
+ * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
2175
+ * but a user which is using the membership on behalf of the a member
2242
2176
  */
2243
- orderId?: string | null;
2177
+ memberId?: string;
2178
+ /** List of items to be paid by memberships */
2179
+ membershipCharges?: MembershipChargeItem[];
2180
+ }
2181
+ export interface MembershipChargeItem {
2182
+ /** The id of used membership */
2183
+ membershipId?: string;
2184
+ /** ID of the application providing this payment option */
2185
+ appId?: string;
2186
+ /** The name of used membership */
2187
+ membershipName?: MembershipName;
2188
+ /** Additional data about this membership */
2189
+ membershipAdditionalData?: Record<string, any> | null;
2190
+ /** Catalog and item reference info. */
2191
+ catalogReference?: CatalogReference;
2192
+ /** Properties of the service. When relevant, contains information such as date and number of participants. */
2193
+ serviceProperties?: ServiceProperties;
2244
2194
  /**
2245
- * The transactionId corresponding to the orderId of the payment which are returned by cashier.
2246
- * This field is populated for external payments that are charged by invoices via AddPayment endpoint as well.
2195
+ * Usually would be the same as catalogReference.catalogItemId
2196
+ * For cases when these are not the same, this field would return the actual id of the item in the catalog
2197
+ * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
2247
2198
  */
2248
- transactionId?: string | null;
2249
- }
2250
- export interface MetaData {
2251
- notes?: string | null;
2252
- legalTerms?: string | null;
2253
- sourceUrl?: string | null;
2254
- sourceProperties?: Record<string, string>;
2255
- source?: string | null;
2256
- sourceRefId?: string | null;
2257
- /** Optional indicator whether to allow editing of the invoice by other applications other than the source. Default is true. */
2258
- allowEditByOthers?: boolean | null;
2259
- }
2260
- export interface InvoiceDynamicPriceTotals {
2261
- paidAmount?: BigDecimalWrapper;
2262
- balance?: BigDecimalWrapper;
2199
+ rootCatalogItemId?: string | null;
2200
+ /** line item id of Checkout/Order line item */
2201
+ lineItemId?: string;
2263
2202
  }
2264
- /**
2265
- * A custom field value is used to add additional data to a financial document or to a financial document template.
2266
- * The custom field value may be based on a custom field definition.
2267
- */
2268
- export interface CustomFieldValue {
2203
+ export interface ServiceProperties {
2269
2204
  /**
2270
- * The unique id of the custom field value
2271
- * @readonly
2205
+ * 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.
2206
+ * For example, the start time of a class.
2272
2207
  */
2273
- _id?: string | null;
2274
- /** The display name of the custom field value */
2275
- displayName?: string;
2276
- /** The optional namespace of the custom field value. This field may be used to indicate intended usage or source. */
2277
- namespace?: string | null;
2278
- /** The group of the custom field indicates its intended placement in the financial document */
2279
- group?: CustomFieldGroup;
2280
- /** The value of the custom field */
2281
- value?: Value;
2282
- /** The optional key of the custom field definition on which the custom field value is based */
2283
- originCustomFieldKey?: string | null;
2284
- }
2285
- export declare enum CustomFieldGroup {
2286
- UNKNOWN_CUSTOM_FIELD_GROUP = "UNKNOWN_CUSTOM_FIELD_GROUP",
2287
- BUSINESS_DETAILS = "BUSINESS_DETAILS",
2288
- CUSTOMER_DETAILS = "CUSTOMER_DETAILS",
2289
- DOCUMENT = "DOCUMENT",
2290
- FOOTER = "FOOTER",
2291
- OTHER = "OTHER"
2208
+ scheduledDate?: Date;
2209
+ /** 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. */
2210
+ numberOfParticipants?: number | null;
2292
2211
  }
2293
- export interface Value {
2294
- value?: string;
2295
- valueType?: ValueType;
2212
+ export interface ChargeMembershipsResponse {
2296
2213
  }
2297
- export declare enum ValueType {
2298
- UNKNOWN_VALUE_TYPE = "UNKNOWN_VALUE_TYPE",
2299
- STRING = "STRING",
2300
- DATE = "DATE",
2301
- BOOLEAN = "BOOLEAN",
2302
- NUMBER = "NUMBER"
2214
+ export interface TriggerRefundRequest {
2215
+ /** The order this refund related to */
2216
+ ecomOrderId?: string;
2217
+ /** Refund operations information */
2218
+ payments?: PaymentRefund[];
2219
+ /** Business model of a refund */
2220
+ details?: RefundDetails;
2221
+ /** Side effect details related to refund */
2222
+ sideEffects?: RefundSideEffects;
2303
2223
  }
2304
- export interface Deposit {
2305
- /** The flat amount of the deposit. The flat amount of the deposit must be less than the invoice total. */
2306
- flatAmount?: string;
2224
+ export interface PaymentRefund {
2225
+ /** Specific payment within the order to refund */
2226
+ paymentId?: string;
2227
+ /** Refund amount. Not relevant for membership refunds. */
2228
+ amount?: Price;
2307
2229
  /**
2308
- * The read-only percentage value of the deposit.
2309
- * It is computed according to the flat_amount and the invoice total and is rounded to 2 digits precision.
2310
- * @readonly
2230
+ * Whether refund is made externally and manually (on the payment provider's side)
2231
+ * 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.
2232
+ * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
2311
2233
  */
2312
- percentage?: string;
2313
- /** The type of the deposit. The default is FLAT. */
2314
- type?: DepositType;
2234
+ externalRefund?: boolean;
2315
2235
  }
2316
- export declare enum DepositType {
2317
- UNKNOWN = "UNKNOWN",
2318
- FLAT = "FLAT",
2319
- PERCENTAGE = "PERCENTAGE"
2320
- }
2321
- /**
2322
- * InvoiceStatus allowed transitions based on current status:
2323
- * Draft -> Deleted, Paid, Partially Paid, Sent
2324
- * Sent -> Draft, Deleted, Void, Paid, Partially Paid, Processing, (Overdue)
2325
- * Processing -> PartiallyPaid, Paid, Sent
2326
- * Paid -> Void
2327
- * PartiallyPaid -> Void, (PartialAndOverdue)
2328
- * Void -> Deleted
2329
- * Deleted
2330
- */
2331
- export declare enum InvoiceStatus {
2332
- Draft = "Draft",
2333
- Sent = "Sent",
2334
- Processing = "Processing",
2335
- Paid = "Paid",
2336
- Overdue = "Overdue",
2337
- Void = "Void",
2338
- Deleted = "Deleted",
2339
- PartiallyPaid = "PartiallyPaid",
2340
- PartialAndOverdue = "PartialAndOverdue"
2341
- }
2342
- export interface PreparePaymentCollectionRequest {
2343
- /** Ecom order ID. */
2344
- ecomOrderId?: string;
2345
- /** Amount to collect */
2346
- amount?: Price;
2347
- /**
2348
- * Optional parameter. When present, payment collection will be performed using given payment gateway order.
2349
- * Existing payment gateway order will be updated with a new amount.
2350
- * When parameter is absent, new payment gateway order will be created and used for payment collection.
2351
- */
2352
- paymentGatewayOrderId?: string | null;
2353
- }
2354
- export interface PreparePaymentCollectionResponse {
2355
- /** Payment gateway order id which is associated with given payment */
2356
- paymentGatewayOrderId?: string;
2357
- }
2358
- export interface GetPaymentCollectabilityStatusRequest {
2359
- /** Ecom order ID. */
2360
- ecomOrderId?: string;
2361
- }
2362
- export interface GetPaymentCollectabilityStatusResponse {
2363
- /** Payment collectability status */
2364
- status?: PaymentCollectabilityStatus;
2365
- /** Collectable order amount */
2366
- amount?: Price;
2367
- }
2368
- export declare enum PaymentCollectabilityStatus {
2369
- UNKNOWN = "UNKNOWN",
2370
- COLLECTABLE = "COLLECTABLE",
2371
- NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
2372
- NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
2373
- NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD"
2374
- }
2375
- export interface RecordManuallyCollectedPaymentRequest {
2376
- /** Order ID. */
2377
- orderId?: string;
2378
- /** Amount to be recorded as approved manual payment for given order */
2379
- amount?: Price;
2380
- }
2381
- export interface RecordManuallyCollectedPaymentResponse {
2382
- }
2383
- export interface V1MarkOrderAsPaidRequest {
2384
- /** Ecom order ID. */
2385
- ecomOrderId?: string;
2386
- }
2387
- export interface V1MarkOrderAsPaidResponse {
2388
- /** Updated order. */
2389
- order?: Order;
2390
- }
2391
- /** Triggered when the payment status of an order is updated */
2392
- export interface PaymentStatusUpdated {
2393
- /** The order that was updated */
2394
- order?: Order;
2395
- /** The previous status (before the update) */
2396
- previousPaymentStatus?: PaymentStatus;
2397
- }
2398
- export interface V1BulkMarkOrdersAsPaidRequest {
2399
- /** IDs of orders to mark as paid. */
2400
- ecomOrderIds?: string[];
2401
- }
2402
- export interface V1BulkMarkOrdersAsPaidResponse {
2403
- /**
2404
- * Items updated by the bulk action.
2405
- * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
2406
- */
2407
- results?: BulkOrderResult[];
2408
- /** Bulk action metadata. */
2409
- bulkActionMetadata?: BulkActionMetadata;
2410
- }
2411
- export interface BulkOrderResult {
2412
- /** Item metadata. */
2413
- itemMetadata?: ItemMetadata;
2414
- /** Updated item. Optional - returned only if requested with `return_full_entity` set to `true`. */
2415
- item?: Order;
2416
- }
2417
- export interface ItemMetadata {
2418
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
2419
- _id?: string | null;
2420
- /** Index of the item within the request array. Allows for correlation between request and response items. */
2421
- originalIndex?: number;
2422
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
2423
- success?: boolean;
2424
- /** Details about the error in case of failure. */
2425
- error?: ApplicationError;
2426
- }
2427
- export interface ApplicationError {
2428
- /** Error code. */
2429
- code?: string;
2430
- /** Description of the error. */
2431
- description?: string;
2432
- /** Data related to the error. */
2433
- data?: Record<string, any> | null;
2434
- }
2435
- export interface BulkActionMetadata {
2436
- /** Number of items that were successfully processed. */
2437
- totalSuccesses?: number;
2438
- /** Number of items that couldn't be processed. */
2439
- totalFailures?: number;
2440
- /** Number of failures without details because detailed failure threshold was exceeded. */
2441
- undetailedFailures?: number;
2442
- }
2443
- export interface GetRefundabilityStatusRequest {
2444
- /** Order ID. */
2445
- ecomOrderId?: string;
2446
- }
2447
- export interface GetRefundabilityStatusResponse {
2448
- /** Refundability details. */
2449
- refundabilities?: Refundability[];
2450
- /** Whether the order supports refunding per item. */
2451
- refundablePerItem?: boolean;
2452
- }
2453
- export interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
2454
- /** Reason why payment is not refundable. */
2455
- nonRefundableReason?: NonRefundableReason;
2456
- /** Reason why payment is only refundable manually. */
2457
- manuallyRefundableReason?: ManuallyRefundableReason;
2458
- /** Payment ID. */
2459
- paymentId?: string;
2460
- /** Payment refundability status. */
2461
- refundabilityStatus?: RefundableStatus;
2462
- /** Link to payment provider dashboard. */
2463
- providerLink?: string | null;
2464
- }
2465
- /** @oneof */
2466
- export interface RefundabilityAdditionalRefundabilityInfoOneOf {
2467
- /** Reason why payment is not refundable. */
2468
- nonRefundableReason?: NonRefundableReason;
2469
- /** Reason why payment is only refundable manually. */
2470
- manuallyRefundableReason?: ManuallyRefundableReason;
2471
- }
2472
- export declare enum RefundableStatus {
2473
- NOT_REFUNDABLE = "NOT_REFUNDABLE",
2474
- MANUAL = "MANUAL",
2475
- REFUNDABLE = "REFUNDABLE"
2476
- }
2477
- export declare enum NonRefundableReason {
2478
- NONE = "NONE",
2479
- ALREADY_REFUNDED = "ALREADY_REFUNDED",
2480
- PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
2481
- INTERNAL_ERROR = "INTERNAL_ERROR",
2482
- NOT_PAID = "NOT_PAID",
2483
- ACCESS_DENIED = "ACCESS_DENIED",
2484
- ZERO_PRICE = "ZERO_PRICE",
2485
- DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
2486
- PENDING_REFUND = "PENDING_REFUND",
2487
- FORBIDDEN = "FORBIDDEN",
2488
- TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND"
2489
- }
2490
- export declare enum ManuallyRefundableReason {
2491
- EXPIRED = "EXPIRED",
2492
- NOT_SUPPORTED = "NOT_SUPPORTED",
2493
- OFFLINE = "OFFLINE"
2494
- }
2495
- export interface V1CreatePaymentGatewayOrderRequest {
2496
- /** Ecom order ID. */
2497
- ecomOrderId?: string;
2498
- /** Information about the user who initiated the payment. */
2499
- chargedBy?: ChargedBy;
2500
- }
2501
- export interface ChargedBy {
2502
- /** ID - id of the user who initiated the payment */
2503
- _id?: string;
2504
- /** Full name - name of the user who initiated the payment */
2505
- fullName?: string | null;
2506
- }
2507
- export interface V1CreatePaymentGatewayOrderResponse {
2508
- /** ID of the order created in the payment gateway */
2509
- paymentGatewayOrderId?: string;
2510
- }
2511
- export interface ChargeMembershipsRequest {
2512
- /** Order ID. */
2513
- ecomOrderId?: string;
2514
- /**
2515
- * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
2516
- * but a user which is using the membership on behalf of the a member
2517
- */
2518
- memberId?: string;
2519
- /** List of items to be paid by memberships */
2520
- membershipCharges?: MembershipChargeItem[];
2521
- }
2522
- export interface MembershipChargeItem {
2523
- /** The id of used membership */
2524
- membershipId?: string;
2525
- /** ID of the application providing this payment option */
2526
- appId?: string;
2527
- /** The name of used membership */
2528
- membershipName?: MembershipName;
2529
- /** Additional data about this membership */
2530
- membershipAdditionalData?: Record<string, any> | null;
2531
- /** Catalog and item reference info. */
2532
- catalogReference?: CatalogReference;
2533
- /** Properties of the service. When relevant, contains information such as date and number of participants. */
2534
- serviceProperties?: ServiceProperties;
2535
- /**
2536
- * Usually would be the same as catalogReference.catalogItemId
2537
- * For cases when these are not the same, this field would return the actual id of the item in the catalog
2538
- * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
2539
- */
2540
- rootCatalogItemId?: string | null;
2541
- /** line item id of Checkout/Order line item */
2542
- lineItemId?: string;
2543
- }
2544
- export interface ServiceProperties {
2545
- /**
2546
- * 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.
2547
- * For example, the start time of a class.
2548
- */
2549
- scheduledDate?: Date;
2550
- /** 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. */
2551
- numberOfParticipants?: number | null;
2552
- }
2553
- export interface ChargeMembershipsResponse {
2554
- }
2555
- export interface TriggerRefundRequest {
2556
- /** The order this refund related to */
2557
- ecomOrderId?: string;
2558
- /** Refund operations information */
2559
- payments?: PaymentRefund[];
2560
- /** Business model of a refund */
2561
- details?: RefundDetails;
2562
- /** Side effect details related to refund */
2563
- sideEffects?: RefundSideEffects;
2564
- }
2565
- export interface PaymentRefund {
2566
- /** Specific payment within the order to refund */
2567
- paymentId?: string;
2568
- /** Refund amount. Not relevant for membership refunds. */
2569
- amount?: Price;
2570
- /**
2571
- * Whether refund is made externally and manually (on the payment provider's side)
2572
- * 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.
2573
- * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
2574
- */
2575
- externalRefund?: boolean;
2576
- }
2577
- export interface RefundSideEffects {
2578
- /** Inventory restock details as part of this refund. */
2579
- restockInfo?: RestockInfo;
2580
- /** Whether to send a refund confirmation email to the customer. */
2581
- sendOrderRefundedEmail?: boolean;
2582
- /** Custom message added to the refund confirmation email. */
2583
- customMessage?: string | null;
2236
+ export interface RefundSideEffects {
2237
+ /** Inventory restock details as part of this refund. */
2238
+ restockInfo?: RestockInfo;
2239
+ /** Whether to send a refund confirmation email to the customer. */
2240
+ sendOrderRefundedEmail?: boolean;
2241
+ /** Custom message added to the refund confirmation email. */
2242
+ customMessage?: string | null;
2584
2243
  }
2585
2244
  export interface RestockInfo {
2586
2245
  /** Restock type. */
@@ -2769,6 +2428,20 @@ export interface UpdateOrderResponse {
2769
2428
  /** Newly created order. */
2770
2429
  order?: Order;
2771
2430
  }
2431
+ export interface BulkUpdateOrderRequest {
2432
+ /** Orders to be updated. */
2433
+ orders: MaskedOrder[];
2434
+ /** Set to `true` if you wish to receive back the updated orders in the response */
2435
+ returnEntity?: boolean;
2436
+ }
2437
+ export interface MaskedOrder {
2438
+ /** Order to be updated. */
2439
+ order?: Order;
2440
+ }
2441
+ export interface BulkUpdateOrderResponse {
2442
+ results?: BulkOrderResult[];
2443
+ bulkActionMetadata?: BulkActionMetadata;
2444
+ }
2772
2445
  export interface CommitDeltasRequest {
2773
2446
  /** Order id to be updated */
2774
2447
  _id?: string;
@@ -3329,282 +3002,644 @@ export interface PublicActivityContentOneOf {
3329
3002
  /** Merchant commment. */
3330
3003
  merchantComment?: MerchantComment;
3331
3004
  }
3332
- export interface AddActivityResponse {
3333
- /** Updated order. */
3005
+ export interface AddActivityResponse {
3006
+ /** Updated order. */
3007
+ order?: Order;
3008
+ /**
3009
+ * ID of the added activity.
3010
+ * Use this ID to either [update](https://bo.wix.com/wix-docs/rest/ecommerce/orders/update-activity) or [delete](https://bo.wix.com/wix-docs/rest/ecommerce/orders/delete-activity) the activity.
3011
+ */
3012
+ activityId?: string;
3013
+ }
3014
+ export interface UpdateActivityRequest {
3015
+ /** Order ID. */
3016
+ _id?: string;
3017
+ /** ID of the activity to update. */
3018
+ activityId?: string;
3019
+ /** Activity info. */
3020
+ activity?: PublicActivity;
3021
+ }
3022
+ export interface UpdateActivityResponse {
3023
+ /** Updated order. */
3024
+ order?: Order;
3025
+ }
3026
+ export interface DeleteActivityRequest {
3027
+ /** Order ID. */
3028
+ _id?: string;
3029
+ /** ID of the activity to delete. */
3030
+ activityId?: string;
3031
+ }
3032
+ export interface DeleteActivityResponse {
3033
+ /** Updated order. */
3034
+ order?: Order;
3035
+ }
3036
+ export interface UpdateLineItemsDescriptionLinesRequest {
3037
+ /** Order ID. */
3038
+ _id?: string;
3039
+ /** Line items. */
3040
+ lineItems?: LineItemUpdate[];
3041
+ }
3042
+ export interface LineItemUpdate {
3043
+ /** Line item ID. */
3044
+ lineItemId?: string;
3045
+ /**
3046
+ * Description lines' info.
3047
+ * If description line already exists for this name, it will be replaced.
3048
+ */
3049
+ descriptionLines?: DescriptionLine[];
3050
+ }
3051
+ export interface UpdateLineItemsDescriptionLinesResponse {
3052
+ /** Updated order. */
3053
+ order?: Order;
3054
+ }
3055
+ export interface MarkOrderAsSeenByHumanRequest {
3056
+ /** Order ID. */
3057
+ _id?: string;
3058
+ }
3059
+ export interface MarkOrderAsSeenByHumanResponse {
3060
+ /** Updated order. */
3061
+ order?: Order;
3062
+ }
3063
+ export interface CancelOrderRequest {
3064
+ /** Order ID. */
3065
+ _id: string;
3066
+ /** Whether to send an order canceled email to the buyer. */
3067
+ sendOrderCanceledEmail?: boolean;
3068
+ /** Custom note to be added to the email (optional). */
3069
+ customMessage?: string | null;
3070
+ /** Whether to restock all items in the order. This will only apply to products in the Wix Stores inventory. */
3071
+ restockAllItems?: boolean;
3072
+ }
3073
+ export interface CancelOrderResponse {
3074
+ /** Canceled order. */
3075
+ order?: Order;
3076
+ }
3077
+ export interface OrderCanceledEventOrderCanceled {
3078
+ /** The order that was cancelled */
3079
+ order?: Order;
3080
+ /** Should restock all items on that order */
3081
+ restockAllItems?: boolean;
3082
+ /** Should send a confirmation mail to the customer */
3083
+ sendOrderCanceledEmail?: boolean;
3084
+ /** Personal note added to the email */
3085
+ customMessage?: string | null;
3086
+ }
3087
+ export interface MarkAsFulfilledRequest {
3088
+ /** Order ID. */
3089
+ _id?: string;
3090
+ }
3091
+ export interface MarkAsFulfilledResponse {
3092
+ /** Updated order. */
3093
+ order?: Order;
3094
+ }
3095
+ /** Triggered when the fulfillment status of an order is updated */
3096
+ export interface FulfillmentStatusUpdated {
3097
+ /** The order that was updated */
3098
+ order?: Order;
3099
+ /** The previous status (before the update) */
3100
+ previousFulfillmentStatus?: FulfillmentStatus;
3101
+ /** the new status (after the update) */
3102
+ newFulfillmentStatus?: FulfillmentStatus;
3103
+ /** the action that caused this update */
3104
+ action?: string;
3105
+ }
3106
+ export interface BulkMarkAsFulfilledRequest {
3107
+ /** IDs of orders to be marked as fulfilled. */
3108
+ ids?: string[];
3109
+ /** Whether to return the full updated order entities in the response. */
3110
+ returnFullEntity?: boolean;
3111
+ }
3112
+ export interface BulkMarkAsFulfilledResponse {
3113
+ /** Items updated by bulk action. */
3114
+ results?: BulkOrderResult[];
3115
+ /** Bulk action metadata. */
3116
+ bulkActionMetadata?: BulkActionMetadata;
3117
+ }
3118
+ export interface BulkMarkAsFulfilledByFilterRequest {
3119
+ /** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/ecommerce/orders/filter-and-sort). */
3120
+ filter?: Record<string, any> | null;
3121
+ }
3122
+ export interface BulkMarkAsFulfilledByFilterResponse {
3123
+ /** Items updated by bulk action. */
3124
+ results?: BulkOrderResult[];
3125
+ /** Bulk action metadata. */
3126
+ bulkActionMetadata?: BulkActionMetadata;
3127
+ }
3128
+ export interface MarkAsUnfulfilledRequest {
3129
+ /** Order ID. */
3130
+ _id?: string;
3131
+ }
3132
+ export interface MarkAsUnfulfilledResponse {
3133
+ /** Updated order. */
3134
+ order?: Order;
3135
+ }
3136
+ export interface BulkMarkAsUnfulfilledRequest {
3137
+ /** IDs of orders to be marked as not fulfilled. */
3138
+ ids?: string[];
3139
+ /** Whether to return the full updated order entities in the response. */
3140
+ returnFullEntity?: boolean;
3141
+ }
3142
+ export interface BulkMarkAsUnfulfilledResponse {
3143
+ /** Items updated by bulk action. */
3144
+ results?: BulkOrderResult[];
3145
+ /** Bulk action metadata. */
3146
+ bulkActionMetadata?: BulkActionMetadata;
3147
+ }
3148
+ export interface BulkMarkAsUnfulfilledByFilterRequest {
3149
+ /** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/ecommerce/orders/filter-and-sort). */
3150
+ filter?: Record<string, any> | null;
3151
+ }
3152
+ export interface BulkMarkAsUnfulfilledByFilterResponse {
3153
+ /** Items updated by bulk action. */
3154
+ results?: BulkOrderResult[];
3155
+ /** Bulk action metadata. */
3156
+ bulkActionMetadata?: BulkActionMetadata;
3157
+ }
3158
+ export interface MarkOrderAsPaidRequest {
3159
+ /** Order ID. */
3160
+ _id?: string;
3161
+ }
3162
+ export interface MarkOrderAsPaidResponse {
3163
+ /** Updated order. */
3164
+ order?: Order;
3165
+ }
3166
+ export interface BulkMarkOrdersAsPaidRequest {
3167
+ /** IDs of orders to mark as paid. */
3168
+ ids?: string[];
3169
+ }
3170
+ export interface BulkMarkOrdersAsPaidResponse {
3171
+ /**
3172
+ * Items updated by the bulk action.
3173
+ * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
3174
+ */
3175
+ results?: BulkOrderResult[];
3176
+ /** Bulk action metadata. */
3177
+ bulkActionMetadata?: BulkActionMetadata;
3178
+ }
3179
+ export interface CreatePaymentGatewayOrderRequest {
3180
+ /** eCom Order ID */
3181
+ ecomOrderId?: string;
3182
+ }
3183
+ export interface CreatePaymentGatewayOrderResponse {
3184
+ /** ID of the order created in the payment gateway */
3185
+ paymentGatewayOrderId?: string;
3186
+ }
3187
+ export interface GetShipmentsRequest {
3188
+ _id?: string;
3189
+ }
3190
+ export interface GetShipmentsResponse {
3191
+ shipmentIds?: string[];
3192
+ }
3193
+ export interface AggregateOrdersRequest {
3194
+ /** Filter applied to original data */
3195
+ filter?: Record<string, any> | null;
3196
+ /** This is an object defining aggregation itself */
3197
+ aggregation?: Record<string, any> | null;
3198
+ /**
3199
+ * Optional custom separator string that can be used to override default separator value '|'
3200
+ * for hierarchical responses of multifaceted aggregation requests like:
3201
+ * '{"aggregation": {"example_request_key": {"$count" : ["deliveryMethod", "shippingRegion"]}}}'
3202
+ * with example response for default '|' separator like:
3203
+ * '{"aggregates" :{"example_request_key": {"(Mail|Region 1)": 5, "(Pickup|Region 2)": 10}}}'
3204
+ */
3205
+ hierarchySeparatorOverride?: string | null;
3206
+ }
3207
+ export interface AggregateOrdersResponse {
3208
+ aggregates?: Record<string, any> | null;
3209
+ }
3210
+ export interface DecrementItemsQuantityRequest {
3211
+ /** Order ID */
3212
+ _id?: string;
3213
+ /** Which items to decrement, and how much to decrement from each one */
3214
+ decrementData?: DecrementData[];
3215
+ }
3216
+ export interface DecrementData {
3217
+ /** ID of the line item being decremented. */
3218
+ lineItemId?: string;
3219
+ /** Line item quantity being decremented. */
3220
+ decrementBy?: number;
3221
+ /** Whether to restock the line item (triggers inventory update). */
3222
+ restock?: boolean;
3223
+ }
3224
+ export interface DecrementItemsQuantityResponse {
3225
+ /** Updated order data */
3226
+ order?: Order;
3227
+ }
3228
+ /** Triggered when order items are marked as restocked */
3229
+ export interface OrderItemsRestocked {
3230
+ /** The order which items were restocked */
3334
3231
  order?: Order;
3335
- /**
3336
- * ID of the added activity.
3337
- * Use this ID to either [update](https://bo.wix.com/wix-docs/rest/ecommerce/orders/update-activity) or [delete](https://bo.wix.com/wix-docs/rest/ecommerce/orders/delete-activity) the activity.
3338
- */
3339
- activityId?: string;
3232
+ /** Restocked items and quantities */
3233
+ restockItems?: RestockItem[];
3340
3234
  }
3341
- export interface UpdateActivityRequest {
3342
- /** Order ID. */
3343
- _id?: string;
3344
- /** ID of the activity to update. */
3345
- activityId?: string;
3346
- /** Activity info. */
3347
- activity?: PublicActivity;
3235
+ export interface RestockItem {
3236
+ /** ID of the line item being restocked. */
3237
+ lineItemId?: string;
3238
+ /** Line item quantity being restocked. */
3239
+ quantity?: number;
3348
3240
  }
3349
- export interface UpdateActivityResponse {
3350
- /** Updated order. */
3241
+ /** Triggered when the the order status changes to approved */
3242
+ export interface OrderApproved {
3243
+ /** The order that was updated */
3351
3244
  order?: Order;
3352
3245
  }
3353
- export interface DeleteActivityRequest {
3354
- /** Order ID. */
3355
- _id?: string;
3356
- /** ID of the activity to delete. */
3357
- activityId?: string;
3246
+ export interface Task {
3247
+ key?: TaskKey;
3248
+ executeAt?: Date;
3249
+ payload?: string | null;
3358
3250
  }
3359
- export interface DeleteActivityResponse {
3360
- /** Updated order. */
3361
- order?: Order;
3251
+ export interface TaskKey {
3252
+ appId?: string;
3253
+ instanceId?: string;
3254
+ subjectId?: string | null;
3362
3255
  }
3363
- export interface UpdateLineItemsDescriptionLinesRequest {
3364
- /** Order ID. */
3365
- _id?: string;
3366
- /** Line items. */
3367
- lineItems?: LineItemUpdate[];
3256
+ export interface TaskAction extends TaskActionActionOneOf {
3257
+ complete?: Complete;
3258
+ cancel?: Cancel;
3259
+ reschedule?: Reschedule;
3368
3260
  }
3369
- export interface LineItemUpdate {
3370
- /** Line item ID. */
3371
- lineItemId?: string;
3372
- /**
3373
- * Description lines' info.
3374
- * If description line already exists for this name, it will be replaced.
3375
- */
3376
- descriptionLines?: DescriptionLine[];
3261
+ /** @oneof */
3262
+ export interface TaskActionActionOneOf {
3263
+ complete?: Complete;
3264
+ cancel?: Cancel;
3265
+ reschedule?: Reschedule;
3377
3266
  }
3378
- export interface UpdateLineItemsDescriptionLinesResponse {
3379
- /** Updated order. */
3380
- order?: Order;
3267
+ export interface Complete {
3381
3268
  }
3382
- export interface MarkOrderAsSeenByHumanRequest {
3383
- /** Order ID. */
3384
- _id?: string;
3269
+ export interface Cancel {
3385
3270
  }
3386
- export interface MarkOrderAsSeenByHumanResponse {
3387
- /** Updated order. */
3388
- order?: Order;
3271
+ export interface Reschedule {
3272
+ executeAt?: Date;
3273
+ payload?: string | null;
3389
3274
  }
3390
- export interface CancelOrderRequest {
3391
- /** Order ID. */
3392
- _id: string;
3393
- /** Whether to send an order canceled email to the buyer. */
3394
- sendOrderCanceledEmail?: boolean;
3395
- /** Custom note to be added to the email (optional). */
3396
- customMessage?: string | null;
3397
- /** Whether to restock all items in the order. This will only apply to products in the Wix Stores inventory. */
3398
- restockAllItems?: boolean;
3275
+ export interface InvoiceSentEvent {
3276
+ _id?: IdAndVersion;
3277
+ /** @readonly */
3278
+ data?: InvoiceFields;
3279
+ /** @readonly */
3280
+ status?: InvoiceStatus;
3399
3281
  }
3400
- export interface CancelOrderResponse {
3401
- /** Canceled order. */
3402
- order?: Order;
3282
+ export interface IdAndVersion {
3283
+ _id?: string | null;
3284
+ version?: number | null;
3403
3285
  }
3404
- export interface OrderCanceledEventOrderCanceled {
3405
- /** The order that was cancelled */
3406
- order?: Order;
3407
- /** Should restock all items on that order */
3408
- restockAllItems?: boolean;
3409
- /** Should send a confirmation mail to the customer */
3410
- sendOrderCanceledEmail?: boolean;
3411
- /** Personal note added to the email */
3412
- customMessage?: string | null;
3286
+ export interface InvoiceFields {
3287
+ /** The invoice number allocated the invoice by the server. The number is limited to at most 11 digits. */
3288
+ number?: string | null;
3289
+ /** The invoice 3-letter currency code in [ISO-4217 alphabetic](https://www.iso.org/iso-4217-currency-codes.html) format. */
3290
+ currencyCode?: string | null;
3291
+ /** The invoice customer. The customer must be a contact of the site, with an email. */
3292
+ customer?: Customer;
3293
+ /**
3294
+ * Invoice dates: issue date and due date are mandatory and provided when the invoice is created.
3295
+ * Last seen date is the optional date when the invoice was last seen be UoU.
3296
+ */
3297
+ dates?: InvoiceDates;
3298
+ /**
3299
+ * Line items containing the details of the products or services relevant to the invoice, with their name, prices,
3300
+ * and quantity. There must be at least one line item on the invoice.
3301
+ */
3302
+ lineItems?: LineItems;
3303
+ /**
3304
+ * Locale of the invoice, containing the language.
3305
+ * This field is not mandatory but is used for display purposes, to determine the appearance of numbers and dates
3306
+ * on the invoice.
3307
+ */
3308
+ locale?: Locale;
3309
+ /**
3310
+ * The totals on the invoice.
3311
+ * The totals.subtotal, totals.total and totals.taxed_amount are calculated by the server based on the line items.
3312
+ * Alternatively, these fields can be provided in the invoice creation request, in this case, these values are fixed.
3313
+ * The totals contain fees and a discount, that apply to the invoice.
3314
+ */
3315
+ totals?: TotalPrice;
3316
+ /** An optional discount on the invoice. */
3317
+ discount?: Discount;
3318
+ /** The taxes of the invoice. */
3319
+ taxes?: CalculatedTaxes;
3320
+ /** The payments on the invoice. The invoice has status paid if its payments cover the invoice total. */
3321
+ payments?: Payments;
3322
+ /** Invoice metadata */
3323
+ metaData?: MetaData;
3324
+ /** Not used */
3325
+ creationAdditional_BIInformation?: string | null;
3326
+ /**
3327
+ * The balance and amount paid on the invoice.
3328
+ * This read-only field is calculated based on the invoice totals and payments.
3329
+ * @readonly
3330
+ */
3331
+ dynamicTotals?: InvoiceDynamicPriceTotals;
3332
+ /** The invoice title */
3333
+ title?: string | null;
3334
+ /** Invoice custom fields */
3335
+ customFields?: CustomFieldValue[];
3336
+ /** Not used */
3337
+ designTemplateId?: string | null;
3338
+ /** Not used */
3339
+ createOrder?: boolean | null;
3340
+ /** The optional deposit of the invoice */
3341
+ deposit?: Deposit;
3342
+ /** associated checkout for this invoice */
3343
+ ecomCheckoutId?: string | null;
3413
3344
  }
3414
- export interface MarkAsFulfilledRequest {
3415
- /** Order ID. */
3416
- _id?: string;
3345
+ export interface Customer {
3346
+ contactId?: string | null;
3347
+ name?: string | null;
3348
+ email?: Email;
3349
+ address?: QuotesAddress;
3350
+ phone?: Phone;
3351
+ company?: Company;
3352
+ firstName?: string | null;
3353
+ lastName?: string | null;
3354
+ billingAddress?: CommonAddress;
3355
+ shippingAddress?: CommonAddress;
3417
3356
  }
3418
- export interface MarkAsFulfilledResponse {
3419
- /** Updated order. */
3420
- order?: Order;
3357
+ export interface Email {
3358
+ address?: string;
3421
3359
  }
3422
- /** Triggered when the fulfillment status of an order is updated */
3423
- export interface FulfillmentStatusUpdated {
3424
- /** The order that was updated */
3425
- order?: Order;
3426
- /** The previous status (before the update) */
3427
- previousFulfillmentStatus?: FulfillmentStatus;
3428
- /** the new status (after the update) */
3429
- newFulfillmentStatus?: FulfillmentStatus;
3430
- /** the action that caused this update */
3431
- action?: string;
3360
+ export interface QuotesAddress {
3361
+ street?: string | null;
3362
+ city?: string | null;
3363
+ zip?: string | null;
3364
+ state?: string | null;
3365
+ country?: string | null;
3366
+ /** @readonly */
3367
+ description?: AddressDescription;
3432
3368
  }
3433
- export interface BulkMarkAsFulfilledRequest {
3434
- /** IDs of orders to be marked as fulfilled. */
3435
- ids?: string[];
3436
- /** Whether to return the full updated order entities in the response. */
3437
- returnFullEntity?: boolean;
3369
+ export interface AddressDescription {
3370
+ content?: string;
3371
+ placement?: Placement;
3438
3372
  }
3439
- export interface BulkMarkAsFulfilledResponse {
3440
- /** Items updated by bulk action. */
3441
- results?: BulkOrderResult[];
3442
- /** Bulk action metadata. */
3443
- bulkActionMetadata?: BulkActionMetadata;
3373
+ export declare enum Placement {
3374
+ Unknown = "Unknown",
3375
+ Replace = "Replace",
3376
+ Before = "Before",
3377
+ After = "After"
3444
3378
  }
3445
- export interface BulkMarkAsFulfilledByFilterRequest {
3446
- /** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/ecommerce/orders/filter-and-sort). */
3447
- filter?: Record<string, any> | null;
3379
+ export interface Phone {
3380
+ number?: string;
3448
3381
  }
3449
- export interface BulkMarkAsFulfilledByFilterResponse {
3450
- /** Items updated by bulk action. */
3451
- results?: BulkOrderResult[];
3452
- /** Bulk action metadata. */
3453
- bulkActionMetadata?: BulkActionMetadata;
3382
+ export interface Company {
3383
+ name?: string;
3384
+ _id?: string | null;
3454
3385
  }
3455
- export interface MarkAsUnfulfilledRequest {
3456
- /** Order ID. */
3457
- _id?: string;
3386
+ /** Physical address */
3387
+ export interface CommonAddress extends CommonAddressStreetOneOf {
3388
+ /** Street name and number. */
3389
+ streetAddress?: StreetAddress;
3390
+ /** Main address line, usually street and number as free text. */
3391
+ addressLine1?: string | null;
3392
+ /** Country code. */
3393
+ country?: string | null;
3394
+ /** Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
3395
+ subdivision?: string | null;
3396
+ /** City name. */
3397
+ city?: string | null;
3398
+ /** Zip/postal code. */
3399
+ postalCode?: string | null;
3400
+ /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
3401
+ addressLine2?: string | null;
3458
3402
  }
3459
- export interface MarkAsUnfulfilledResponse {
3460
- /** Updated order. */
3461
- order?: Order;
3403
+ /** @oneof */
3404
+ export interface CommonAddressStreetOneOf {
3405
+ /** Street name and number. */
3406
+ streetAddress?: StreetAddress;
3407
+ /** Main address line, usually street and number as free text. */
3408
+ addressLine?: string | null;
3462
3409
  }
3463
- export interface BulkMarkAsUnfulfilledRequest {
3464
- /** IDs of orders to be marked as not fulfilled. */
3465
- ids?: string[];
3466
- /** Whether to return the full updated order entities in the response. */
3467
- returnFullEntity?: boolean;
3410
+ export interface Subdivision {
3411
+ /** Short subdivision code. */
3412
+ code?: string;
3413
+ /** Subdivision full name. */
3414
+ name?: string;
3468
3415
  }
3469
- export interface BulkMarkAsUnfulfilledResponse {
3470
- /** Items updated by bulk action. */
3471
- results?: BulkOrderResult[];
3472
- /** Bulk action metadata. */
3473
- bulkActionMetadata?: BulkActionMetadata;
3416
+ export declare enum SubdivisionType {
3417
+ UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
3418
+ /** State */
3419
+ ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
3420
+ /** County */
3421
+ ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
3422
+ /** City/town */
3423
+ ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
3424
+ /** Neighborhood/quarter */
3425
+ ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
3426
+ /** Street/block */
3427
+ ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
3428
+ /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
3429
+ COUNTRY = "COUNTRY"
3474
3430
  }
3475
- export interface BulkMarkAsUnfulfilledByFilterRequest {
3476
- /** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/ecommerce/orders/filter-and-sort). */
3477
- filter?: Record<string, any> | null;
3431
+ export interface InvoiceDates {
3432
+ /** use UTC midnight date to set the issue date according to the site time zone */
3433
+ issueDate?: Date;
3434
+ /** use UTC midnight date to set the due date according to the site time zone */
3435
+ dueDate?: Date;
3436
+ /** <a href="http://joda-time.sourceforge.net/timezones.html">Valid time zones</a> */
3437
+ timeZoneCode?: string | null;
3438
+ /**
3439
+ * ignored in request use in response to get the site time zone
3440
+ * @readonly
3441
+ */
3442
+ lastSeenDate?: Date;
3478
3443
  }
3479
- export interface BulkMarkAsUnfulfilledByFilterResponse {
3480
- /** Items updated by bulk action. */
3481
- results?: BulkOrderResult[];
3482
- /** Bulk action metadata. */
3483
- bulkActionMetadata?: BulkActionMetadata;
3444
+ export interface LineItems {
3445
+ lineItems?: LineItem[];
3484
3446
  }
3485
- export interface MarkOrderAsPaidRequest {
3486
- /** Order ID. */
3447
+ export interface LineItem {
3487
3448
  _id?: string;
3449
+ name?: string;
3450
+ description?: string | null;
3451
+ price?: BigDecimalWrapper;
3452
+ taxedTotal?: BigDecimalWrapper;
3453
+ quantity?: BigDecimalWrapper;
3454
+ taxes?: LineItemTax[];
3455
+ /** The source of the line item */
3456
+ source?: Source;
3457
+ /** The line-item level metadata. */
3458
+ metadata?: LineItemMetaData;
3488
3459
  }
3489
- export interface MarkOrderAsPaidResponse {
3490
- /** Updated order. */
3491
- order?: Order;
3460
+ export interface BigDecimalWrapper {
3461
+ serializedValue?: number;
3492
3462
  }
3493
- export interface BulkMarkOrdersAsPaidRequest {
3494
- /** IDs of orders to mark as paid. */
3495
- ids?: string[];
3463
+ export interface LineItemTax {
3464
+ name?: string;
3465
+ rate?: BigDecimalWrapper;
3466
+ code?: string | null;
3496
3467
  }
3497
- export interface BulkMarkOrdersAsPaidResponse {
3468
+ export interface Source {
3498
3469
  /**
3499
- * Items updated by the bulk action.
3500
- * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
3470
+ * Source app or service ID.
3471
+ * @readonly
3501
3472
  */
3502
- results?: BulkOrderResult[];
3503
- /** Bulk action metadata. */
3504
- bulkActionMetadata?: BulkActionMetadata;
3473
+ sourceId?: string;
3474
+ /**
3475
+ * App or service type.
3476
+ * @readonly
3477
+ */
3478
+ sourceType?: SourceType;
3505
3479
  }
3506
- export interface CreatePaymentGatewayOrderRequest {
3507
- /** eCom Order ID */
3508
- ecomOrderId?: string;
3480
+ export declare enum SourceType {
3481
+ UNKNOWN_SOURCE_TYPE = "UNKNOWN_SOURCE_TYPE",
3482
+ WIX_APP = "WIX_APP",
3483
+ EXTERNAL = "EXTERNAL",
3484
+ ADMIN = "ADMIN",
3485
+ OTHER = "OTHER"
3509
3486
  }
3510
- export interface CreatePaymentGatewayOrderResponse {
3511
- /** ID of the order created in the payment gateway */
3512
- paymentGatewayOrderId?: string;
3487
+ export interface LineItemMetaData {
3488
+ metadata?: Record<string, string>;
3513
3489
  }
3514
- export interface GetShipmentsRequest {
3515
- _id?: string;
3490
+ export interface Locale {
3491
+ /** ISO 639 alpha-2 or alpha-3 language code, or a language subtag */
3492
+ language?: string;
3493
+ /** An ISO 3166 alpha-2 country code or a UN M.49 numeric-3 area code. */
3494
+ country?: string | null;
3495
+ invariant?: string | null;
3516
3496
  }
3517
- export interface GetShipmentsResponse {
3518
- shipmentIds?: string[];
3497
+ export interface TotalPrice {
3498
+ /** the subtotal of the line items without the tax reduction */
3499
+ subtotal?: BigDecimalWrapper;
3500
+ /** the total price taking into account the itemized fees and the taxes */
3501
+ total?: BigDecimalWrapper;
3502
+ fees?: ItemizedFee[];
3503
+ discountAmount?: BigDecimalWrapper;
3504
+ taxedAmount?: BigDecimalWrapper;
3519
3505
  }
3520
- export interface AggregateOrdersRequest {
3521
- /** Filter applied to original data */
3522
- filter?: Record<string, any> | null;
3523
- /** This is an object defining aggregation itself */
3524
- aggregation?: Record<string, any> | null;
3525
- /**
3526
- * Optional custom separator string that can be used to override default separator value '|'
3527
- * for hierarchical responses of multifaceted aggregation requests like:
3528
- * '{"aggregation": {"example_request_key": {"$count" : ["deliveryMethod", "shippingRegion"]}}}'
3529
- * with example response for default '|' separator like:
3530
- * '{"aggregates" :{"example_request_key": {"(Mail|Region 1)": 5, "(Pickup|Region 2)": 10}}}'
3531
- */
3532
- hierarchySeparatorOverride?: string | null;
3506
+ export interface ItemizedFee {
3507
+ name?: string;
3508
+ price?: BigDecimalWrapper;
3533
3509
  }
3534
- export interface AggregateOrdersResponse {
3535
- aggregates?: Record<string, any> | null;
3510
+ export interface Discount extends DiscountOneDiscountTypeOneOf {
3511
+ /** Discount as percentage value. */
3512
+ percentage?: BigDecimalWrapper;
3536
3513
  }
3537
- export interface DecrementItemsQuantityRequest {
3538
- /** Order ID */
3539
- _id?: string;
3540
- /** Which items to decrement, and how much to decrement from each one */
3541
- decrementData?: DecrementData[];
3514
+ /** @oneof */
3515
+ export interface DiscountOneDiscountTypeOneOf {
3516
+ /** Discount as percentage value. */
3517
+ percentage?: BigDecimalWrapper;
3542
3518
  }
3543
- export interface DecrementData {
3544
- /** ID of the line item being decremented. */
3545
- lineItemId?: string;
3546
- /** Line item quantity being decremented. */
3547
- decrementBy?: number;
3548
- /** Whether to restock the line item (triggers inventory update). */
3549
- restock?: boolean;
3519
+ export interface CalculatedTaxes {
3520
+ /** consider calculated or not - cannot enforce set */
3521
+ taxes?: CalculatedTax[];
3550
3522
  }
3551
- export interface DecrementItemsQuantityResponse {
3552
- /** Updated order data */
3553
- order?: Order;
3523
+ export interface CalculatedTax {
3524
+ name?: string;
3525
+ rate?: BigDecimalWrapper;
3526
+ /** the costs on which the taxes are applied */
3527
+ taxable?: BigDecimalWrapper;
3528
+ /** the taxes as a result of the */
3529
+ taxed?: BigDecimalWrapper;
3530
+ code?: string | null;
3554
3531
  }
3555
- /** Triggered when order items are marked as restocked */
3556
- export interface OrderItemsRestocked {
3557
- /** The order which items were restocked */
3558
- order?: Order;
3559
- /** Restocked items and quantities */
3560
- restockItems?: RestockItem[];
3532
+ export interface Payments {
3533
+ payments?: Payment[];
3561
3534
  }
3562
- export interface RestockItem {
3563
- /** ID of the line item being restocked. */
3564
- lineItemId?: string;
3565
- /** Line item quantity being restocked. */
3566
- quantity?: number;
3535
+ export interface Payment {
3536
+ /** document */
3537
+ _id?: string;
3538
+ type?: string;
3539
+ amount?: BigDecimalWrapper;
3540
+ date?: Date;
3541
+ /**
3542
+ * The orderId of the order in cashier associated with the payment.
3543
+ * This field is populated for external payments that are charged by invoices via AddPayment endpoint.
3544
+ */
3545
+ orderId?: string | null;
3546
+ /**
3547
+ * The transactionId corresponding to the orderId of the payment which are returned by cashier.
3548
+ * This field is populated for external payments that are charged by invoices via AddPayment endpoint as well.
3549
+ */
3550
+ transactionId?: string | null;
3567
3551
  }
3568
- /** Triggered when the the order status changes to approved */
3569
- export interface OrderApproved {
3570
- /** The order that was updated */
3571
- order?: Order;
3552
+ export interface MetaData {
3553
+ notes?: string | null;
3554
+ legalTerms?: string | null;
3555
+ sourceUrl?: string | null;
3556
+ sourceProperties?: Record<string, string>;
3557
+ source?: string | null;
3558
+ sourceRefId?: string | null;
3559
+ /** Optional indicator whether to allow editing of the invoice by other applications other than the source. Default is true. */
3560
+ allowEditByOthers?: boolean | null;
3572
3561
  }
3573
- export interface Task {
3574
- key?: TaskKey;
3575
- executeAt?: Date;
3576
- payload?: string | null;
3562
+ export interface InvoiceDynamicPriceTotals {
3563
+ paidAmount?: BigDecimalWrapper;
3564
+ balance?: BigDecimalWrapper;
3577
3565
  }
3578
- export interface TaskKey {
3579
- appId?: string;
3580
- instanceId?: string;
3581
- subjectId?: string | null;
3566
+ /**
3567
+ * A custom field value is used to add additional data to a financial document or to a financial document template.
3568
+ * The custom field value may be based on a custom field definition.
3569
+ */
3570
+ export interface CustomFieldValue {
3571
+ /**
3572
+ * The unique id of the custom field value
3573
+ * @readonly
3574
+ */
3575
+ _id?: string | null;
3576
+ /** The display name of the custom field value */
3577
+ displayName?: string;
3578
+ /** The optional namespace of the custom field value. This field may be used to indicate intended usage or source. */
3579
+ namespace?: string | null;
3580
+ /** The group of the custom field indicates its intended placement in the financial document */
3581
+ group?: CustomFieldGroup;
3582
+ /** The value of the custom field */
3583
+ value?: Value;
3584
+ /** The optional key of the custom field definition on which the custom field value is based */
3585
+ originCustomFieldKey?: string | null;
3582
3586
  }
3583
- export interface TaskAction extends TaskActionActionOneOf {
3584
- complete?: Complete;
3585
- cancel?: Cancel;
3586
- reschedule?: Reschedule;
3587
+ export declare enum CustomFieldGroup {
3588
+ UNKNOWN_CUSTOM_FIELD_GROUP = "UNKNOWN_CUSTOM_FIELD_GROUP",
3589
+ BUSINESS_DETAILS = "BUSINESS_DETAILS",
3590
+ CUSTOMER_DETAILS = "CUSTOMER_DETAILS",
3591
+ DOCUMENT = "DOCUMENT",
3592
+ FOOTER = "FOOTER",
3593
+ OTHER = "OTHER"
3587
3594
  }
3588
- /** @oneof */
3589
- export interface TaskActionActionOneOf {
3590
- complete?: Complete;
3591
- cancel?: Cancel;
3592
- reschedule?: Reschedule;
3595
+ export interface Value {
3596
+ value?: string;
3597
+ valueType?: ValueType;
3593
3598
  }
3594
- export interface Complete {
3599
+ export declare enum ValueType {
3600
+ UNKNOWN_VALUE_TYPE = "UNKNOWN_VALUE_TYPE",
3601
+ STRING = "STRING",
3602
+ DATE = "DATE",
3603
+ BOOLEAN = "BOOLEAN",
3604
+ NUMBER = "NUMBER"
3595
3605
  }
3596
- export interface Cancel {
3606
+ export interface Deposit {
3607
+ /** The flat amount of the deposit. The flat amount of the deposit must be less than the invoice total. */
3608
+ flatAmount?: string;
3609
+ /**
3610
+ * The read-only percentage value of the deposit.
3611
+ * It is computed according to the flat_amount and the invoice total and is rounded to 2 digits precision.
3612
+ * @readonly
3613
+ */
3614
+ percentage?: string;
3615
+ /** The type of the deposit. The default is FLAT. */
3616
+ type?: DepositType;
3597
3617
  }
3598
- export interface Reschedule {
3599
- executeAt?: Date;
3600
- payload?: string | null;
3618
+ export declare enum DepositType {
3619
+ UNKNOWN = "UNKNOWN",
3620
+ FLAT = "FLAT",
3621
+ PERCENTAGE = "PERCENTAGE"
3601
3622
  }
3602
- export interface InvoiceSentEvent {
3603
- _id?: IdAndVersion;
3604
- /** @readonly */
3605
- data?: InvoiceFields;
3606
- /** @readonly */
3607
- status?: InvoiceStatus;
3623
+ /**
3624
+ * InvoiceStatus allowed transitions based on current status:
3625
+ * Draft -> Deleted, Paid, Partially Paid, Sent
3626
+ * Sent -> Draft, Deleted, Void, Paid, Partially Paid, Processing, (Overdue)
3627
+ * Processing -> PartiallyPaid, Paid, Sent
3628
+ * Paid -> Void
3629
+ * PartiallyPaid -> Void, (PartialAndOverdue)
3630
+ * Void -> Deleted
3631
+ * Deleted
3632
+ */
3633
+ export declare enum InvoiceStatus {
3634
+ Draft = "Draft",
3635
+ Sent = "Sent",
3636
+ Processing = "Processing",
3637
+ Paid = "Paid",
3638
+ Overdue = "Overdue",
3639
+ Void = "Void",
3640
+ Deleted = "Deleted",
3641
+ PartiallyPaid = "PartiallyPaid",
3642
+ PartialAndOverdue = "PartialAndOverdue"
3608
3643
  }
3609
3644
  export interface TriggerSideEffectsFromLegacyData {
3610
3645
  storeId?: string;
@@ -3878,6 +3913,14 @@ export interface GetOrderResponseNonNullableFields {
3878
3913
  };
3879
3914
  };
3880
3915
  };
3916
+ tags?: {
3917
+ privateTags?: {
3918
+ tagIds: string[];
3919
+ };
3920
+ tags?: {
3921
+ tagIds: string[];
3922
+ };
3923
+ };
3881
3924
  };
3882
3925
  }
3883
3926
  export interface SearchOrdersResponseNonNullableFields {
@@ -4147,6 +4190,14 @@ export interface SearchOrdersResponseNonNullableFields {
4147
4190
  };
4148
4191
  };
4149
4192
  };
4193
+ tags?: {
4194
+ privateTags?: {
4195
+ tagIds: string[];
4196
+ };
4197
+ tags?: {
4198
+ tagIds: string[];
4199
+ };
4200
+ };
4150
4201
  }[];
4151
4202
  }
4152
4203
  export interface CreateOrderResponseNonNullableFields {
@@ -4416,6 +4467,14 @@ export interface CreateOrderResponseNonNullableFields {
4416
4467
  };
4417
4468
  };
4418
4469
  };
4470
+ tags?: {
4471
+ privateTags?: {
4472
+ tagIds: string[];
4473
+ };
4474
+ tags?: {
4475
+ tagIds: string[];
4476
+ };
4477
+ };
4419
4478
  };
4420
4479
  }
4421
4480
  export interface UpdateOrderResponseNonNullableFields {
@@ -4685,6 +4744,306 @@ export interface UpdateOrderResponseNonNullableFields {
4685
4744
  };
4686
4745
  };
4687
4746
  };
4747
+ tags?: {
4748
+ privateTags?: {
4749
+ tagIds: string[];
4750
+ };
4751
+ tags?: {
4752
+ tagIds: string[];
4753
+ };
4754
+ };
4755
+ };
4756
+ }
4757
+ export interface BulkUpdateOrderResponseNonNullableFields {
4758
+ results: {
4759
+ itemMetadata?: {
4760
+ originalIndex: number;
4761
+ success: boolean;
4762
+ error?: {
4763
+ code: string;
4764
+ description: string;
4765
+ };
4766
+ };
4767
+ item?: {
4768
+ number: string;
4769
+ lineItems: {
4770
+ _id: string;
4771
+ productName?: {
4772
+ original: string;
4773
+ };
4774
+ catalogReference?: {
4775
+ catalogItemId: string;
4776
+ appId: string;
4777
+ };
4778
+ quantity: number;
4779
+ totalDiscount?: {
4780
+ amount: string;
4781
+ formattedAmount: string;
4782
+ };
4783
+ descriptionLines: {
4784
+ plainText?: {
4785
+ original: string;
4786
+ };
4787
+ colorInfo?: {
4788
+ original: string;
4789
+ };
4790
+ name?: {
4791
+ original: string;
4792
+ };
4793
+ }[];
4794
+ image: string;
4795
+ physicalProperties?: {
4796
+ shippable: boolean;
4797
+ };
4798
+ itemType?: {
4799
+ preset: ItemTypeItemType;
4800
+ custom: string;
4801
+ };
4802
+ price?: {
4803
+ amount: string;
4804
+ formattedAmount: string;
4805
+ };
4806
+ priceBeforeDiscounts?: {
4807
+ amount: string;
4808
+ formattedAmount: string;
4809
+ };
4810
+ totalPriceBeforeTax?: {
4811
+ amount: string;
4812
+ formattedAmount: string;
4813
+ };
4814
+ totalPriceAfterTax?: {
4815
+ amount: string;
4816
+ formattedAmount: string;
4817
+ };
4818
+ paymentOption: PaymentOptionType;
4819
+ taxDetails?: {
4820
+ taxableAmount?: {
4821
+ amount: string;
4822
+ formattedAmount: string;
4823
+ };
4824
+ taxRate: string;
4825
+ totalTax?: {
4826
+ amount: string;
4827
+ formattedAmount: string;
4828
+ };
4829
+ };
4830
+ subscriptionInfo?: {
4831
+ cycleNumber: number;
4832
+ subscriptionOptionTitle: string;
4833
+ subscriptionSettings?: {
4834
+ frequency: SubscriptionFrequency;
4835
+ autoRenewal: boolean;
4836
+ };
4837
+ };
4838
+ priceDescription?: {
4839
+ original: string;
4840
+ };
4841
+ depositAmount?: {
4842
+ amount: string;
4843
+ formattedAmount: string;
4844
+ };
4845
+ }[];
4846
+ buyerInfo?: {
4847
+ visitorId: string;
4848
+ memberId: string;
4849
+ };
4850
+ paymentStatus: PaymentStatus;
4851
+ fulfillmentStatus: FulfillmentStatus;
4852
+ weightUnit: WeightUnit;
4853
+ taxIncludedInPrices: boolean;
4854
+ priceSummary?: {
4855
+ subtotal?: {
4856
+ amount: string;
4857
+ formattedAmount: string;
4858
+ };
4859
+ shipping?: {
4860
+ amount: string;
4861
+ formattedAmount: string;
4862
+ };
4863
+ tax?: {
4864
+ amount: string;
4865
+ formattedAmount: string;
4866
+ };
4867
+ discount?: {
4868
+ amount: string;
4869
+ formattedAmount: string;
4870
+ };
4871
+ total?: {
4872
+ amount: string;
4873
+ formattedAmount: string;
4874
+ };
4875
+ totalAdditionalFees?: {
4876
+ amount: string;
4877
+ formattedAmount: string;
4878
+ };
4879
+ };
4880
+ billingInfo?: {
4881
+ contactDetails?: {
4882
+ vatId?: {
4883
+ _id: string;
4884
+ type: VatType;
4885
+ };
4886
+ };
4887
+ };
4888
+ shippingInfo?: {
4889
+ title: string;
4890
+ logistics?: {
4891
+ shippingDestination?: {
4892
+ contactDetails?: {
4893
+ vatId?: {
4894
+ _id: string;
4895
+ type: VatType;
4896
+ };
4897
+ };
4898
+ };
4899
+ pickupDetails?: {
4900
+ pickupMethod: PickupMethod;
4901
+ };
4902
+ };
4903
+ cost?: {
4904
+ price?: {
4905
+ amount: string;
4906
+ formattedAmount: string;
4907
+ };
4908
+ totalPriceBeforeTax?: {
4909
+ amount: string;
4910
+ formattedAmount: string;
4911
+ };
4912
+ totalPriceAfterTax?: {
4913
+ amount: string;
4914
+ formattedAmount: string;
4915
+ };
4916
+ taxDetails?: {
4917
+ taxableAmount?: {
4918
+ amount: string;
4919
+ formattedAmount: string;
4920
+ };
4921
+ taxRate: string;
4922
+ totalTax?: {
4923
+ amount: string;
4924
+ formattedAmount: string;
4925
+ };
4926
+ };
4927
+ discount?: {
4928
+ amount: string;
4929
+ formattedAmount: string;
4930
+ };
4931
+ };
4932
+ };
4933
+ status: OrderStatus;
4934
+ taxSummary?: {
4935
+ totalTax?: {
4936
+ amount: string;
4937
+ formattedAmount: string;
4938
+ };
4939
+ };
4940
+ appliedDiscounts: {
4941
+ coupon?: {
4942
+ _id: string;
4943
+ code: string;
4944
+ name: string;
4945
+ amount?: {
4946
+ amount: string;
4947
+ formattedAmount: string;
4948
+ };
4949
+ };
4950
+ merchantDiscount?: {
4951
+ discountReason: DiscountReason;
4952
+ amount?: {
4953
+ amount: string;
4954
+ formattedAmount: string;
4955
+ };
4956
+ };
4957
+ discountRule?: {
4958
+ _id: string;
4959
+ name?: {
4960
+ original: string;
4961
+ };
4962
+ amount?: {
4963
+ amount: string;
4964
+ formattedAmount: string;
4965
+ };
4966
+ };
4967
+ discountType: DiscountType;
4968
+ lineItemIds: string[];
4969
+ }[];
4970
+ activities: {
4971
+ customActivity?: {
4972
+ appId: string;
4973
+ type: string;
4974
+ };
4975
+ merchantComment?: {
4976
+ message: string;
4977
+ };
4978
+ orderRefunded?: {
4979
+ manual: boolean;
4980
+ amount?: {
4981
+ amount: string;
4982
+ formattedAmount: string;
4983
+ };
4984
+ reason: string;
4985
+ };
4986
+ type: ActivityType;
4987
+ }[];
4988
+ attributionSource: AttributionSource;
4989
+ createdBy?: {
4990
+ userId: string;
4991
+ memberId: string;
4992
+ visitorId: string;
4993
+ appId: string;
4994
+ };
4995
+ channelInfo?: {
4996
+ type: ChannelType;
4997
+ };
4998
+ customFields: {
4999
+ title: string;
5000
+ }[];
5001
+ additionalFees: {
5002
+ name: string;
5003
+ price?: {
5004
+ amount: string;
5005
+ formattedAmount: string;
5006
+ };
5007
+ taxDetails?: {
5008
+ taxableAmount?: {
5009
+ amount: string;
5010
+ formattedAmount: string;
5011
+ };
5012
+ taxRate: string;
5013
+ totalTax?: {
5014
+ amount: string;
5015
+ formattedAmount: string;
5016
+ };
5017
+ };
5018
+ priceBeforeTax?: {
5019
+ amount: string;
5020
+ formattedAmount: string;
5021
+ };
5022
+ _id: string;
5023
+ lineItemIds: string[];
5024
+ }[];
5025
+ recipientInfo?: {
5026
+ contactDetails?: {
5027
+ vatId?: {
5028
+ _id: string;
5029
+ type: VatType;
5030
+ };
5031
+ };
5032
+ };
5033
+ tags?: {
5034
+ privateTags?: {
5035
+ tagIds: string[];
5036
+ };
5037
+ tags?: {
5038
+ tagIds: string[];
5039
+ };
5040
+ };
5041
+ };
5042
+ }[];
5043
+ bulkActionMetadata?: {
5044
+ totalSuccesses: number;
5045
+ totalFailures: number;
5046
+ undetailedFailures: number;
4688
5047
  };
4689
5048
  }
4690
5049
  export interface CancelOrderResponseNonNullableFields {
@@ -4954,6 +5313,14 @@ export interface CancelOrderResponseNonNullableFields {
4954
5313
  };
4955
5314
  };
4956
5315
  };
5316
+ tags?: {
5317
+ privateTags?: {
5318
+ tagIds: string[];
5319
+ };
5320
+ tags?: {
5321
+ tagIds: string[];
5322
+ };
5323
+ };
4957
5324
  };
4958
5325
  }
4959
5326
  /**
@@ -5204,6 +5571,27 @@ export interface UpdateOrder {
5204
5571
  * + No shipping option is selected.
5205
5572
  */
5206
5573
  recipientInfo?: AddressWithContact;
5574
+ /** Tag ids collections associated with current entity. private_tags requires separate permissions to be accessible and modifiable. */
5575
+ tags?: Tags;
5576
+ }
5577
+ /** @param orders - Orders to be updated.
5578
+ * @public
5579
+ * @documentationMaturity preview
5580
+ * @requiredField orders
5581
+ * @requiredField orders.order
5582
+ * @requiredField orders.order._id
5583
+ * @permissionScope Manage Stores - all permissions
5584
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
5585
+ * @permissionScope Manage eCommerce - all permissions
5586
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
5587
+ * @permissionScope Manage Orders
5588
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
5589
+ * @applicableIdentity APP
5590
+ */
5591
+ export declare function bulkUpdateOrder(orders: MaskedOrder[], options?: BulkUpdateOrderOptions): Promise<BulkUpdateOrderResponse & BulkUpdateOrderResponseNonNullableFields>;
5592
+ export interface BulkUpdateOrderOptions {
5593
+ /** Set to `true` if you wish to receive back the updated orders in the response */
5594
+ returnEntity?: boolean;
5207
5595
  }
5208
5596
  /**
5209
5597
  * Cancels an order.