@gradientedge/commercetools-utils 5.29.0 → 5.31.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (307) hide show
  1. package/dist/cjs/tsconfig-cjs.tsbuildinfo +1 -1
  2. package/dist/cjs/types/models/approval-flow.d.ts +15 -4
  3. package/dist/cjs/types/models/approval-flow.d.ts.map +1 -1
  4. package/dist/cjs/types/models/approval-flow.js +11 -0
  5. package/dist/cjs/types/models/approval-flow.js.map +1 -1
  6. package/dist/cjs/types/models/approval-rule.d.ts +19 -9
  7. package/dist/cjs/types/models/approval-rule.d.ts.map +1 -1
  8. package/dist/cjs/types/models/approval-rule.js +10 -0
  9. package/dist/cjs/types/models/approval-rule.js.map +1 -1
  10. package/dist/cjs/types/models/associate-role.d.ts +58 -11
  11. package/dist/cjs/types/models/associate-role.d.ts.map +1 -1
  12. package/dist/cjs/types/models/associate-role.js +47 -0
  13. package/dist/cjs/types/models/associate-role.js.map +1 -1
  14. package/dist/cjs/types/models/attribute-group.d.ts +15 -9
  15. package/dist/cjs/types/models/attribute-group.d.ts.map +1 -1
  16. package/dist/cjs/types/models/business-unit-search.d.ts +114 -0
  17. package/dist/cjs/types/models/business-unit-search.d.ts.map +1 -0
  18. package/dist/cjs/types/models/business-unit-search.js +8 -0
  19. package/dist/cjs/types/models/business-unit-search.js.map +1 -0
  20. package/dist/cjs/types/models/business-unit.d.ts +349 -35
  21. package/dist/cjs/types/models/business-unit.d.ts.map +1 -1
  22. package/dist/cjs/types/models/business-unit.js +55 -0
  23. package/dist/cjs/types/models/business-unit.js.map +1 -1
  24. package/dist/cjs/types/models/cart-discount.d.ts +218 -36
  25. package/dist/cjs/types/models/cart-discount.d.ts.map +1 -1
  26. package/dist/cjs/types/models/cart-discount.js +29 -0
  27. package/dist/cjs/types/models/cart-discount.js.map +1 -1
  28. package/dist/cjs/types/models/cart.d.ts +178 -88
  29. package/dist/cjs/types/models/cart.d.ts.map +1 -1
  30. package/dist/cjs/types/models/cart.js +127 -0
  31. package/dist/cjs/types/models/cart.js.map +1 -1
  32. package/dist/cjs/types/models/category.d.ts +32 -26
  33. package/dist/cjs/types/models/category.d.ts.map +1 -1
  34. package/dist/cjs/types/models/channel.d.ts +28 -15
  35. package/dist/cjs/types/models/channel.d.ts.map +1 -1
  36. package/dist/cjs/types/models/channel.js +13 -0
  37. package/dist/cjs/types/models/channel.js.map +1 -1
  38. package/dist/cjs/types/models/common.d.ts +167 -5
  39. package/dist/cjs/types/models/common.d.ts.map +1 -1
  40. package/dist/cjs/types/models/common.js +61 -0
  41. package/dist/cjs/types/models/common.js.map +1 -1
  42. package/dist/cjs/types/models/custom-object.d.ts +2 -2
  43. package/dist/cjs/types/models/custom-object.d.ts.map +1 -1
  44. package/dist/cjs/types/models/customer-group.d.ts +13 -7
  45. package/dist/cjs/types/models/customer-group.d.ts.map +1 -1
  46. package/dist/cjs/types/models/customer.d.ts +53 -39
  47. package/dist/cjs/types/models/customer.d.ts.map +1 -1
  48. package/dist/cjs/types/models/customer.js +11 -0
  49. package/dist/cjs/types/models/customer.js.map +1 -1
  50. package/dist/cjs/types/models/discount-code.d.ts +24 -18
  51. package/dist/cjs/types/models/discount-code.d.ts.map +1 -1
  52. package/dist/cjs/types/models/error.d.ts +193 -167
  53. package/dist/cjs/types/models/error.d.ts.map +1 -1
  54. package/dist/cjs/types/models/extension.d.ts +43 -9
  55. package/dist/cjs/types/models/extension.d.ts.map +1 -1
  56. package/dist/cjs/types/models/extension.js +27 -0
  57. package/dist/cjs/types/models/extension.js.map +1 -1
  58. package/dist/cjs/types/models/graph-ql.d.ts +89 -0
  59. package/dist/cjs/types/models/graph-ql.d.ts.map +1 -0
  60. package/dist/cjs/types/models/graph-ql.js +8 -0
  61. package/dist/cjs/types/models/graph-ql.js.map +1 -0
  62. package/dist/cjs/types/models/index.d.ts +2 -0
  63. package/dist/cjs/types/models/index.d.ts.map +1 -1
  64. package/dist/cjs/types/models/index.js +2 -0
  65. package/dist/cjs/types/models/index.js.map +1 -1
  66. package/dist/cjs/types/models/inventory.d.ts +19 -13
  67. package/dist/cjs/types/models/inventory.d.ts.map +1 -1
  68. package/dist/cjs/types/models/me.d.ts +210 -100
  69. package/dist/cjs/types/models/me.d.ts.map +1 -1
  70. package/dist/cjs/types/models/me.js +10 -0
  71. package/dist/cjs/types/models/me.js.map +1 -1
  72. package/dist/cjs/types/models/message.d.ts +871 -489
  73. package/dist/cjs/types/models/message.d.ts.map +1 -1
  74. package/dist/cjs/types/models/order-edit.d.ts +131 -108
  75. package/dist/cjs/types/models/order-edit.d.ts.map +1 -1
  76. package/dist/cjs/types/models/order.d.ts +211 -69
  77. package/dist/cjs/types/models/order.d.ts.map +1 -1
  78. package/dist/cjs/types/models/order.js +93 -0
  79. package/dist/cjs/types/models/order.js.map +1 -1
  80. package/dist/cjs/types/models/payment.d.ts +42 -23
  81. package/dist/cjs/types/models/payment.d.ts.map +1 -1
  82. package/dist/cjs/types/models/payment.js +20 -0
  83. package/dist/cjs/types/models/payment.js.map +1 -1
  84. package/dist/cjs/types/models/product-discount.d.ts +37 -19
  85. package/dist/cjs/types/models/product-discount.d.ts.map +1 -1
  86. package/dist/cjs/types/models/product-search.d.ts +43 -14
  87. package/dist/cjs/types/models/product-search.d.ts.map +1 -1
  88. package/dist/cjs/types/models/product-search.js +16 -0
  89. package/dist/cjs/types/models/product-search.js.map +1 -1
  90. package/dist/cjs/types/models/product-selection.d.ts +42 -16
  91. package/dist/cjs/types/models/product-selection.d.ts.map +1 -1
  92. package/dist/cjs/types/models/product-selection.js +17 -0
  93. package/dist/cjs/types/models/product-selection.js.map +1 -1
  94. package/dist/cjs/types/models/product-tailoring.d.ts +42 -33
  95. package/dist/cjs/types/models/product-tailoring.d.ts.map +1 -1
  96. package/dist/cjs/types/models/product-type.d.ts +83 -40
  97. package/dist/cjs/types/models/product-type.d.ts.map +1 -1
  98. package/dist/cjs/types/models/product-type.js +48 -0
  99. package/dist/cjs/types/models/product-type.js.map +1 -1
  100. package/dist/cjs/types/models/product.d.ts +97 -59
  101. package/dist/cjs/types/models/product.d.ts.map +1 -1
  102. package/dist/cjs/types/models/product.js +26 -0
  103. package/dist/cjs/types/models/product.js.map +1 -1
  104. package/dist/cjs/types/models/project.d.ts +94 -20
  105. package/dist/cjs/types/models/project.d.ts.map +1 -1
  106. package/dist/cjs/types/models/project.js +73 -0
  107. package/dist/cjs/types/models/project.js.map +1 -1
  108. package/dist/cjs/types/models/quote-request.d.ts +21 -8
  109. package/dist/cjs/types/models/quote-request.d.ts.map +1 -1
  110. package/dist/cjs/types/models/quote-request.js +13 -0
  111. package/dist/cjs/types/models/quote-request.js.map +1 -1
  112. package/dist/cjs/types/models/quote.d.ts +25 -11
  113. package/dist/cjs/types/models/quote.d.ts.map +1 -1
  114. package/dist/cjs/types/models/quote.js +14 -0
  115. package/dist/cjs/types/models/quote.js.map +1 -1
  116. package/dist/cjs/types/models/review.d.ts +20 -14
  117. package/dist/cjs/types/models/review.d.ts.map +1 -1
  118. package/dist/cjs/types/models/search.d.ts +62 -4
  119. package/dist/cjs/types/models/search.d.ts.map +1 -1
  120. package/dist/cjs/types/models/search.js +51 -0
  121. package/dist/cjs/types/models/search.js.map +1 -1
  122. package/dist/cjs/types/models/shipping-method.d.ts +38 -21
  123. package/dist/cjs/types/models/shipping-method.d.ts.map +1 -1
  124. package/dist/cjs/types/models/shipping-method.js +7 -0
  125. package/dist/cjs/types/models/shipping-method.js.map +1 -1
  126. package/dist/cjs/types/models/shopping-list.d.ts +66 -28
  127. package/dist/cjs/types/models/shopping-list.d.ts.map +1 -1
  128. package/dist/cjs/types/models/staged-quote.d.ts +21 -10
  129. package/dist/cjs/types/models/staged-quote.d.ts.map +1 -1
  130. package/dist/cjs/types/models/staged-quote.js +11 -0
  131. package/dist/cjs/types/models/staged-quote.js.map +1 -1
  132. package/dist/cjs/types/models/standalone-price.d.ts +23 -17
  133. package/dist/cjs/types/models/standalone-price.d.ts.map +1 -1
  134. package/dist/cjs/types/models/state.d.ts +33 -13
  135. package/dist/cjs/types/models/state.d.ts.map +1 -1
  136. package/dist/cjs/types/models/state.js +25 -0
  137. package/dist/cjs/types/models/state.js.map +1 -1
  138. package/dist/cjs/types/models/store.d.ts +29 -23
  139. package/dist/cjs/types/models/store.d.ts.map +1 -1
  140. package/dist/cjs/types/models/subscription.d.ts +138 -18
  141. package/dist/cjs/types/models/subscription.d.ts.map +1 -1
  142. package/dist/cjs/types/models/subscription.js +95 -0
  143. package/dist/cjs/types/models/subscription.js.map +1 -1
  144. package/dist/cjs/types/models/tax-category.d.ts +15 -9
  145. package/dist/cjs/types/models/tax-category.d.ts.map +1 -1
  146. package/dist/cjs/types/models/type.d.ts +101 -29
  147. package/dist/cjs/types/models/type.d.ts.map +1 -1
  148. package/dist/cjs/types/models/type.js +76 -0
  149. package/dist/cjs/types/models/type.js.map +1 -1
  150. package/dist/cjs/types/models/warning.d.ts +15 -1
  151. package/dist/cjs/types/models/warning.d.ts.map +1 -1
  152. package/dist/cjs/types/models/zone.d.ts +14 -8
  153. package/dist/cjs/types/models/zone.d.ts.map +1 -1
  154. package/dist/mjs/tsconfig.tsbuildinfo +1 -1
  155. package/dist/mjs/types/models/approval-flow.d.ts +15 -4
  156. package/dist/mjs/types/models/approval-flow.d.ts.map +1 -1
  157. package/dist/mjs/types/models/approval-flow.js +10 -1
  158. package/dist/mjs/types/models/approval-flow.js.map +1 -1
  159. package/dist/mjs/types/models/approval-rule.d.ts +19 -9
  160. package/dist/mjs/types/models/approval-rule.d.ts.map +1 -1
  161. package/dist/mjs/types/models/approval-rule.js +9 -1
  162. package/dist/mjs/types/models/approval-rule.js.map +1 -1
  163. package/dist/mjs/types/models/associate-role.d.ts +58 -11
  164. package/dist/mjs/types/models/associate-role.d.ts.map +1 -1
  165. package/dist/mjs/types/models/associate-role.js +46 -1
  166. package/dist/mjs/types/models/associate-role.js.map +1 -1
  167. package/dist/mjs/types/models/attribute-group.d.ts +15 -9
  168. package/dist/mjs/types/models/attribute-group.d.ts.map +1 -1
  169. package/dist/mjs/types/models/business-unit-search.d.ts +114 -0
  170. package/dist/mjs/types/models/business-unit-search.d.ts.map +1 -0
  171. package/dist/mjs/types/models/business-unit-search.js +7 -0
  172. package/dist/mjs/types/models/business-unit-search.js.map +1 -0
  173. package/dist/mjs/types/models/business-unit.d.ts +349 -35
  174. package/dist/mjs/types/models/business-unit.d.ts.map +1 -1
  175. package/dist/mjs/types/models/business-unit.js +54 -1
  176. package/dist/mjs/types/models/business-unit.js.map +1 -1
  177. package/dist/mjs/types/models/cart-discount.d.ts +218 -36
  178. package/dist/mjs/types/models/cart-discount.d.ts.map +1 -1
  179. package/dist/mjs/types/models/cart-discount.js +28 -1
  180. package/dist/mjs/types/models/cart-discount.js.map +1 -1
  181. package/dist/mjs/types/models/cart.d.ts +178 -88
  182. package/dist/mjs/types/models/cart.d.ts.map +1 -1
  183. package/dist/mjs/types/models/cart.js +126 -1
  184. package/dist/mjs/types/models/cart.js.map +1 -1
  185. package/dist/mjs/types/models/category.d.ts +32 -26
  186. package/dist/mjs/types/models/category.d.ts.map +1 -1
  187. package/dist/mjs/types/models/channel.d.ts +28 -15
  188. package/dist/mjs/types/models/channel.d.ts.map +1 -1
  189. package/dist/mjs/types/models/channel.js +12 -1
  190. package/dist/mjs/types/models/channel.js.map +1 -1
  191. package/dist/mjs/types/models/common.d.ts +167 -5
  192. package/dist/mjs/types/models/common.d.ts.map +1 -1
  193. package/dist/mjs/types/models/common.js +60 -1
  194. package/dist/mjs/types/models/common.js.map +1 -1
  195. package/dist/mjs/types/models/custom-object.d.ts +2 -2
  196. package/dist/mjs/types/models/custom-object.d.ts.map +1 -1
  197. package/dist/mjs/types/models/customer-group.d.ts +13 -7
  198. package/dist/mjs/types/models/customer-group.d.ts.map +1 -1
  199. package/dist/mjs/types/models/customer.d.ts +53 -39
  200. package/dist/mjs/types/models/customer.d.ts.map +1 -1
  201. package/dist/mjs/types/models/customer.js +10 -1
  202. package/dist/mjs/types/models/customer.js.map +1 -1
  203. package/dist/mjs/types/models/discount-code.d.ts +24 -18
  204. package/dist/mjs/types/models/discount-code.d.ts.map +1 -1
  205. package/dist/mjs/types/models/error.d.ts +193 -167
  206. package/dist/mjs/types/models/error.d.ts.map +1 -1
  207. package/dist/mjs/types/models/extension.d.ts +43 -9
  208. package/dist/mjs/types/models/extension.d.ts.map +1 -1
  209. package/dist/mjs/types/models/extension.js +26 -1
  210. package/dist/mjs/types/models/extension.js.map +1 -1
  211. package/dist/mjs/types/models/graph-ql.d.ts +89 -0
  212. package/dist/mjs/types/models/graph-ql.d.ts.map +1 -0
  213. package/dist/mjs/types/models/graph-ql.js +7 -0
  214. package/dist/mjs/types/models/graph-ql.js.map +1 -0
  215. package/dist/mjs/types/models/index.d.ts +2 -0
  216. package/dist/mjs/types/models/index.d.ts.map +1 -1
  217. package/dist/mjs/types/models/index.js +2 -0
  218. package/dist/mjs/types/models/index.js.map +1 -1
  219. package/dist/mjs/types/models/inventory.d.ts +19 -13
  220. package/dist/mjs/types/models/inventory.d.ts.map +1 -1
  221. package/dist/mjs/types/models/me.d.ts +210 -100
  222. package/dist/mjs/types/models/me.d.ts.map +1 -1
  223. package/dist/mjs/types/models/me.js +9 -1
  224. package/dist/mjs/types/models/me.js.map +1 -1
  225. package/dist/mjs/types/models/message.d.ts +871 -489
  226. package/dist/mjs/types/models/message.d.ts.map +1 -1
  227. package/dist/mjs/types/models/order-edit.d.ts +131 -108
  228. package/dist/mjs/types/models/order-edit.d.ts.map +1 -1
  229. package/dist/mjs/types/models/order.d.ts +211 -69
  230. package/dist/mjs/types/models/order.d.ts.map +1 -1
  231. package/dist/mjs/types/models/order.js +92 -1
  232. package/dist/mjs/types/models/order.js.map +1 -1
  233. package/dist/mjs/types/models/payment.d.ts +42 -23
  234. package/dist/mjs/types/models/payment.d.ts.map +1 -1
  235. package/dist/mjs/types/models/payment.js +19 -1
  236. package/dist/mjs/types/models/payment.js.map +1 -1
  237. package/dist/mjs/types/models/product-discount.d.ts +37 -19
  238. package/dist/mjs/types/models/product-discount.d.ts.map +1 -1
  239. package/dist/mjs/types/models/product-search.d.ts +43 -14
  240. package/dist/mjs/types/models/product-search.d.ts.map +1 -1
  241. package/dist/mjs/types/models/product-search.js +15 -1
  242. package/dist/mjs/types/models/product-search.js.map +1 -1
  243. package/dist/mjs/types/models/product-selection.d.ts +42 -16
  244. package/dist/mjs/types/models/product-selection.d.ts.map +1 -1
  245. package/dist/mjs/types/models/product-selection.js +16 -1
  246. package/dist/mjs/types/models/product-selection.js.map +1 -1
  247. package/dist/mjs/types/models/product-tailoring.d.ts +42 -33
  248. package/dist/mjs/types/models/product-tailoring.d.ts.map +1 -1
  249. package/dist/mjs/types/models/product-type.d.ts +83 -40
  250. package/dist/mjs/types/models/product-type.d.ts.map +1 -1
  251. package/dist/mjs/types/models/product-type.js +47 -1
  252. package/dist/mjs/types/models/product-type.js.map +1 -1
  253. package/dist/mjs/types/models/product.d.ts +97 -59
  254. package/dist/mjs/types/models/product.d.ts.map +1 -1
  255. package/dist/mjs/types/models/product.js +25 -1
  256. package/dist/mjs/types/models/product.js.map +1 -1
  257. package/dist/mjs/types/models/project.d.ts +94 -20
  258. package/dist/mjs/types/models/project.d.ts.map +1 -1
  259. package/dist/mjs/types/models/project.js +72 -1
  260. package/dist/mjs/types/models/project.js.map +1 -1
  261. package/dist/mjs/types/models/quote-request.d.ts +21 -8
  262. package/dist/mjs/types/models/quote-request.d.ts.map +1 -1
  263. package/dist/mjs/types/models/quote-request.js +12 -1
  264. package/dist/mjs/types/models/quote-request.js.map +1 -1
  265. package/dist/mjs/types/models/quote.d.ts +25 -11
  266. package/dist/mjs/types/models/quote.d.ts.map +1 -1
  267. package/dist/mjs/types/models/quote.js +13 -1
  268. package/dist/mjs/types/models/quote.js.map +1 -1
  269. package/dist/mjs/types/models/review.d.ts +20 -14
  270. package/dist/mjs/types/models/review.d.ts.map +1 -1
  271. package/dist/mjs/types/models/search.d.ts +62 -4
  272. package/dist/mjs/types/models/search.d.ts.map +1 -1
  273. package/dist/mjs/types/models/search.js +50 -1
  274. package/dist/mjs/types/models/search.js.map +1 -1
  275. package/dist/mjs/types/models/shipping-method.d.ts +38 -21
  276. package/dist/mjs/types/models/shipping-method.d.ts.map +1 -1
  277. package/dist/mjs/types/models/shipping-method.js +6 -1
  278. package/dist/mjs/types/models/shipping-method.js.map +1 -1
  279. package/dist/mjs/types/models/shopping-list.d.ts +66 -28
  280. package/dist/mjs/types/models/shopping-list.d.ts.map +1 -1
  281. package/dist/mjs/types/models/staged-quote.d.ts +21 -10
  282. package/dist/mjs/types/models/staged-quote.d.ts.map +1 -1
  283. package/dist/mjs/types/models/staged-quote.js +10 -1
  284. package/dist/mjs/types/models/staged-quote.js.map +1 -1
  285. package/dist/mjs/types/models/standalone-price.d.ts +23 -17
  286. package/dist/mjs/types/models/standalone-price.d.ts.map +1 -1
  287. package/dist/mjs/types/models/state.d.ts +33 -13
  288. package/dist/mjs/types/models/state.d.ts.map +1 -1
  289. package/dist/mjs/types/models/state.js +24 -1
  290. package/dist/mjs/types/models/state.js.map +1 -1
  291. package/dist/mjs/types/models/store.d.ts +29 -23
  292. package/dist/mjs/types/models/store.d.ts.map +1 -1
  293. package/dist/mjs/types/models/subscription.d.ts +138 -18
  294. package/dist/mjs/types/models/subscription.d.ts.map +1 -1
  295. package/dist/mjs/types/models/subscription.js +94 -1
  296. package/dist/mjs/types/models/subscription.js.map +1 -1
  297. package/dist/mjs/types/models/tax-category.d.ts +15 -9
  298. package/dist/mjs/types/models/tax-category.d.ts.map +1 -1
  299. package/dist/mjs/types/models/type.d.ts +101 -29
  300. package/dist/mjs/types/models/type.d.ts.map +1 -1
  301. package/dist/mjs/types/models/type.js +75 -1
  302. package/dist/mjs/types/models/type.js.map +1 -1
  303. package/dist/mjs/types/models/warning.d.ts +15 -1
  304. package/dist/mjs/types/models/warning.d.ts.map +1 -1
  305. package/dist/mjs/types/models/zone.d.ts +14 -8
  306. package/dist/mjs/types/models/zone.d.ts.map +1 -1
  307. package/package.json +2 -2
@@ -7,7 +7,7 @@ import { BusinessUnitKeyReference, BusinessUnitResourceIdentifier } from './busi
7
7
  import { CartOrigin, CartReference, CartResourceIdentifier, CustomLineItem, CustomLineItemPriceMode, DirectDiscount, DiscountCodeInfo, DiscountedLineItemPortionDraft, DiscountOnTotalPrice, InventoryMode, ItemShippingDetailsDraft, LineItem, RoundingMode, Shipping, ShippingInfo, ShippingMethodState, ShippingMode, ShippingRateInput, TaxCalculationMode, TaxedPrice, TaxedPriceDraft, TaxMode } from './cart.js';
8
8
  import { CartDiscountReference } from './cart-discount.js';
9
9
  import { ChannelReference, ChannelResourceIdentifier } from './channel.js';
10
- import { Address, AddressDraft, BaseAddress, BaseResource, CentPrecisionMoney, CreatedBy, Image, LastModifiedBy, LocalizedString, PriceDraft, _BaseAddress, _Money } from './common.js';
10
+ import { Address, AddressDraft, BaseAddress, BaseResource, CentPrecisionMoney, CreatedBy, Image, IReference, LastModifiedBy, LocalizedString, PriceDraft, _BaseAddress, _Money } from './common.js';
11
11
  import { CustomerGroupReference, CustomerGroupResourceIdentifier } from './customer-group.js';
12
12
  import { StagedOrder, StagedOrderAddCustomLineItemAction, StagedOrderAddDeliveryAction, StagedOrderAddDiscountCodeAction, StagedOrderAddItemShippingAddressAction, StagedOrderAddLineItemAction, StagedOrderAddParcelToDeliveryAction, StagedOrderAddPaymentAction, StagedOrderAddReturnInfoAction, StagedOrderAddShoppingListAction, StagedOrderChangeCustomLineItemMoneyAction, StagedOrderChangeCustomLineItemQuantityAction, StagedOrderChangeLineItemQuantityAction, StagedOrderChangeOrderStateAction, StagedOrderChangePaymentStateAction, StagedOrderChangeShipmentStateAction, StagedOrderChangeTaxCalculationModeAction, StagedOrderChangeTaxModeAction, StagedOrderChangeTaxRoundingModeAction, StagedOrderImportCustomLineItemStateAction, StagedOrderImportLineItemStateAction, StagedOrderRemoveCustomLineItemAction, StagedOrderRemoveDeliveryAction, StagedOrderRemoveDiscountCodeAction, StagedOrderRemoveItemShippingAddressAction, StagedOrderRemoveLineItemAction, StagedOrderRemoveParcelFromDeliveryAction, StagedOrderRemovePaymentAction, StagedOrderSetBillingAddressAction, StagedOrderSetBillingAddressCustomFieldAction, StagedOrderSetBillingAddressCustomTypeAction, StagedOrderSetCountryAction, StagedOrderSetCustomerEmailAction, StagedOrderSetCustomerGroupAction, StagedOrderSetCustomerIdAction, StagedOrderSetCustomFieldAction, StagedOrderSetCustomLineItemCustomFieldAction, StagedOrderSetCustomLineItemCustomTypeAction, StagedOrderSetCustomLineItemShippingDetailsAction, StagedOrderSetCustomLineItemTaxAmountAction, StagedOrderSetCustomLineItemTaxRateAction, StagedOrderSetCustomShippingMethodAction, StagedOrderSetCustomTypeAction, StagedOrderSetDeliveryAddressAction, StagedOrderSetDeliveryAddressCustomFieldAction, StagedOrderSetDeliveryAddressCustomTypeAction, StagedOrderSetDeliveryCustomFieldAction, StagedOrderSetDeliveryCustomTypeAction, StagedOrderSetDeliveryItemsAction, StagedOrderSetDirectDiscountsAction, StagedOrderSetItemShippingAddressCustomFieldAction, StagedOrderSetItemShippingAddressCustomTypeAction, StagedOrderSetLineItemCustomFieldAction, StagedOrderSetLineItemCustomTypeAction, StagedOrderSetLineItemDistributionChannelAction, StagedOrderSetLineItemPriceAction, StagedOrderSetLineItemShippingDetailsAction, StagedOrderSetLineItemTaxAmountAction, StagedOrderSetLineItemTaxRateAction, StagedOrderSetLineItemTotalPriceAction, StagedOrderSetLocaleAction, StagedOrderSetOrderNumberAction, StagedOrderSetOrderTotalTaxAction, StagedOrderSetParcelCustomFieldAction, StagedOrderSetParcelCustomTypeAction, StagedOrderSetParcelItemsAction, StagedOrderSetParcelMeasurementsAction, StagedOrderSetParcelTrackingDataAction, StagedOrderSetPurchaseOrderNumberAction, StagedOrderSetReturnInfoAction, StagedOrderSetReturnItemCustomFieldAction, StagedOrderSetReturnItemCustomTypeAction, StagedOrderSetReturnPaymentStateAction, StagedOrderSetReturnShipmentStateAction, StagedOrderSetShippingAddressAction, StagedOrderSetShippingAddressAndCustomShippingMethodAction, StagedOrderSetShippingAddressAndShippingMethodAction, StagedOrderSetShippingAddressCustomFieldAction, StagedOrderSetShippingAddressCustomTypeAction, StagedOrderSetShippingCustomFieldAction, StagedOrderSetShippingCustomTypeAction, StagedOrderSetShippingMethodAction, StagedOrderSetShippingMethodTaxAmountAction, StagedOrderSetShippingMethodTaxRateAction, StagedOrderSetShippingRateInputAction, StagedOrderSetStoreAction, StagedOrderTransitionCustomLineItemStateAction, StagedOrderTransitionLineItemStateAction, StagedOrderTransitionStateAction, StagedOrderUpdateItemShippingAddressAction, StagedOrderUpdateSyncInfoAction } from './order-edit.js';
13
13
  import { PaymentReference, PaymentResourceIdentifier } from './payment.js';
@@ -19,6 +19,12 @@ import { StoreKeyReference, StoreResourceIdentifier } from './store.js';
19
19
  import { TaxCategoryResourceIdentifier, TaxRate } from './tax-category.js';
20
20
  import { CustomFields, CustomFieldsDraft, FieldContainer, TypeResourceIdentifier } from './type.js';
21
21
  export type StagedOrderUpdateAction = StagedOrderAddCustomLineItemAction | StagedOrderAddDeliveryAction | StagedOrderAddDiscountCodeAction | StagedOrderAddItemShippingAddressAction | StagedOrderAddLineItemAction | StagedOrderAddParcelToDeliveryAction | StagedOrderAddPaymentAction | StagedOrderAddReturnInfoAction | StagedOrderAddShoppingListAction | StagedOrderChangeCustomLineItemMoneyAction | StagedOrderChangeCustomLineItemQuantityAction | StagedOrderChangeLineItemQuantityAction | StagedOrderChangeOrderStateAction | StagedOrderChangePaymentStateAction | StagedOrderChangeShipmentStateAction | StagedOrderChangeTaxCalculationModeAction | StagedOrderChangeTaxModeAction | StagedOrderChangeTaxRoundingModeAction | StagedOrderImportCustomLineItemStateAction | StagedOrderImportLineItemStateAction | StagedOrderRemoveCustomLineItemAction | StagedOrderRemoveDeliveryAction | StagedOrderRemoveDiscountCodeAction | StagedOrderRemoveItemShippingAddressAction | StagedOrderRemoveLineItemAction | StagedOrderRemoveParcelFromDeliveryAction | StagedOrderRemovePaymentAction | StagedOrderSetBillingAddressAction | StagedOrderSetBillingAddressCustomFieldAction | StagedOrderSetBillingAddressCustomTypeAction | StagedOrderSetCountryAction | StagedOrderSetCustomFieldAction | StagedOrderSetCustomLineItemCustomFieldAction | StagedOrderSetCustomLineItemCustomTypeAction | StagedOrderSetCustomLineItemShippingDetailsAction | StagedOrderSetCustomLineItemTaxAmountAction | StagedOrderSetCustomLineItemTaxRateAction | StagedOrderSetCustomShippingMethodAction | StagedOrderSetCustomTypeAction | StagedOrderSetCustomerEmailAction | StagedOrderSetCustomerGroupAction | StagedOrderSetCustomerIdAction | StagedOrderSetDeliveryAddressAction | StagedOrderSetDeliveryAddressCustomFieldAction | StagedOrderSetDeliveryAddressCustomTypeAction | StagedOrderSetDeliveryCustomFieldAction | StagedOrderSetDeliveryCustomTypeAction | StagedOrderSetDeliveryItemsAction | StagedOrderSetDirectDiscountsAction | StagedOrderSetItemShippingAddressCustomFieldAction | StagedOrderSetItemShippingAddressCustomTypeAction | StagedOrderSetLineItemCustomFieldAction | StagedOrderSetLineItemCustomTypeAction | StagedOrderSetLineItemDistributionChannelAction | StagedOrderSetLineItemPriceAction | StagedOrderSetLineItemShippingDetailsAction | StagedOrderSetLineItemTaxAmountAction | StagedOrderSetLineItemTaxRateAction | StagedOrderSetLineItemTotalPriceAction | StagedOrderSetLocaleAction | StagedOrderSetOrderNumberAction | StagedOrderSetOrderTotalTaxAction | StagedOrderSetParcelCustomFieldAction | StagedOrderSetParcelCustomTypeAction | StagedOrderSetParcelItemsAction | StagedOrderSetParcelMeasurementsAction | StagedOrderSetParcelTrackingDataAction | StagedOrderSetPurchaseOrderNumberAction | StagedOrderSetReturnInfoAction | StagedOrderSetReturnItemCustomFieldAction | StagedOrderSetReturnItemCustomTypeAction | StagedOrderSetReturnPaymentStateAction | StagedOrderSetReturnShipmentStateAction | StagedOrderSetShippingAddressAction | StagedOrderSetShippingAddressAndCustomShippingMethodAction | StagedOrderSetShippingAddressAndShippingMethodAction | StagedOrderSetShippingAddressCustomFieldAction | StagedOrderSetShippingAddressCustomTypeAction | StagedOrderSetShippingCustomFieldAction | StagedOrderSetShippingCustomTypeAction | StagedOrderSetShippingMethodAction | StagedOrderSetShippingMethodTaxAmountAction | StagedOrderSetShippingMethodTaxRateAction | StagedOrderSetShippingRateInputAction | StagedOrderSetStoreAction | StagedOrderTransitionCustomLineItemStateAction | StagedOrderTransitionLineItemStateAction | StagedOrderTransitionStateAction | StagedOrderUpdateItemShippingAddressAction | StagedOrderUpdateSyncInfoAction;
22
+ export interface IStagedOrderUpdateAction {
23
+ /**
24
+ *
25
+ */
26
+ readonly action: string;
27
+ }
22
28
  export interface Hit {
23
29
  /**
24
30
  * Unique identifier of the Order.
@@ -61,9 +67,32 @@ export interface OrderPagedSearchResponse {
61
67
  readonly hits: Hit[];
62
68
  }
63
69
  /**
64
- * Possible values for the `customType` property on [query expressions](/../api/projects/order-search#query-expressions) indicating the data type of the `field`.
70
+ * Possible values for the `customType` property on [simple expressions](/../api/projects/order-search#simple-expressions) indicating the data type of the `field`.
65
71
  */
72
+ export declare enum OrderSearchCustomTypeValues {
73
+ BooleanType = "BooleanType",
74
+ DateTimeType = "DateTimeType",
75
+ DateType = "DateType",
76
+ EnumType = "EnumType",
77
+ LocalizedEnumType = "LocalizedEnumType",
78
+ LocalizedStringType = "LocalizedStringType",
79
+ NumberType = "NumberType",
80
+ SetTypeDateTimeType = "SetType.DateTimeType",
81
+ SetTypeDateType = "SetType.DateType",
82
+ SetTypeEnumType = "SetType.EnumType",
83
+ SetTypeLocalizedEnumType = "SetType.LocalizedEnumType",
84
+ SetTypeLocalizedStringType = "SetType.LocalizedStringType",
85
+ SetTypeNumberType = "SetType.NumberType",
86
+ SetTypeStringType = "SetType.StringType",
87
+ SetTypeTimeType = "SetType.TimeType",
88
+ StringType = "StringType",
89
+ TimeType = "TimeType"
90
+ }
66
91
  export type OrderSearchCustomType = 'BooleanType' | 'DateTimeType' | 'DateType' | 'EnumType' | 'LocalizedEnumType' | 'LocalizedStringType' | 'NumberType' | 'SetType.DateTimeType' | 'SetType.DateType' | 'SetType.EnumType' | 'SetType.LocalizedEnumType' | 'SetType.LocalizedStringType' | 'SetType.NumberType' | 'SetType.StringType' | 'SetType.TimeType' | 'StringType' | 'TimeType' | string;
92
+ export declare enum OrderSearchMatchTypeValues {
93
+ All = "all",
94
+ Any = "any"
95
+ }
67
96
  export type OrderSearchMatchType = 'all' | 'any' | string;
68
97
  export interface OrderSearchQueryExpressionValue {
69
98
  /**
@@ -75,7 +104,7 @@ export interface OrderSearchQueryExpressionValue {
75
104
  */
76
105
  readonly boost?: number;
77
106
  /**
78
- * Possible values for the `customType` property on [query expressions](/../api/projects/order-search#query-expressions) indicating the data type of the `field`.
107
+ * Possible values for the `customType` property on [simple expressions](/../api/projects/order-search#simple-expressions) indicating the data type of the `field`.
79
108
  *
80
109
  */
81
110
  readonly customType?: OrderSearchCustomType;
@@ -139,7 +168,17 @@ export interface OrderSearchNumberRangeValue extends OrderSearchQueryExpressionV
139
168
  */
140
169
  readonly lte?: number;
141
170
  }
171
+ export declare enum OrderSearchSortModeValues {
172
+ Avg = "avg",
173
+ Max = "max",
174
+ Min = "min",
175
+ Sum = "sum"
176
+ }
142
177
  export type OrderSearchSortMode = 'avg' | 'max' | 'min' | 'sum' | string;
178
+ export declare enum OrderSearchSortOrderValues {
179
+ Asc = "asc",
180
+ Desc = "desc"
181
+ }
143
182
  export type OrderSearchSortOrder = 'asc' | 'desc' | string;
144
183
  export interface OrderSearchStringValue extends OrderSearchQueryExpressionValue {
145
184
  /**
@@ -201,8 +240,7 @@ export interface CustomLineItemImportDraft {
201
240
  */
202
241
  readonly taxCategory?: TaxCategoryResourceIdentifier;
203
242
  /**
204
- * - If `Standard`, Cart Discounts with a matching [CartDiscountCustomLineItemsTarget](ctp:api:type:CartDiscountCustomLineItemsTarget)
205
- * are applied to the Custom Line Item.
243
+ * - If `Standard`, Cart Discounts with a matching [CartDiscountCustomLineItemsTarget](ctp:api:type:CartDiscountCustomLineItemsTarget), [MultiBuyCustomLineItemsTarget](ctp:api:type:MultiBuyCustomLineItemsTarget), or [CartDiscountPatternTarget](ctp:api:type:CartDiscountPatternTarget) are applied to the Custom Line Item.
206
244
  * - If `External`, Cart Discounts are not considered on the Custom Line Item.
207
245
  *
208
246
  *
@@ -828,7 +866,8 @@ export interface OrderFromCartDraft {
828
866
  export interface OrderFromQuoteDraft {
829
867
  /**
830
868
  * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to the Quote from which the Order is created.
831
- * If the referenced [Quote](ctp:api:type:Quote) has expired (`validTo` check) or its `quoteState` is `Accepted`, `Declined`, or `Withdrawn`, the Order creation will fail.
869
+ *
870
+ * The [Quote](ctp:api:type:Quote) must have the `Pending` [state](ctp:api:type:QuoteState) and must be valid (not past the `validTo` date).
832
871
  *
833
872
  *
834
873
  */
@@ -1098,7 +1137,7 @@ export interface OrderPagedQueryResponse {
1098
1137
  * [Reference](ctp:api:type:Reference) to an [Order](ctp:api:type:Order).
1099
1138
  *
1100
1139
  */
1101
- export interface OrderReference {
1140
+ export interface OrderReference extends IReference {
1102
1141
  readonly typeId: 'order';
1103
1142
  /**
1104
1143
  * Unique identifier of the referenced [Order](ctp:api:type:Order).
@@ -1242,6 +1281,12 @@ export interface OrderSearchSorting {
1242
1281
  * Indicates the state of the Order.
1243
1282
  *
1244
1283
  */
1284
+ export declare enum OrderStateValues {
1285
+ Cancelled = "Cancelled",
1286
+ Complete = "Complete",
1287
+ Confirmed = "Confirmed",
1288
+ Open = "Open"
1289
+ }
1245
1290
  export type OrderState = 'Cancelled' | 'Complete' | 'Confirmed' | 'Open' | string;
1246
1291
  export interface OrderUpdate {
1247
1292
  /**
@@ -1259,6 +1304,12 @@ export interface OrderUpdate {
1259
1304
  readonly actions: OrderUpdateAction[];
1260
1305
  }
1261
1306
  export type OrderUpdateAction = OrderAddDeliveryAction | OrderAddItemShippingAddressAction | OrderAddParcelToDeliveryAction | OrderAddPaymentAction | OrderAddReturnInfoAction | OrderChangeOrderStateAction | OrderChangePaymentStateAction | OrderChangeShipmentStateAction | OrderImportCustomLineItemStateAction | OrderImportLineItemStateAction | OrderRemoveDeliveryAction | OrderRemoveItemShippingAddressAction | OrderRemoveParcelFromDeliveryAction | OrderRemovePaymentAction | OrderSetBillingAddressAction | OrderSetBillingAddressCustomFieldAction | OrderSetBillingAddressCustomTypeAction | OrderSetCustomFieldAction | OrderSetCustomLineItemCustomFieldAction | OrderSetCustomLineItemCustomTypeAction | OrderSetCustomLineItemShippingDetailsAction | OrderSetCustomTypeAction | OrderSetCustomerEmailAction | OrderSetCustomerIdAction | OrderSetDeliveryAddressAction | OrderSetDeliveryAddressCustomFieldAction | OrderSetDeliveryAddressCustomTypeAction | OrderSetDeliveryCustomFieldAction | OrderSetDeliveryCustomTypeAction | OrderSetDeliveryItemsAction | OrderSetItemShippingAddressCustomFieldAction | OrderSetItemShippingAddressCustomTypeAction | OrderSetLineItemCustomFieldAction | OrderSetLineItemCustomTypeAction | OrderSetLineItemShippingDetailsAction | OrderSetLocaleAction | OrderSetOrderNumberAction | OrderSetParcelCustomFieldAction | OrderSetParcelCustomTypeAction | OrderSetParcelItemsAction | OrderSetParcelMeasurementsAction | OrderSetParcelTrackingDataAction | OrderSetPurchaseOrderNumberAction | OrderSetReturnInfoAction | OrderSetReturnItemCustomFieldAction | OrderSetReturnItemCustomTypeAction | OrderSetReturnPaymentStateAction | OrderSetReturnShipmentStateAction | OrderSetShippingAddressAction | OrderSetShippingAddressCustomFieldAction | OrderSetShippingAddressCustomTypeAction | OrderSetShippingCustomFieldAction | OrderSetShippingCustomTypeAction | OrderSetStoreAction | OrderTransitionCustomLineItemStateAction | OrderTransitionLineItemStateAction | OrderTransitionStateAction | OrderUpdateItemShippingAddressAction | OrderUpdateSyncInfoAction;
1307
+ export interface IOrderUpdateAction {
1308
+ /**
1309
+ *
1310
+ */
1311
+ readonly action: string;
1312
+ }
1262
1313
  /**
1263
1314
  * Information regarding the appearance, content, and shipment of a Parcel.
1264
1315
  *
@@ -1374,6 +1425,13 @@ export interface PaymentInfo {
1374
1425
  * Indicates the payment status for the Order.
1375
1426
  *
1376
1427
  */
1428
+ export declare enum PaymentStateValues {
1429
+ BalanceDue = "BalanceDue",
1430
+ CreditOwed = "CreditOwed",
1431
+ Failed = "Failed",
1432
+ Paid = "Paid",
1433
+ Pending = "Pending"
1434
+ }
1377
1435
  export type PaymentState = 'BalanceDue' | 'CreditOwed' | 'Failed' | 'Paid' | 'Pending' | string;
1378
1436
  /**
1379
1437
  * Contains the Product Variant to be used in the [LineItemImportDraft](ctp:api:type:LineItemImportDraft).
@@ -1461,7 +1519,69 @@ export interface ReturnInfoDraft {
1461
1519
  readonly returnDate?: string;
1462
1520
  }
1463
1521
  export type ReturnItem = CustomLineItemReturnItem | LineItemReturnItem;
1464
- export interface CustomLineItemReturnItem {
1522
+ export interface IReturnItem {
1523
+ /**
1524
+ * Unique identifier of the Return Item.
1525
+ *
1526
+ *
1527
+ */
1528
+ readonly id: string;
1529
+ /**
1530
+ * User-defined unique identifier of the Return Item.
1531
+ *
1532
+ */
1533
+ readonly key?: string;
1534
+ /**
1535
+ * Number of Line Items or Custom Line Items returned.
1536
+ *
1537
+ *
1538
+ */
1539
+ readonly quantity: number;
1540
+ /**
1541
+ *
1542
+ */
1543
+ readonly type: string;
1544
+ /**
1545
+ * User-defined description for the return.
1546
+ *
1547
+ *
1548
+ */
1549
+ readonly comment?: string;
1550
+ /**
1551
+ * Shipment status of the Return Item.
1552
+ *
1553
+ *
1554
+ */
1555
+ readonly shipmentState: ReturnShipmentState;
1556
+ /**
1557
+ * Payment status of the Return Item:
1558
+ *
1559
+ * - `NonRefundable`, for items in the `Advised` [ReturnShipmentState](ctp:api:type:ReturnShipmentState)
1560
+ * - `Initial`, for items in the `Returned` [ReturnShipmentState](ctp:api:type:ReturnShipmentState)
1561
+ *
1562
+ *
1563
+ */
1564
+ readonly paymentState: ReturnPaymentState;
1565
+ /**
1566
+ * Custom Fields of the Return Item.
1567
+ *
1568
+ *
1569
+ */
1570
+ readonly custom?: CustomFields;
1571
+ /**
1572
+ * Date and time (UTC) the Return Item was last updated.
1573
+ *
1574
+ *
1575
+ */
1576
+ readonly lastModifiedAt: string;
1577
+ /**
1578
+ * Date and time (UTC) the Return Item was intitially created.
1579
+ *
1580
+ *
1581
+ */
1582
+ readonly createdAt: string;
1583
+ }
1584
+ export interface CustomLineItemReturnItem extends IReturnItem {
1465
1585
  readonly type: 'CustomLineItemReturnItem';
1466
1586
  /**
1467
1587
  * Unique identifier of the Return Item.
@@ -1526,7 +1646,7 @@ export interface CustomLineItemReturnItem {
1526
1646
  */
1527
1647
  readonly customLineItemId: string;
1528
1648
  }
1529
- export interface LineItemReturnItem {
1649
+ export interface LineItemReturnItem extends IReturnItem {
1530
1650
  readonly type: 'LineItemReturnItem';
1531
1651
  /**
1532
1652
  * Unique identifier of the Return Item.
@@ -1639,13 +1759,35 @@ export interface ReturnItemDraft {
1639
1759
  */
1640
1760
  readonly custom?: CustomFieldsDraft;
1641
1761
  }
1762
+ export declare enum ReturnPaymentStateValues {
1763
+ Initial = "Initial",
1764
+ NonRefundable = "NonRefundable",
1765
+ NotRefunded = "NotRefunded",
1766
+ Refunded = "Refunded"
1767
+ }
1642
1768
  export type ReturnPaymentState = 'Initial' | 'NonRefundable' | 'NotRefunded' | 'Refunded' | string;
1769
+ export declare enum ReturnShipmentStateValues {
1770
+ Advised = "Advised",
1771
+ BackInStock = "BackInStock",
1772
+ Returned = "Returned",
1773
+ Unusable = "Unusable"
1774
+ }
1643
1775
  export type ReturnShipmentState = 'Advised' | 'BackInStock' | 'Returned' | 'Unusable' | string;
1644
1776
  /**
1645
1777
  * Indicates the shipment status of the Order.
1646
1778
  *
1647
1779
  */
1648
- export type ShipmentState = 'Backorder' | 'Delayed' | 'Delivered' | 'Partial' | 'Pending' | 'Ready' | 'Shipped' | string;
1780
+ export declare enum ShipmentStateValues {
1781
+ Backorder = "Backorder",
1782
+ Canceled = "Canceled",
1783
+ Delayed = "Delayed",
1784
+ Delivered = "Delivered",
1785
+ Partial = "Partial",
1786
+ Pending = "Pending",
1787
+ Ready = "Ready",
1788
+ Shipped = "Shipped"
1789
+ }
1790
+ export type ShipmentState = 'Backorder' | 'Canceled' | 'Delayed' | 'Delivered' | 'Partial' | 'Pending' | 'Ready' | 'Shipped' | string;
1649
1791
  /**
1650
1792
  * Becomes the `shippingInfo` of the imported Order.
1651
1793
  *
@@ -1786,7 +1928,7 @@ export interface TrackingData {
1786
1928
  * Produces the [Delivery Added](ctp:api:type:DeliveryAddedMessage) Message.
1787
1929
  *
1788
1930
  */
1789
- export interface OrderAddDeliveryAction {
1931
+ export interface OrderAddDeliveryAction extends IOrderUpdateAction {
1790
1932
  readonly action: 'addDelivery';
1791
1933
  /**
1792
1934
  * `key` of an existing [Delivery](ctp:api:type:Delivery).
@@ -1831,7 +1973,7 @@ export interface OrderAddDeliveryAction {
1831
1973
  * Adds an address to an Order when shipping to multiple addresses is desired.
1832
1974
  *
1833
1975
  */
1834
- export interface OrderAddItemShippingAddressAction {
1976
+ export interface OrderAddItemShippingAddressAction extends IOrderUpdateAction {
1835
1977
  readonly action: 'addItemShippingAddress';
1836
1978
  /**
1837
1979
  * Address to append to `itemShippingAddresses`.
@@ -1847,7 +1989,7 @@ export interface OrderAddItemShippingAddressAction {
1847
1989
  * Produces the [Parcel Added To Delivery](ctp:api:type:ParcelAddedToDeliveryMessage) Message.
1848
1990
  *
1849
1991
  */
1850
- export interface OrderAddParcelToDeliveryAction {
1992
+ export interface OrderAddParcelToDeliveryAction extends IOrderUpdateAction {
1851
1993
  readonly action: 'addParcelToDelivery';
1852
1994
  /**
1853
1995
  * `id` of an existing [Delivery](ctp:api:type:Delivery).
@@ -1896,7 +2038,7 @@ export interface OrderAddParcelToDeliveryAction {
1896
2038
  */
1897
2039
  readonly custom?: CustomFieldsDraft;
1898
2040
  }
1899
- export interface OrderAddPaymentAction {
2041
+ export interface OrderAddPaymentAction extends IOrderUpdateAction {
1900
2042
  readonly action: 'addPayment';
1901
2043
  /**
1902
2044
  * Payment to add to the [PaymentInfo](ctp:api:type:PaymentInfo).
@@ -1910,7 +2052,7 @@ export interface OrderAddPaymentAction {
1910
2052
  * Produces the [Return Info Added](ctp:api:type:ReturnInfoAddedMessage) Message.
1911
2053
  *
1912
2054
  */
1913
- export interface OrderAddReturnInfoAction {
2055
+ export interface OrderAddReturnInfoAction extends IOrderUpdateAction {
1914
2056
  readonly action: 'addReturnInfo';
1915
2057
  /**
1916
2058
  * Value to set.
@@ -1937,7 +2079,7 @@ export interface OrderAddReturnInfoAction {
1937
2079
  * Produces the [Order State Changed](ctp:api:type:OrderStateChangedMessage) Message.
1938
2080
  *
1939
2081
  */
1940
- export interface OrderChangeOrderStateAction {
2082
+ export interface OrderChangeOrderStateAction extends IOrderUpdateAction {
1941
2083
  readonly action: 'changeOrderState';
1942
2084
  /**
1943
2085
  * New status of the Order.
@@ -1950,7 +2092,7 @@ export interface OrderChangeOrderStateAction {
1950
2092
  * Produces the [Order Payment State Changed](ctp:api:type:OrderPaymentStateChangedMessage) Message.
1951
2093
  *
1952
2094
  */
1953
- export interface OrderChangePaymentStateAction {
2095
+ export interface OrderChangePaymentStateAction extends IOrderUpdateAction {
1954
2096
  readonly action: 'changePaymentState';
1955
2097
  /**
1956
2098
  * New payment status of the Order.
@@ -1963,7 +2105,7 @@ export interface OrderChangePaymentStateAction {
1963
2105
  * Produces the [Order Shipment State Changed](ctp:api:type:OrderShipmentStateChangedMessage) Message.
1964
2106
  *
1965
2107
  */
1966
- export interface OrderChangeShipmentStateAction {
2108
+ export interface OrderChangeShipmentStateAction extends IOrderUpdateAction {
1967
2109
  readonly action: 'changeShipmentState';
1968
2110
  /**
1969
2111
  * New shipment status of the Order.
@@ -1977,7 +2119,7 @@ export interface OrderChangeShipmentStateAction {
1977
2119
  * The `quantity` in the [ItemStates](ctp:api:type:ItemState) must match the sum of all Custom Line Item states' quantities.
1978
2120
  *
1979
2121
  */
1980
- export interface OrderImportCustomLineItemStateAction {
2122
+ export interface OrderImportCustomLineItemStateAction extends IOrderUpdateAction {
1981
2123
  readonly action: 'importCustomLineItemState';
1982
2124
  /**
1983
2125
  * `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
@@ -2003,7 +2145,7 @@ export interface OrderImportCustomLineItemStateAction {
2003
2145
  * The `quantity` in the [ItemStates](ctp:api:type:ItemState) must match the sum of all Line Items states' quantities.
2004
2146
  *
2005
2147
  */
2006
- export interface OrderImportLineItemStateAction {
2148
+ export interface OrderImportLineItemStateAction extends IOrderUpdateAction {
2007
2149
  readonly action: 'importLineItemState';
2008
2150
  /**
2009
2151
  * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
@@ -2028,7 +2170,7 @@ export interface OrderImportLineItemStateAction {
2028
2170
  * Produces the [DeliveryRemoved](ctp:api:type:DeliveryRemovedMessage) Message.
2029
2171
  *
2030
2172
  */
2031
- export interface OrderRemoveDeliveryAction {
2173
+ export interface OrderRemoveDeliveryAction extends IOrderUpdateAction {
2032
2174
  readonly action: 'removeDelivery';
2033
2175
  /**
2034
2176
  * `id` of an existing [Delivery](ctp:api:type:Delivery).
@@ -2052,7 +2194,7 @@ export interface OrderRemoveDeliveryAction {
2052
2194
  * In such case, change the Line Item shipping address to a different `addressKey` first using the [Set LineItemShippingDetails](ctp:api:type:OrderSetLineItemShippingDetailsAction) update action, before you remove the obsolete address.
2053
2195
  *
2054
2196
  */
2055
- export interface OrderRemoveItemShippingAddressAction {
2197
+ export interface OrderRemoveItemShippingAddressAction extends IOrderUpdateAction {
2056
2198
  readonly action: 'removeItemShippingAddress';
2057
2199
  /**
2058
2200
  * `key` of the Address to remove from `itemShippingAddresses`.
@@ -2065,7 +2207,7 @@ export interface OrderRemoveItemShippingAddressAction {
2065
2207
  * Produces the [ParcelRemovedFromDelivery](ctp:api:type:ParcelRemovedFromDeliveryMessage) Message.
2066
2208
  *
2067
2209
  */
2068
- export interface OrderRemoveParcelFromDeliveryAction {
2210
+ export interface OrderRemoveParcelFromDeliveryAction extends IOrderUpdateAction {
2069
2211
  readonly action: 'removeParcelFromDelivery';
2070
2212
  /**
2071
2213
  * `id` of an existing [Parcel](ctp:api:type:Parcel).
@@ -2084,7 +2226,7 @@ export interface OrderRemoveParcelFromDeliveryAction {
2084
2226
  */
2085
2227
  readonly parcelKey?: string;
2086
2228
  }
2087
- export interface OrderRemovePaymentAction {
2229
+ export interface OrderRemovePaymentAction extends IOrderUpdateAction {
2088
2230
  readonly action: 'removePayment';
2089
2231
  /**
2090
2232
  * Payment to remove from the [PaymentInfo](ctp:api:type:PaymentInfo).
@@ -2099,7 +2241,7 @@ export interface OrderRemovePaymentAction {
2099
2241
  * Produces the [Order Billing Address Set](ctp:api:type:OrderBillingAddressSetMessage) Message.
2100
2242
  *
2101
2243
  */
2102
- export interface OrderSetBillingAddressAction {
2244
+ export interface OrderSetBillingAddressAction extends IOrderUpdateAction {
2103
2245
  readonly action: 'setBillingAddress';
2104
2246
  /**
2105
2247
  * Value to set.
@@ -2109,7 +2251,7 @@ export interface OrderSetBillingAddressAction {
2109
2251
  */
2110
2252
  readonly address?: _BaseAddress;
2111
2253
  }
2112
- export interface OrderSetBillingAddressCustomFieldAction {
2254
+ export interface OrderSetBillingAddressCustomFieldAction extends IOrderUpdateAction {
2113
2255
  readonly action: 'setBillingAddressCustomField';
2114
2256
  /**
2115
2257
  * Name of the [Custom Field](/../api/projects/custom-fields).
@@ -2126,7 +2268,7 @@ export interface OrderSetBillingAddressCustomFieldAction {
2126
2268
  */
2127
2269
  readonly value?: any;
2128
2270
  }
2129
- export interface OrderSetBillingAddressCustomTypeAction {
2271
+ export interface OrderSetBillingAddressCustomTypeAction extends IOrderUpdateAction {
2130
2272
  readonly action: 'setBillingAddressCustomType';
2131
2273
  /**
2132
2274
  * Defines the [Type](ctp:api:type:Type) that extends the `billingAddress` with [Custom Fields](/../api/projects/custom-fields).
@@ -2142,7 +2284,7 @@ export interface OrderSetBillingAddressCustomTypeAction {
2142
2284
  */
2143
2285
  readonly fields?: FieldContainer;
2144
2286
  }
2145
- export interface OrderSetCustomFieldAction {
2287
+ export interface OrderSetCustomFieldAction extends IOrderUpdateAction {
2146
2288
  readonly action: 'setCustomField';
2147
2289
  /**
2148
2290
  * Name of the [Custom Field](/../api/projects/custom-fields).
@@ -2159,7 +2301,7 @@ export interface OrderSetCustomFieldAction {
2159
2301
  */
2160
2302
  readonly value?: any;
2161
2303
  }
2162
- export interface OrderSetCustomLineItemCustomFieldAction {
2304
+ export interface OrderSetCustomLineItemCustomFieldAction extends IOrderUpdateAction {
2163
2305
  readonly action: 'setCustomLineItemCustomField';
2164
2306
  /**
2165
2307
  * `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
@@ -2188,7 +2330,7 @@ export interface OrderSetCustomLineItemCustomFieldAction {
2188
2330
  */
2189
2331
  readonly value?: any;
2190
2332
  }
2191
- export interface OrderSetCustomLineItemCustomTypeAction {
2333
+ export interface OrderSetCustomLineItemCustomTypeAction extends IOrderUpdateAction {
2192
2334
  readonly action: 'setCustomLineItemCustomType';
2193
2335
  /**
2194
2336
  * `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
@@ -2216,7 +2358,7 @@ export interface OrderSetCustomLineItemCustomTypeAction {
2216
2358
  */
2217
2359
  readonly fields?: FieldContainer;
2218
2360
  }
2219
- export interface OrderSetCustomLineItemShippingDetailsAction {
2361
+ export interface OrderSetCustomLineItemShippingDetailsAction extends IOrderUpdateAction {
2220
2362
  readonly action: 'setCustomLineItemShippingDetails';
2221
2363
  /**
2222
2364
  * `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
@@ -2238,7 +2380,7 @@ export interface OrderSetCustomLineItemShippingDetailsAction {
2238
2380
  */
2239
2381
  readonly shippingDetails?: ItemShippingDetailsDraft;
2240
2382
  }
2241
- export interface OrderSetCustomTypeAction {
2383
+ export interface OrderSetCustomTypeAction extends IOrderUpdateAction {
2242
2384
  readonly action: 'setCustomType';
2243
2385
  /**
2244
2386
  * Defines the [Type](ctp:api:type:Type) that extends the Order with [Custom Fields](/../api/projects/custom-fields).
@@ -2260,7 +2402,7 @@ export interface OrderSetCustomTypeAction {
2260
2402
  * Produces the [Order Customer Email Set](ctp:api:type:OrderCustomerEmailSetMessage) Message.
2261
2403
  *
2262
2404
  */
2263
- export interface OrderSetCustomerEmailAction {
2405
+ export interface OrderSetCustomerEmailAction extends IOrderUpdateAction {
2264
2406
  readonly action: 'setCustomerEmail';
2265
2407
  /**
2266
2408
  * Value to set.
@@ -2277,7 +2419,7 @@ export interface OrderSetCustomerEmailAction {
2277
2419
  * Produces the [OrderCustomerSet](ctp:api:type:OrderCustomerSetMessage) Message.
2278
2420
  *
2279
2421
  */
2280
- export interface OrderSetCustomerIdAction {
2422
+ export interface OrderSetCustomerIdAction extends IOrderUpdateAction {
2281
2423
  readonly action: 'setCustomerId';
2282
2424
  /**
2283
2425
  * `id` of an existing [Customer](ctp:api:type:Customer).
@@ -2291,7 +2433,7 @@ export interface OrderSetCustomerIdAction {
2291
2433
  * Produces the [DeliveryAddressSet](ctp:api:type:DeliveryAddressSetMessage) Message.
2292
2434
  *
2293
2435
  */
2294
- export interface OrderSetDeliveryAddressAction {
2436
+ export interface OrderSetDeliveryAddressAction extends IOrderUpdateAction {
2295
2437
  readonly action: 'setDeliveryAddress';
2296
2438
  /**
2297
2439
  * `id` of an existing [Delivery](ctp:api:type:Delivery).
@@ -2317,7 +2459,7 @@ export interface OrderSetDeliveryAddressAction {
2317
2459
  */
2318
2460
  readonly address?: _BaseAddress;
2319
2461
  }
2320
- export interface OrderSetDeliveryAddressCustomFieldAction {
2462
+ export interface OrderSetDeliveryAddressCustomFieldAction extends IOrderUpdateAction {
2321
2463
  readonly action: 'setDeliveryAddressCustomField';
2322
2464
  /**
2323
2465
  * `id` of an existing [Delivery](ctp:api:type:Delivery).
@@ -2350,7 +2492,7 @@ export interface OrderSetDeliveryAddressCustomFieldAction {
2350
2492
  */
2351
2493
  readonly value?: any;
2352
2494
  }
2353
- export interface OrderSetDeliveryAddressCustomTypeAction {
2495
+ export interface OrderSetDeliveryAddressCustomTypeAction extends IOrderUpdateAction {
2354
2496
  readonly action: 'setDeliveryAddressCustomType';
2355
2497
  /**
2356
2498
  * `id` of an existing [Delivery](ctp:api:type:Delivery).
@@ -2382,7 +2524,7 @@ export interface OrderSetDeliveryAddressCustomTypeAction {
2382
2524
  */
2383
2525
  readonly fields?: FieldContainer;
2384
2526
  }
2385
- export interface OrderSetDeliveryCustomFieldAction {
2527
+ export interface OrderSetDeliveryCustomFieldAction extends IOrderUpdateAction {
2386
2528
  readonly action: 'setDeliveryCustomField';
2387
2529
  /**
2388
2530
  * `id` of an existing [Delivery](ctp:api:type:Delivery).
@@ -2415,7 +2557,7 @@ export interface OrderSetDeliveryCustomFieldAction {
2415
2557
  */
2416
2558
  readonly value?: any;
2417
2559
  }
2418
- export interface OrderSetDeliveryCustomTypeAction {
2560
+ export interface OrderSetDeliveryCustomTypeAction extends IOrderUpdateAction {
2419
2561
  readonly action: 'setDeliveryCustomType';
2420
2562
  /**
2421
2563
  * `id` of an existing [Delivery](ctp:api:type:Delivery).
@@ -2451,7 +2593,7 @@ export interface OrderSetDeliveryCustomTypeAction {
2451
2593
  * Produces the [Delivery Items Updated](ctp:api:type:DeliveryItemsUpdatedMessage) Message.
2452
2594
  *
2453
2595
  */
2454
- export interface OrderSetDeliveryItemsAction {
2596
+ export interface OrderSetDeliveryItemsAction extends IOrderUpdateAction {
2455
2597
  readonly action: 'setDeliveryItems';
2456
2598
  /**
2457
2599
  * `id` of an existing [Delivery](ctp:api:type:Delivery).
@@ -2477,7 +2619,7 @@ export interface OrderSetDeliveryItemsAction {
2477
2619
  */
2478
2620
  readonly items: DeliveryItem[];
2479
2621
  }
2480
- export interface OrderSetItemShippingAddressCustomFieldAction {
2622
+ export interface OrderSetItemShippingAddressCustomFieldAction extends IOrderUpdateAction {
2481
2623
  readonly action: 'setItemShippingAddressCustomField';
2482
2624
  /**
2483
2625
  * `key` of the [Address](ctp:api:type:Address) in `itemShippingAddresses`.
@@ -2500,7 +2642,7 @@ export interface OrderSetItemShippingAddressCustomFieldAction {
2500
2642
  */
2501
2643
  readonly value?: any;
2502
2644
  }
2503
- export interface OrderSetItemShippingAddressCustomTypeAction {
2645
+ export interface OrderSetItemShippingAddressCustomTypeAction extends IOrderUpdateAction {
2504
2646
  readonly action: 'setItemShippingAddressCustomType';
2505
2647
  /**
2506
2648
  * `key` of the [Address](ctp:api:type:Address) in `itemShippingAddresses`.
@@ -2522,7 +2664,7 @@ export interface OrderSetItemShippingAddressCustomTypeAction {
2522
2664
  */
2523
2665
  readonly fields?: FieldContainer;
2524
2666
  }
2525
- export interface OrderSetLineItemCustomFieldAction {
2667
+ export interface OrderSetLineItemCustomFieldAction extends IOrderUpdateAction {
2526
2668
  readonly action: 'setLineItemCustomField';
2527
2669
  /**
2528
2670
  * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
@@ -2551,7 +2693,7 @@ export interface OrderSetLineItemCustomFieldAction {
2551
2693
  */
2552
2694
  readonly value?: any;
2553
2695
  }
2554
- export interface OrderSetLineItemCustomTypeAction {
2696
+ export interface OrderSetLineItemCustomTypeAction extends IOrderUpdateAction {
2555
2697
  readonly action: 'setLineItemCustomType';
2556
2698
  /**
2557
2699
  * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
@@ -2579,7 +2721,7 @@ export interface OrderSetLineItemCustomTypeAction {
2579
2721
  */
2580
2722
  readonly fields?: FieldContainer;
2581
2723
  }
2582
- export interface OrderSetLineItemShippingDetailsAction {
2724
+ export interface OrderSetLineItemShippingDetailsAction extends IOrderUpdateAction {
2583
2725
  readonly action: 'setLineItemShippingDetails';
2584
2726
  /**
2585
2727
  * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
@@ -2601,7 +2743,7 @@ export interface OrderSetLineItemShippingDetailsAction {
2601
2743
  */
2602
2744
  readonly shippingDetails?: ItemShippingDetailsDraft;
2603
2745
  }
2604
- export interface OrderSetLocaleAction {
2746
+ export interface OrderSetLocaleAction extends IOrderUpdateAction {
2605
2747
  readonly action: 'setLocale';
2606
2748
  /**
2607
2749
  * Value to set.
@@ -2612,7 +2754,7 @@ export interface OrderSetLocaleAction {
2612
2754
  */
2613
2755
  readonly locale?: string;
2614
2756
  }
2615
- export interface OrderSetOrderNumberAction {
2757
+ export interface OrderSetOrderNumberAction extends IOrderUpdateAction {
2616
2758
  readonly action: 'setOrderNumber';
2617
2759
  /**
2618
2760
  * Value to set.
@@ -2623,7 +2765,7 @@ export interface OrderSetOrderNumberAction {
2623
2765
  */
2624
2766
  readonly orderNumber?: string;
2625
2767
  }
2626
- export interface OrderSetParcelCustomFieldAction {
2768
+ export interface OrderSetParcelCustomFieldAction extends IOrderUpdateAction {
2627
2769
  readonly action: 'setParcelCustomField';
2628
2770
  /**
2629
2771
  * `id` of an existing [Parcel](ctp:api:type:Parcel).
@@ -2656,7 +2798,7 @@ export interface OrderSetParcelCustomFieldAction {
2656
2798
  */
2657
2799
  readonly value?: any;
2658
2800
  }
2659
- export interface OrderSetParcelCustomTypeAction {
2801
+ export interface OrderSetParcelCustomTypeAction extends IOrderUpdateAction {
2660
2802
  readonly action: 'setParcelCustomType';
2661
2803
  /**
2662
2804
  * `id` of an existing [Parcel](ctp:api:type:Parcel).
@@ -2692,7 +2834,7 @@ export interface OrderSetParcelCustomTypeAction {
2692
2834
  * Produces the [ParcelItemsUpdated](ctp:api:type:ParcelItemsUpdatedMessage) Message.
2693
2835
  *
2694
2836
  */
2695
- export interface OrderSetParcelItemsAction {
2837
+ export interface OrderSetParcelItemsAction extends IOrderUpdateAction {
2696
2838
  readonly action: 'setParcelItems';
2697
2839
  /**
2698
2840
  * `id` of an existing [Parcel](ctp:api:type:Parcel).
@@ -2722,7 +2864,7 @@ export interface OrderSetParcelItemsAction {
2722
2864
  * Produces the [ParcelMeasurementsUpdated](ctp:api:type:ParcelMeasurementsUpdatedMessage) Message.
2723
2865
  *
2724
2866
  */
2725
- export interface OrderSetParcelMeasurementsAction {
2867
+ export interface OrderSetParcelMeasurementsAction extends IOrderUpdateAction {
2726
2868
  readonly action: 'setParcelMeasurements';
2727
2869
  /**
2728
2870
  * `id` of an existing [Parcel](ctp:api:type:Parcel).
@@ -2752,7 +2894,7 @@ export interface OrderSetParcelMeasurementsAction {
2752
2894
  * Produces the [ParcelTrackingDataUpdated](ctp:api:type:ParcelTrackingDataUpdatedMessage) Message.
2753
2895
  *
2754
2896
  */
2755
- export interface OrderSetParcelTrackingDataAction {
2897
+ export interface OrderSetParcelTrackingDataAction extends IOrderUpdateAction {
2756
2898
  readonly action: 'setParcelTrackingData';
2757
2899
  /**
2758
2900
  * `id` of an existing [Parcel](ctp:api:type:Parcel).
@@ -2782,7 +2924,7 @@ export interface OrderSetParcelTrackingDataAction {
2782
2924
  * Produces the [PurchaseOrderNumberSet](ctp:api:type:OrderPurchaseOrderNumberSetMessage) Message.
2783
2925
  *
2784
2926
  */
2785
- export interface OrderSetPurchaseOrderNumberAction {
2927
+ export interface OrderSetPurchaseOrderNumberAction extends IOrderUpdateAction {
2786
2928
  readonly action: 'setPurchaseOrderNumber';
2787
2929
  /**
2788
2930
  * Value to set.
@@ -2796,7 +2938,7 @@ export interface OrderSetPurchaseOrderNumberAction {
2796
2938
  * Produces the [Return Info Set](ctp:api:type:ReturnInfoSetMessage) Message.
2797
2939
  *
2798
2940
  */
2799
- export interface OrderSetReturnInfoAction {
2941
+ export interface OrderSetReturnInfoAction extends IOrderUpdateAction {
2800
2942
  readonly action: 'setReturnInfo';
2801
2943
  /**
2802
2944
  * Value to set.
@@ -2806,7 +2948,7 @@ export interface OrderSetReturnInfoAction {
2806
2948
  */
2807
2949
  readonly items?: ReturnInfoDraft[];
2808
2950
  }
2809
- export interface OrderSetReturnItemCustomFieldAction {
2951
+ export interface OrderSetReturnItemCustomFieldAction extends IOrderUpdateAction {
2810
2952
  readonly action: 'setReturnItemCustomField';
2811
2953
  /**
2812
2954
  * `id` of the [ReturnItem](ctp:api:type:ReturnItem) to update. Either `returnItemId` or `returnItemKey` is required.
@@ -2835,7 +2977,7 @@ export interface OrderSetReturnItemCustomFieldAction {
2835
2977
  */
2836
2978
  readonly value?: any;
2837
2979
  }
2838
- export interface OrderSetReturnItemCustomTypeAction {
2980
+ export interface OrderSetReturnItemCustomTypeAction extends IOrderUpdateAction {
2839
2981
  readonly action: 'setReturnItemCustomType';
2840
2982
  /**
2841
2983
  * `id` of the [ReturnItem](ctp:api:type:ReturnItem) to update. Either `returnItemId` or `returnItemKey` is required.
@@ -2867,7 +3009,7 @@ export interface OrderSetReturnItemCustomTypeAction {
2867
3009
  * To set a [ReturnPaymentState](ctp:api:type:ReturnPaymentState), the [Order](ctp:api:type:Order) `returnInfo` must have at least one [ReturnItem](ctp:api:type:ReturnItem).
2868
3010
  *
2869
3011
  */
2870
- export interface OrderSetReturnPaymentStateAction {
3012
+ export interface OrderSetReturnPaymentStateAction extends IOrderUpdateAction {
2871
3013
  readonly action: 'setReturnPaymentState';
2872
3014
  /**
2873
3015
  * `id` of the [ReturnItem](ctp:api:type:ReturnItem) to update. Either `returnItemId` or `returnItemKey` is required.
@@ -2894,7 +3036,7 @@ export interface OrderSetReturnPaymentStateAction {
2894
3036
  * Produces the [Order Return Shipment State Changed](ctp:api:type:OrderReturnShipmentStateChangedMessage) Message.
2895
3037
  *
2896
3038
  */
2897
- export interface OrderSetReturnShipmentStateAction {
3039
+ export interface OrderSetReturnShipmentStateAction extends IOrderUpdateAction {
2898
3040
  readonly action: 'setReturnShipmentState';
2899
3041
  /**
2900
3042
  * `id` of the [ReturnItem](ctp:api:type:ReturnItem) to update. Either `returnItemId` or `returnItemKey` is required.
@@ -2922,7 +3064,7 @@ export interface OrderSetReturnShipmentStateAction {
2922
3064
  * Produces the [Order Shipping Address Set](ctp:api:type:OrderShippingAddressSetMessage) Message.
2923
3065
  *
2924
3066
  */
2925
- export interface OrderSetShippingAddressAction {
3067
+ export interface OrderSetShippingAddressAction extends IOrderUpdateAction {
2926
3068
  readonly action: 'setShippingAddress';
2927
3069
  /**
2928
3070
  * Value to set.
@@ -2932,7 +3074,7 @@ export interface OrderSetShippingAddressAction {
2932
3074
  */
2933
3075
  readonly address?: _BaseAddress;
2934
3076
  }
2935
- export interface OrderSetShippingAddressCustomFieldAction {
3077
+ export interface OrderSetShippingAddressCustomFieldAction extends IOrderUpdateAction {
2936
3078
  readonly action: 'setShippingAddressCustomField';
2937
3079
  /**
2938
3080
  * Name of the [Custom Field](/../api/projects/custom-fields).
@@ -2949,7 +3091,7 @@ export interface OrderSetShippingAddressCustomFieldAction {
2949
3091
  */
2950
3092
  readonly value?: any;
2951
3093
  }
2952
- export interface OrderSetShippingAddressCustomTypeAction {
3094
+ export interface OrderSetShippingAddressCustomTypeAction extends IOrderUpdateAction {
2953
3095
  readonly action: 'setShippingAddressCustomType';
2954
3096
  /**
2955
3097
  * Defines the [Type](ctp:api:type:Type) that extends the `shippingAddress` with [Custom Fields](/../api/projects/custom-fields).
@@ -2965,7 +3107,7 @@ export interface OrderSetShippingAddressCustomTypeAction {
2965
3107
  */
2966
3108
  readonly fields?: FieldContainer;
2967
3109
  }
2968
- export interface OrderSetShippingCustomFieldAction {
3110
+ export interface OrderSetShippingCustomFieldAction extends IOrderUpdateAction {
2969
3111
  readonly action: 'setShippingCustomField';
2970
3112
  /**
2971
3113
  * The `shippingKey` of the [Shipping](ctp:api:type:Shipping) to customize. Used to specify which Shipping Method to customize
@@ -2994,7 +3136,7 @@ export interface OrderSetShippingCustomFieldAction {
2994
3136
  * This action sets, overwrites, or removes any existing Custom Type and Custom Fields for the Order's `shippingMethod` or `shipping`.
2995
3137
  *
2996
3138
  */
2997
- export interface OrderSetShippingCustomTypeAction {
3139
+ export interface OrderSetShippingCustomTypeAction extends IOrderUpdateAction {
2998
3140
  readonly action: 'setShippingCustomType';
2999
3141
  /**
3000
3142
  * The `shippingKey` of the [Shipping](ctp:api:type:Shipping) to customize. Used to specify which Shipping Method to customize
@@ -3027,7 +3169,7 @@ export interface OrderSetShippingCustomTypeAction {
3027
3169
  * Returns a `400` error if `store` references the same Store the Order is currently assigned to, including if you try to remove the value when no Store is currently assigned.
3028
3170
  *
3029
3171
  */
3030
- export interface OrderSetStoreAction {
3172
+ export interface OrderSetStoreAction extends IOrderUpdateAction {
3031
3173
  readonly action: 'setStore';
3032
3174
  /**
3033
3175
  * Value to set.
@@ -3043,7 +3185,7 @@ export interface OrderSetStoreAction {
3043
3185
  * Produces the [Custom Line Item State Transition](ctp:api:type:CustomLineItemStateTransitionMessage) Message.
3044
3186
  *
3045
3187
  */
3046
- export interface OrderTransitionCustomLineItemStateAction {
3188
+ export interface OrderTransitionCustomLineItemStateAction extends IOrderUpdateAction {
3047
3189
  readonly action: 'transitionCustomLineItemState';
3048
3190
  /**
3049
3191
  * `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
@@ -3086,7 +3228,7 @@ export interface OrderTransitionCustomLineItemStateAction {
3086
3228
  * Produces the [Line Item State Transition](ctp:api:type:LineItemStateTransitionMessage) Message.
3087
3229
  *
3088
3230
  */
3089
- export interface OrderTransitionLineItemStateAction {
3231
+ export interface OrderTransitionLineItemStateAction extends IOrderUpdateAction {
3090
3232
  readonly action: 'transitionLineItemState';
3091
3233
  /**
3092
3234
  * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
@@ -3132,7 +3274,7 @@ export interface OrderTransitionLineItemStateAction {
3132
3274
  * This update action produces the [Order State Transition](ctp:api:type:OrderStateTransitionMessage) Message.
3133
3275
  *
3134
3276
  */
3135
- export interface OrderTransitionStateAction {
3277
+ export interface OrderTransitionStateAction extends IOrderUpdateAction {
3136
3278
  readonly action: 'transitionState';
3137
3279
  /**
3138
3280
  * Value to set.
@@ -3152,7 +3294,7 @@ export interface OrderTransitionStateAction {
3152
3294
  * Updates an address in `itemShippingAddresses` by keeping the Address `key`.
3153
3295
  *
3154
3296
  */
3155
- export interface OrderUpdateItemShippingAddressAction {
3297
+ export interface OrderUpdateItemShippingAddressAction extends IOrderUpdateAction {
3156
3298
  readonly action: 'updateItemShippingAddress';
3157
3299
  /**
3158
3300
  * The new Address with the same `key` as the Address it will replace.
@@ -3161,7 +3303,7 @@ export interface OrderUpdateItemShippingAddressAction {
3161
3303
  */
3162
3304
  readonly address: _BaseAddress;
3163
3305
  }
3164
- export interface OrderUpdateSyncInfoAction {
3306
+ export interface OrderUpdateSyncInfoAction extends IOrderUpdateAction {
3165
3307
  readonly action: 'updateSyncInfo';
3166
3308
  /**
3167
3309
  * Set this to identify an external order instance, file, or other resource.