@salesforce/b2c-tooling-sdk 1.24.2 → 2.1.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 (482) hide show
  1. package/data/content-schemas/componenttype.json +0 -30
  2. package/data/scapi-snippets/campaign-promotions.js +40 -0
  3. package/data/scapi-snippets/code-version-inspect.js +31 -0
  4. package/data/scapi-snippets/create-product.js +108 -0
  5. package/data/scapi-snippets/failed-job-triage.js +37 -0
  6. package/data/scapi-snippets/job-execution-inspect.js +52 -0
  7. package/data/scapi-snippets/job-execution-review.js +46 -0
  8. package/data/scapi-snippets/manifest.json +220 -0
  9. package/data/scapi-snippets/site-cartridge-inspect.js +27 -0
  10. package/data/tooling/index.json +83 -119
  11. package/dist/esm/auth/index.d.ts +2 -2
  12. package/dist/esm/auth/index.js +1 -1
  13. package/dist/esm/auth/index.js.map +1 -1
  14. package/dist/esm/auth/oauth-implicit.d.ts +1 -0
  15. package/dist/esm/auth/oauth-implicit.js +1 -0
  16. package/dist/esm/auth/oauth-implicit.js.map +1 -1
  17. package/dist/esm/auth/oauth-jwt.d.ts +18 -4
  18. package/dist/esm/auth/oauth-jwt.js +67 -17
  19. package/dist/esm/auth/oauth-jwt.js.map +1 -1
  20. package/dist/esm/auth/oauth-pkce-fallback.d.ts +1 -0
  21. package/dist/esm/auth/oauth-pkce-fallback.js +1 -0
  22. package/dist/esm/auth/oauth-pkce-fallback.js.map +1 -1
  23. package/dist/esm/auth/oauth-pkce.d.ts +1 -0
  24. package/dist/esm/auth/oauth-pkce.js +1 -0
  25. package/dist/esm/auth/oauth-pkce.js.map +1 -1
  26. package/dist/esm/auth/oauth.d.ts +55 -6
  27. package/dist/esm/auth/oauth.js +139 -21
  28. package/dist/esm/auth/oauth.js.map +1 -1
  29. package/dist/esm/auth/resolve.d.ts +37 -0
  30. package/dist/esm/auth/resolve.js +48 -0
  31. package/dist/esm/auth/resolve.js.map +1 -1
  32. package/dist/esm/auth/types.d.ts +44 -0
  33. package/dist/esm/auth/types.js.map +1 -1
  34. package/dist/esm/cli/base-command.d.ts +9 -0
  35. package/dist/esm/cli/base-command.js +31 -0
  36. package/dist/esm/cli/base-command.js.map +1 -1
  37. package/dist/esm/cli/bm-command.d.ts +15 -0
  38. package/dist/esm/cli/bm-command.js +25 -0
  39. package/dist/esm/cli/bm-command.js.map +1 -0
  40. package/dist/esm/cli/code-command.d.ts +14 -0
  41. package/dist/esm/cli/code-command.js +22 -0
  42. package/dist/esm/cli/code-command.js.map +1 -0
  43. package/dist/esm/cli/config.js +10 -1
  44. package/dist/esm/cli/config.js.map +1 -1
  45. package/dist/esm/cli/index.d.ts +5 -1
  46. package/dist/esm/cli/index.js +7 -1
  47. package/dist/esm/cli/index.js.map +1 -1
  48. package/dist/esm/cli/instance-command.d.ts +45 -0
  49. package/dist/esm/cli/instance-command.js +66 -1
  50. package/dist/esm/cli/instance-command.js.map +1 -1
  51. package/dist/esm/cli/job-command.d.ts +37 -16
  52. package/dist/esm/cli/job-command.js +73 -23
  53. package/dist/esm/cli/job-command.js.map +1 -1
  54. package/dist/esm/cli/mrt-command.d.ts +154 -9
  55. package/dist/esm/cli/mrt-command.js +299 -16
  56. package/dist/esm/cli/mrt-command.js.map +1 -1
  57. package/dist/esm/cli/oauth-command.d.ts +1 -1
  58. package/dist/esm/cli/oauth-command.js +2 -0
  59. package/dist/esm/cli/oauth-command.js.map +1 -1
  60. package/dist/esm/cli/webdav-command.d.ts +2 -0
  61. package/dist/esm/cli/webdav-command.js +1 -0
  62. package/dist/esm/cli/webdav-command.js.map +1 -1
  63. package/dist/esm/clients/cdn-zones.js +2 -5
  64. package/dist/esm/clients/cdn-zones.js.map +1 -1
  65. package/dist/esm/clients/cip.d.ts +12 -3
  66. package/dist/esm/clients/cip.js +85 -30
  67. package/dist/esm/clients/cip.js.map +1 -1
  68. package/dist/esm/clients/custom-apis.js +2 -5
  69. package/dist/esm/clients/custom-apis.js.map +1 -1
  70. package/dist/esm/clients/dual-backend-factory.d.ts +70 -0
  71. package/dist/esm/clients/dual-backend-factory.js +48 -0
  72. package/dist/esm/clients/dual-backend-factory.js.map +1 -0
  73. package/dist/esm/clients/error-utils.d.ts +62 -0
  74. package/dist/esm/clients/error-utils.js +98 -0
  75. package/dist/esm/clients/error-utils.js.map +1 -1
  76. package/dist/esm/clients/granular-replications.js +2 -5
  77. package/dist/esm/clients/granular-replications.js.map +1 -1
  78. package/dist/esm/clients/index.d.ts +30 -3
  79. package/dist/esm/clients/index.js +25 -2
  80. package/dist/esm/clients/index.js.map +1 -1
  81. package/dist/esm/clients/metrics.js +2 -5
  82. package/dist/esm/clients/metrics.js.map +1 -1
  83. package/dist/esm/clients/middleware-registry.d.ts +4 -2
  84. package/dist/esm/clients/middleware-registry.js +3 -1
  85. package/dist/esm/clients/middleware-registry.js.map +1 -1
  86. package/dist/esm/clients/middleware.d.ts +39 -0
  87. package/dist/esm/clients/middleware.js +126 -25
  88. package/dist/esm/clients/middleware.js.map +1 -1
  89. package/dist/esm/clients/mrt-b2c.js +3 -0
  90. package/dist/esm/clients/mrt-b2c.js.map +1 -1
  91. package/dist/esm/clients/mrt.d.ts +27 -10
  92. package/dist/esm/clients/mrt.generated.d.ts +77 -0
  93. package/dist/esm/clients/mrt.js +68 -0
  94. package/dist/esm/clients/mrt.js.map +1 -1
  95. package/dist/esm/clients/preferences.js +2 -5
  96. package/dist/esm/clients/preferences.js.map +1 -1
  97. package/dist/esm/clients/scapi-backend-utils.d.ts +163 -0
  98. package/dist/esm/clients/scapi-backend-utils.js +180 -0
  99. package/dist/esm/clients/scapi-backend-utils.js.map +1 -0
  100. package/dist/esm/clients/scapi-catalogs.d.ts +12 -0
  101. package/dist/esm/clients/scapi-catalogs.generated.d.ts +104 -0
  102. package/dist/esm/clients/scapi-catalogs.generated.js +6 -0
  103. package/dist/esm/clients/scapi-catalogs.generated.js.map +1 -0
  104. package/dist/esm/clients/scapi-catalogs.js +14 -0
  105. package/dist/esm/clients/scapi-catalogs.js.map +1 -0
  106. package/dist/esm/clients/scapi-client-factory.d.ts +81 -0
  107. package/dist/esm/clients/scapi-client-factory.js +84 -0
  108. package/dist/esm/clients/scapi-client-factory.js.map +1 -0
  109. package/dist/esm/clients/scapi-fallback-backend.d.ts +34 -0
  110. package/dist/esm/clients/scapi-fallback-backend.js +132 -0
  111. package/dist/esm/clients/scapi-fallback-backend.js.map +1 -0
  112. package/dist/esm/clients/scapi-jobs.d.ts +32 -0
  113. package/dist/esm/clients/scapi-jobs.generated.d.ts +535 -0
  114. package/dist/esm/clients/scapi-jobs.generated.js +6 -0
  115. package/dist/esm/clients/scapi-jobs.generated.js.map +1 -0
  116. package/dist/esm/clients/scapi-jobs.js +24 -0
  117. package/dist/esm/clients/scapi-jobs.js.map +1 -0
  118. package/dist/esm/clients/scapi-merchant-roles.d.ts +19 -0
  119. package/dist/esm/clients/scapi-merchant-roles.generated.d.ts +726 -0
  120. package/dist/esm/clients/scapi-merchant-roles.generated.js +6 -0
  121. package/dist/esm/clients/scapi-merchant-roles.generated.js.map +1 -0
  122. package/dist/esm/clients/scapi-merchant-roles.js +12 -0
  123. package/dist/esm/clients/scapi-merchant-roles.js.map +1 -0
  124. package/dist/esm/clients/scapi-merchant-users.d.ts +19 -0
  125. package/dist/esm/clients/scapi-merchant-users.generated.d.ts +300 -0
  126. package/dist/esm/clients/scapi-merchant-users.generated.js +6 -0
  127. package/dist/esm/clients/scapi-merchant-users.generated.js.map +1 -0
  128. package/dist/esm/clients/scapi-merchant-users.js +12 -0
  129. package/dist/esm/clients/scapi-merchant-users.js.map +1 -0
  130. package/dist/esm/clients/scapi-schemas.js +2 -5
  131. package/dist/esm/clients/scapi-schemas.js.map +1 -1
  132. package/dist/esm/clients/scapi-scope-tier.d.ts +78 -0
  133. package/dist/esm/clients/scapi-scope-tier.js +113 -0
  134. package/dist/esm/clients/scapi-scope-tier.js.map +1 -0
  135. package/dist/esm/clients/scapi-scripts.d.ts +17 -0
  136. package/dist/esm/clients/scapi-scripts.generated.d.ts +392 -0
  137. package/dist/esm/clients/scapi-scripts.generated.js +6 -0
  138. package/dist/esm/clients/scapi-scripts.generated.js.map +1 -0
  139. package/dist/esm/clients/scapi-scripts.js +12 -0
  140. package/dist/esm/clients/scapi-scripts.js.map +1 -0
  141. package/dist/esm/clients/scapi-sites.d.ts +26 -0
  142. package/dist/esm/clients/scapi-sites.generated.d.ts +500 -0
  143. package/dist/esm/clients/scapi-sites.generated.js +6 -0
  144. package/dist/esm/clients/scapi-sites.generated.js.map +1 -0
  145. package/dist/esm/clients/scapi-sites.js +25 -0
  146. package/dist/esm/clients/scapi-sites.js.map +1 -0
  147. package/dist/esm/clients/slas-shopper.d.ts +19 -0
  148. package/dist/esm/clients/slas-shopper.generated.d.ts +165 -0
  149. package/dist/esm/clients/slas-shopper.generated.js +6 -0
  150. package/dist/esm/clients/slas-shopper.generated.js.map +1 -0
  151. package/dist/esm/clients/slas-shopper.js +35 -0
  152. package/dist/esm/clients/slas-shopper.js.map +1 -0
  153. package/dist/esm/clients/storefront-deployments.d.ts +57 -0
  154. package/dist/esm/clients/storefront-deployments.generated.d.ts +558 -0
  155. package/dist/esm/clients/storefront-deployments.generated.js +6 -0
  156. package/dist/esm/clients/storefront-deployments.generated.js.map +1 -0
  157. package/dist/esm/clients/storefront-deployments.js +24 -0
  158. package/dist/esm/clients/storefront-deployments.js.map +1 -0
  159. package/dist/esm/clients/storefront-environments.d.ts +56 -0
  160. package/dist/esm/clients/storefront-environments.generated.d.ts +208 -0
  161. package/dist/esm/clients/storefront-environments.generated.js +6 -0
  162. package/dist/esm/clients/storefront-environments.generated.js.map +1 -0
  163. package/dist/esm/clients/storefront-environments.js +24 -0
  164. package/dist/esm/clients/storefront-environments.js.map +1 -0
  165. package/dist/esm/clients/webdav.js +4 -1
  166. package/dist/esm/clients/webdav.js.map +1 -1
  167. package/dist/esm/compat/dispatcher.d.ts +49 -0
  168. package/dist/esm/compat/dispatcher.js +124 -0
  169. package/dist/esm/compat/dispatcher.js.map +1 -0
  170. package/dist/esm/compat/index.d.ts +10 -0
  171. package/dist/esm/compat/index.js +15 -0
  172. package/dist/esm/compat/index.js.map +1 -0
  173. package/dist/esm/compat/jobs-backend.d.ts +31 -0
  174. package/dist/esm/compat/jobs-backend.js +76 -0
  175. package/dist/esm/compat/jobs-backend.js.map +1 -0
  176. package/dist/esm/config/dw-json.d.ts +4 -0
  177. package/dist/esm/config/dw-json.js.map +1 -1
  178. package/dist/esm/config/index.d.ts +1 -1
  179. package/dist/esm/config/index.js.map +1 -1
  180. package/dist/esm/config/mapping.d.ts +2 -5
  181. package/dist/esm/config/mapping.js +25 -1
  182. package/dist/esm/config/mapping.js.map +1 -1
  183. package/dist/esm/config/resolved-config.d.ts +2 -2
  184. package/dist/esm/config/resolved-config.js.map +1 -1
  185. package/dist/esm/config/resolver.js +12 -0
  186. package/dist/esm/config/resolver.js.map +1 -1
  187. package/dist/esm/config/sources/env-source.d.ts +10 -1
  188. package/dist/esm/config/sources/env-source.js +46 -1
  189. package/dist/esm/config/sources/env-source.js.map +1 -1
  190. package/dist/esm/config/types.d.ts +22 -3
  191. package/dist/esm/docs/search.js +2 -25
  192. package/dist/esm/docs/search.js.map +1 -1
  193. package/dist/esm/guidance/catalog.d.ts +37 -0
  194. package/dist/esm/guidance/catalog.js +282 -0
  195. package/dist/esm/guidance/catalog.js.map +1 -0
  196. package/dist/esm/guidance/index.d.ts +8 -0
  197. package/dist/esm/guidance/index.js +14 -0
  198. package/dist/esm/guidance/index.js.map +1 -0
  199. package/dist/esm/guidance/markdown.d.ts +10 -0
  200. package/dist/esm/guidance/markdown.js +52 -0
  201. package/dist/esm/guidance/markdown.js.map +1 -0
  202. package/dist/esm/guidance/types.d.ts +96 -0
  203. package/dist/esm/guidance/types.js +17 -0
  204. package/dist/esm/guidance/types.js.map +1 -0
  205. package/dist/esm/index.d.ts +14 -5
  206. package/dist/esm/index.js +14 -2
  207. package/dist/esm/index.js.map +1 -1
  208. package/dist/esm/instance/index.d.ts +96 -2
  209. package/dist/esm/instance/index.js +98 -5
  210. package/dist/esm/instance/index.js.map +1 -1
  211. package/dist/esm/operations/bm-roles/backend.d.ts +4 -0
  212. package/dist/esm/operations/bm-roles/backend.js +11 -0
  213. package/dist/esm/operations/bm-roles/backend.js.map +1 -0
  214. package/dist/esm/operations/bm-roles/index.d.ts +6 -0
  215. package/dist/esm/operations/bm-roles/index.js +4 -0
  216. package/dist/esm/operations/bm-roles/index.js.map +1 -1
  217. package/dist/esm/operations/bm-roles/ocapi-backend.d.ts +17 -0
  218. package/dist/esm/operations/bm-roles/ocapi-backend.js +151 -0
  219. package/dist/esm/operations/bm-roles/ocapi-backend.js.map +1 -0
  220. package/dist/esm/operations/bm-roles/roles.js +13 -17
  221. package/dist/esm/operations/bm-roles/roles.js.map +1 -1
  222. package/dist/esm/operations/bm-roles/scapi-backend.d.ts +27 -0
  223. package/dist/esm/operations/bm-roles/scapi-backend.js +138 -0
  224. package/dist/esm/operations/bm-roles/scapi-backend.js.map +1 -0
  225. package/dist/esm/operations/bm-roles/types.d.ts +49 -0
  226. package/dist/esm/operations/bm-roles/types.js +2 -0
  227. package/dist/esm/operations/bm-roles/types.js.map +1 -0
  228. package/dist/esm/operations/bm-users/backend.d.ts +4 -0
  229. package/dist/esm/operations/bm-users/backend.js +11 -0
  230. package/dist/esm/operations/bm-users/backend.js.map +1 -0
  231. package/dist/esm/operations/bm-users/index.d.ts +11 -3
  232. package/dist/esm/operations/bm-users/index.js +9 -3
  233. package/dist/esm/operations/bm-users/index.js.map +1 -1
  234. package/dist/esm/operations/bm-users/ocapi-backend.d.ts +13 -0
  235. package/dist/esm/operations/bm-users/ocapi-backend.js +92 -0
  236. package/dist/esm/operations/bm-users/ocapi-backend.js.map +1 -0
  237. package/dist/esm/operations/bm-users/scapi-backend.d.ts +23 -0
  238. package/dist/esm/operations/bm-users/scapi-backend.js +199 -0
  239. package/dist/esm/operations/bm-users/scapi-backend.js.map +1 -0
  240. package/dist/esm/operations/bm-users/types.d.ts +99 -0
  241. package/dist/esm/operations/bm-users/types.js +2 -0
  242. package/dist/esm/operations/bm-users/types.js.map +1 -0
  243. package/dist/esm/operations/bm-users/users.d.ts +4 -3
  244. package/dist/esm/operations/bm-users/users.js +23 -19
  245. package/dist/esm/operations/bm-users/users.js.map +1 -1
  246. package/dist/esm/operations/cap/install.js +23 -45
  247. package/dist/esm/operations/cap/install.js.map +1 -1
  248. package/dist/esm/operations/cap/list.js +4 -8
  249. package/dist/esm/operations/cap/list.js.map +1 -1
  250. package/dist/esm/operations/cap/uninstall.js +17 -37
  251. package/dist/esm/operations/cap/uninstall.js.map +1 -1
  252. package/dist/esm/operations/catalogs/catalogs-backend.d.ts +4 -0
  253. package/dist/esm/operations/catalogs/catalogs-backend.js +16 -0
  254. package/dist/esm/operations/catalogs/catalogs-backend.js.map +1 -0
  255. package/dist/esm/operations/catalogs/catalogs-types.d.ts +14 -0
  256. package/dist/esm/operations/catalogs/catalogs-types.js +2 -0
  257. package/dist/esm/operations/catalogs/catalogs-types.js.map +1 -0
  258. package/dist/esm/operations/catalogs/index.d.ts +7 -0
  259. package/dist/esm/operations/catalogs/index.js +10 -0
  260. package/dist/esm/operations/catalogs/index.js.map +1 -0
  261. package/dist/esm/operations/catalogs/ocapi-catalogs-backend.d.ts +8 -0
  262. package/dist/esm/operations/catalogs/ocapi-catalogs-backend.js +36 -0
  263. package/dist/esm/operations/catalogs/ocapi-catalogs-backend.js.map +1 -0
  264. package/dist/esm/operations/catalogs/scapi-catalogs-backend.d.ts +15 -0
  265. package/dist/esm/operations/catalogs/scapi-catalogs-backend.js +42 -0
  266. package/dist/esm/operations/catalogs/scapi-catalogs-backend.js.map +1 -0
  267. package/dist/esm/operations/cip/index.js +10 -2
  268. package/dist/esm/operations/cip/index.js.map +1 -1
  269. package/dist/esm/operations/cip/reports.js +19 -3
  270. package/dist/esm/operations/cip/reports.js.map +1 -1
  271. package/dist/esm/operations/cip/types.d.ts +8 -4
  272. package/dist/esm/operations/code/deploy.d.ts +3 -0
  273. package/dist/esm/operations/code/deploy.js +9 -3
  274. package/dist/esm/operations/code/deploy.js.map +1 -1
  275. package/dist/esm/operations/code/download.d.ts +3 -0
  276. package/dist/esm/operations/code/download.js +5 -5
  277. package/dist/esm/operations/code/download.js.map +1 -1
  278. package/dist/esm/operations/code/index.d.ts +7 -1
  279. package/dist/esm/operations/code/index.js +5 -1
  280. package/dist/esm/operations/code/index.js.map +1 -1
  281. package/dist/esm/operations/code/ocapi-scripts-backend.d.ts +12 -0
  282. package/dist/esm/operations/code/ocapi-scripts-backend.js +40 -0
  283. package/dist/esm/operations/code/ocapi-scripts-backend.js.map +1 -0
  284. package/dist/esm/operations/code/scapi-scripts-backend.d.ts +22 -0
  285. package/dist/esm/operations/code/scapi-scripts-backend.js +94 -0
  286. package/dist/esm/operations/code/scapi-scripts-backend.js.map +1 -0
  287. package/dist/esm/operations/code/scripts-backend.d.ts +17 -0
  288. package/dist/esm/operations/code/scripts-backend.js +40 -0
  289. package/dist/esm/operations/code/scripts-backend.js.map +1 -0
  290. package/dist/esm/operations/code/scripts-types.d.ts +43 -0
  291. package/dist/esm/operations/code/scripts-types.js +2 -0
  292. package/dist/esm/operations/code/scripts-types.js.map +1 -0
  293. package/dist/esm/operations/code/upload-files.d.ts +6 -0
  294. package/dist/esm/operations/code/upload-files.js +58 -7
  295. package/dist/esm/operations/code/upload-files.js.map +1 -1
  296. package/dist/esm/operations/code/versions.d.ts +0 -20
  297. package/dist/esm/operations/code/versions.js +16 -51
  298. package/dist/esm/operations/code/versions.js.map +1 -1
  299. package/dist/esm/operations/code/watch.d.ts +3 -0
  300. package/dist/esm/operations/code/watch.js +3 -2
  301. package/dist/esm/operations/code/watch.js.map +1 -1
  302. package/dist/esm/operations/jobs/discover.d.ts +1 -1
  303. package/dist/esm/operations/jobs/discover.js +51 -21
  304. package/dist/esm/operations/jobs/discover.js.map +1 -1
  305. package/dist/esm/operations/jobs/index.d.ts +14 -57
  306. package/dist/esm/operations/jobs/index.js +15 -59
  307. package/dist/esm/operations/jobs/index.js.map +1 -1
  308. package/dist/esm/operations/jobs/ocapi-mapping.d.ts +34 -0
  309. package/dist/esm/operations/jobs/ocapi-mapping.js +100 -0
  310. package/dist/esm/operations/jobs/ocapi-mapping.js.map +1 -0
  311. package/dist/esm/operations/jobs/run-system-job.d.ts +81 -0
  312. package/dist/esm/operations/jobs/run-system-job.js +137 -0
  313. package/dist/esm/operations/jobs/run-system-job.js.map +1 -0
  314. package/dist/esm/operations/jobs/run.js +16 -4
  315. package/dist/esm/operations/jobs/run.js.map +1 -1
  316. package/dist/esm/operations/jobs/scapi-ops.d.ts +61 -0
  317. package/dist/esm/operations/jobs/scapi-ops.js +214 -0
  318. package/dist/esm/operations/jobs/scapi-ops.js.map +1 -0
  319. package/dist/esm/operations/jobs/site-archive.d.ts +7 -0
  320. package/dist/esm/operations/jobs/site-archive.js +28 -66
  321. package/dist/esm/operations/jobs/site-archive.js.map +1 -1
  322. package/dist/esm/operations/jobs/types.d.ts +46 -0
  323. package/dist/esm/operations/jobs/types.js +2 -0
  324. package/dist/esm/operations/jobs/types.js.map +1 -0
  325. package/dist/esm/operations/jobs/wait-canonical.d.ts +28 -0
  326. package/dist/esm/operations/jobs/wait-canonical.js +48 -0
  327. package/dist/esm/operations/jobs/wait-canonical.js.map +1 -0
  328. package/dist/esm/operations/mrt/bundle.d.ts +164 -2
  329. package/dist/esm/operations/mrt/bundle.js +315 -9
  330. package/dist/esm/operations/mrt/bundle.js.map +1 -1
  331. package/dist/esm/operations/mrt/deployment.d.ts +248 -0
  332. package/dist/esm/operations/mrt/deployment.js +252 -0
  333. package/dist/esm/operations/mrt/deployment.js.map +1 -1
  334. package/dist/esm/operations/mrt/env-var.d.ts +135 -0
  335. package/dist/esm/operations/mrt/env-var.js +203 -0
  336. package/dist/esm/operations/mrt/env-var.js.map +1 -1
  337. package/dist/esm/operations/mrt/index.d.ts +10 -8
  338. package/dist/esm/operations/mrt/index.js +6 -4
  339. package/dist/esm/operations/mrt/index.js.map +1 -1
  340. package/dist/esm/operations/mrt/mrt-backend.d.ts +117 -0
  341. package/dist/esm/operations/mrt/mrt-backend.js +84 -0
  342. package/dist/esm/operations/mrt/mrt-backend.js.map +1 -0
  343. package/dist/esm/operations/mrt/push.d.ts +285 -1
  344. package/dist/esm/operations/mrt/push.js +382 -1
  345. package/dist/esm/operations/mrt/push.js.map +1 -1
  346. package/dist/esm/operations/sites/cartridges.d.ts +10 -8
  347. package/dist/esm/operations/sites/cartridges.js +35 -67
  348. package/dist/esm/operations/sites/cartridges.js.map +1 -1
  349. package/dist/esm/operations/sites/index.d.ts +10 -6
  350. package/dist/esm/operations/sites/index.js +9 -6
  351. package/dist/esm/operations/sites/index.js.map +1 -1
  352. package/dist/esm/operations/sites/ocapi-sites-backend.d.ts +20 -0
  353. package/dist/esm/operations/sites/ocapi-sites-backend.js +98 -0
  354. package/dist/esm/operations/sites/ocapi-sites-backend.js.map +1 -0
  355. package/dist/esm/operations/sites/scapi-sites-backend.d.ts +33 -0
  356. package/dist/esm/operations/sites/scapi-sites-backend.js +166 -0
  357. package/dist/esm/operations/sites/scapi-sites-backend.js.map +1 -0
  358. package/dist/esm/operations/sites/sites-backend.d.ts +9 -0
  359. package/dist/esm/operations/sites/sites-backend.js +16 -0
  360. package/dist/esm/operations/sites/sites-backend.js.map +1 -0
  361. package/dist/esm/operations/sites/sites-scopes.d.ts +2 -0
  362. package/dist/esm/operations/sites/sites-scopes.js +16 -0
  363. package/dist/esm/operations/sites/sites-scopes.js.map +1 -0
  364. package/dist/esm/operations/sites/sites-types.d.ts +50 -0
  365. package/dist/esm/operations/sites/sites-types.js +2 -0
  366. package/dist/esm/operations/sites/sites-types.js.map +1 -0
  367. package/dist/esm/safety/safety-guard.d.ts +1 -0
  368. package/dist/esm/safety/safety-guard.js +2 -1
  369. package/dist/esm/safety/safety-guard.js.map +1 -1
  370. package/dist/esm/safety/safety-middleware.d.ts +7 -3
  371. package/dist/esm/safety/safety-middleware.js +13 -9
  372. package/dist/esm/safety/safety-middleware.js.map +1 -1
  373. package/dist/esm/safety/types.d.ts +2 -2
  374. package/dist/esm/scaffold/sources.js +6 -9
  375. package/dist/esm/scaffold/sources.js.map +1 -1
  376. package/dist/esm/scapi/auth-primitives.d.ts +3 -0
  377. package/dist/esm/scapi/auth-primitives.js +104 -0
  378. package/dist/esm/scapi/auth-primitives.js.map +1 -0
  379. package/dist/esm/scapi/authentication.d.ts +30 -0
  380. package/dist/esm/scapi/authentication.js +136 -0
  381. package/dist/esm/scapi/authentication.js.map +1 -0
  382. package/dist/esm/scapi/catalog.d.ts +29 -0
  383. package/dist/esm/scapi/catalog.js +81 -0
  384. package/dist/esm/scapi/catalog.js.map +1 -0
  385. package/dist/esm/scapi/index.d.ts +12 -0
  386. package/dist/esm/scapi/index.js +13 -0
  387. package/dist/esm/scapi/index.js.map +1 -0
  388. package/dist/esm/scapi/request.d.ts +28 -0
  389. package/dist/esm/scapi/request.js +273 -0
  390. package/dist/esm/scapi/request.js.map +1 -0
  391. package/dist/esm/scapi/runtime.d.ts +27 -0
  392. package/dist/esm/scapi/runtime.js +161 -0
  393. package/dist/esm/scapi/runtime.js.map +1 -0
  394. package/dist/esm/scapi/snippets.d.ts +22 -0
  395. package/dist/esm/scapi/snippets.js +140 -0
  396. package/dist/esm/scapi/snippets.js.map +1 -0
  397. package/dist/esm/scapi/worker-source.d.ts +2 -0
  398. package/dist/esm/scapi/worker-source.js +101 -0
  399. package/dist/esm/scapi/worker-source.js.map +1 -0
  400. package/dist/esm/search/ranking.d.ts +12 -0
  401. package/dist/esm/search/ranking.js +28 -0
  402. package/dist/esm/search/ranking.js.map +1 -0
  403. package/dist/esm/skills/sources.d.ts +2 -2
  404. package/dist/esm/skills/sources.js +18 -2
  405. package/dist/esm/skills/sources.js.map +1 -1
  406. package/dist/esm/skills/types.d.ts +1 -1
  407. package/dist/esm/slas/token.js +33 -94
  408. package/dist/esm/slas/token.js.map +1 -1
  409. package/dist/esm/slas/types.d.ts +5 -0
  410. package/dist/esm/test-utils/config-isolation.js +2 -2
  411. package/dist/esm/test-utils/config-isolation.js.map +1 -1
  412. package/node_modules/@salesforce/b2c-api-schemas/README.md +23 -0
  413. package/node_modules/@salesforce/b2c-api-schemas/manifest.json +576 -0
  414. package/node_modules/@salesforce/b2c-api-schemas/package.json +15 -0
  415. package/node_modules/@salesforce/b2c-api-schemas/scapi/cdn/zones/v1.json +11490 -0
  416. package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/orders/v1.json +3589 -0
  417. package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-baskets/v1.json +6544 -0
  418. package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-baskets/v2.json +7148 -0
  419. package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-orders/v1.json +4411 -0
  420. package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-payments/v1.json +643 -0
  421. package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/cors/v1.json +295 -0
  422. package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/preferences/v1.json +2036 -0
  423. package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/shopper-configurations/v1.json +327 -0
  424. package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/timeouts/v1.json +234 -0
  425. package/node_modules/@salesforce/b2c-api-schemas/scapi/custom-object/custom-objects/v1.json +1542 -0
  426. package/node_modules/@salesforce/b2c-api-schemas/scapi/custom-object/shopper-custom-objects/v1.json +405 -0
  427. package/node_modules/@salesforce/b2c-api-schemas/scapi/customer/customers/v1.json +2531 -0
  428. package/node_modules/@salesforce/b2c-api-schemas/scapi/customer/shopper-customers/v1.json +7944 -0
  429. package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/custom-apis/v1.json +292 -0
  430. package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/object-definitions/v1.json +2537 -0
  431. package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/scapi-schemas/v1.json +517 -0
  432. package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/scripts/v1.json +589 -0
  433. package/node_modules/@salesforce/b2c-api-schemas/scapi/experience/experiences/v1.json +3600 -0
  434. package/node_modules/@salesforce/b2c-api-schemas/scapi/experience/shopper-experience/v1.json +2319 -0
  435. package/node_modules/@salesforce/b2c-api-schemas/scapi/intelligence/analytics/v1.json +658 -0
  436. package/node_modules/@salesforce/b2c-api-schemas/scapi/inventory/availability/v1.json +2649 -0
  437. package/node_modules/@salesforce/b2c-api-schemas/scapi/inventory/impex/v1.json +6615 -0
  438. package/node_modules/@salesforce/b2c-api-schemas/scapi/inventory/reservation/v1.json +2103 -0
  439. package/node_modules/@salesforce/b2c-api-schemas/scapi/merchant/roles/v1.json +1760 -0
  440. package/node_modules/@salesforce/b2c-api-schemas/scapi/merchant/users/v1.json +640 -0
  441. package/node_modules/@salesforce/b2c-api-schemas/scapi/observability/metrics/v1.json +1263 -0
  442. package/node_modules/@salesforce/b2c-api-schemas/scapi/operation/jobs/v1.json +1259 -0
  443. package/node_modules/@salesforce/b2c-api-schemas/scapi/operation/replications/v1.json +760 -0
  444. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/assignments/v1.json +1047 -0
  445. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/campaigns/v1.json +1929 -0
  446. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/coupons/v1.json +1542 -0
  447. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/gift-certificates/v1.json +1093 -0
  448. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/promotions/v1.json +1324 -0
  449. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/shopper-gift-certificates/v1.json +325 -0
  450. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/shopper-promotions/v1.json +631 -0
  451. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/source-code-groups/v1.json +1036 -0
  452. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/catalogs/v1.json +5175 -0
  453. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/inventory-lists/v1.json +866 -0
  454. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/price-books/v1.json +747 -0
  455. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/products/v1.json +5076 -0
  456. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/shopper-availability/v1.json +509 -0
  457. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/shopper-delivery-estimates/v1.json +517 -0
  458. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/shopper-products/v1.json +2961 -0
  459. package/node_modules/@salesforce/b2c-api-schemas/scapi/search/shopper-search/v1.json +1889 -0
  460. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/auth/v1.json +7014 -0
  461. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/auth-admin/v1.json +1898 -0
  462. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/consents/v1.json +622 -0
  463. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/shopper-agents/v1.json +192 -0
  464. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/shopper-consents/v1.json +913 -0
  465. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/shopper-context/v1.json +630 -0
  466. package/node_modules/@salesforce/b2c-api-schemas/scapi/site/seo/v1.json +223 -0
  467. package/node_modules/@salesforce/b2c-api-schemas/scapi/site/shopper-seo/v1.json +423 -0
  468. package/node_modules/@salesforce/b2c-api-schemas/scapi/site/sites/v1.json +1088 -0
  469. package/node_modules/@salesforce/b2c-api-schemas/scapi/store/shopper-stores/v1.json +798 -0
  470. package/node_modules/@salesforce/b2c-api-schemas/scapi/store/store-redirect-mappings/v1.json +607 -0
  471. package/node_modules/@salesforce/b2c-api-schemas/scapi/store/stores/v1.json +1418 -0
  472. package/package.json +24 -3
  473. package/specs/dx-scripts-v1.yaml +409 -0
  474. package/specs/merchant-roles-v1.yaml +1085 -0
  475. package/specs/merchant-users-v1.yaml +398 -0
  476. package/specs/mrt-api-v1.json +105 -0
  477. package/specs/operations-jobs-v1.yaml +793 -0
  478. package/specs/product-catalogs-v1.yaml +111 -0
  479. package/specs/site-sites-v1.yaml +667 -0
  480. package/specs/slas-shopper-v1.yaml +83 -0
  481. package/specs/storefront-deployments-v1.yaml +630 -0
  482. package/specs/storefront-environments-v1.yaml +272 -0
@@ -0,0 +1,3589 @@
1
+ {
2
+ "openapi": "3.0.3",
3
+ "info": {
4
+ "title": "Orders",
5
+ "version": "1.5.3",
6
+ "x-api-type": "Admin",
7
+ "x-api-family": "Checkout"
8
+ },
9
+ "servers": [
10
+ {
11
+ "url": "https://{shortCode}.api.commercecloud.salesforce.com/checkout/orders/v1",
12
+ "variables": {
13
+ "shortCode": {
14
+ "default": "shortCode"
15
+ }
16
+ }
17
+ }
18
+ ],
19
+ "paths": {
20
+ "/organizations/{organizationId}/orders": {
21
+ "get": {
22
+ "operationId": "getOrders",
23
+ "parameters": [
24
+ {
25
+ "name": "organizationId",
26
+ "in": "path",
27
+ "required": true,
28
+ "style": "simple",
29
+ "explode": false,
30
+ "schema": {
31
+ "$ref": "#/components/schemas/OrganizationId"
32
+ }
33
+ },
34
+ {
35
+ "name": "sortBy",
36
+ "in": "query",
37
+ "required": false,
38
+ "style": "form",
39
+ "explode": true,
40
+ "schema": {
41
+ "type": "string",
42
+ "default": "creation_date",
43
+ "enum": [
44
+ "creation_date",
45
+ "last_modified_date"
46
+ ]
47
+ }
48
+ },
49
+ {
50
+ "name": "sortOrder",
51
+ "in": "query",
52
+ "required": false,
53
+ "style": "form",
54
+ "explode": true,
55
+ "schema": {
56
+ "type": "string",
57
+ "default": "desc",
58
+ "enum": [
59
+ "asc",
60
+ "desc"
61
+ ]
62
+ }
63
+ },
64
+ {
65
+ "name": "status",
66
+ "in": "query",
67
+ "required": false,
68
+ "style": "form",
69
+ "explode": true,
70
+ "schema": {
71
+ "type": "string"
72
+ }
73
+ },
74
+ {
75
+ "name": "exportStatus",
76
+ "in": "query",
77
+ "required": false,
78
+ "style": "form",
79
+ "explode": false,
80
+ "schema": {
81
+ "type": "array",
82
+ "items": {
83
+ "allOf": [
84
+ {
85
+ "$ref": "#/components/schemas/OrderExportStatus"
86
+ }
87
+ ]
88
+ },
89
+ "maxItems": 3
90
+ }
91
+ },
92
+ {
93
+ "name": "externalStatus",
94
+ "in": "query",
95
+ "required": false,
96
+ "style": "form",
97
+ "explode": true,
98
+ "schema": {
99
+ "type": "string"
100
+ }
101
+ },
102
+ {
103
+ "name": "confirmationStatus",
104
+ "in": "query",
105
+ "required": false,
106
+ "style": "form",
107
+ "explode": true,
108
+ "schema": {
109
+ "type": "string",
110
+ "enum": [
111
+ "confirmed",
112
+ "not_confirmed"
113
+ ]
114
+ }
115
+ },
116
+ {
117
+ "name": "paymentStatus",
118
+ "in": "query",
119
+ "required": false,
120
+ "style": "form",
121
+ "explode": false,
122
+ "schema": {
123
+ "type": "array",
124
+ "items": {
125
+ "allOf": [
126
+ {
127
+ "$ref": "#/components/schemas/OrderPaymentStatus"
128
+ }
129
+ ]
130
+ },
131
+ "maxItems": 3
132
+ }
133
+ },
134
+ {
135
+ "name": "shippingStatus",
136
+ "in": "query",
137
+ "required": false,
138
+ "style": "form",
139
+ "explode": false,
140
+ "schema": {
141
+ "type": "array",
142
+ "items": {
143
+ "allOf": [
144
+ {
145
+ "$ref": "#/components/schemas/OrderShippingStatus"
146
+ }
147
+ ]
148
+ },
149
+ "maxItems": 3
150
+ }
151
+ },
152
+ {
153
+ "name": "creationDateFrom",
154
+ "in": "query",
155
+ "required": false,
156
+ "style": "form",
157
+ "explode": true,
158
+ "schema": {
159
+ "type": "string",
160
+ "format": "date-time"
161
+ }
162
+ },
163
+ {
164
+ "name": "creationDateTo",
165
+ "in": "query",
166
+ "required": false,
167
+ "style": "form",
168
+ "explode": true,
169
+ "schema": {
170
+ "type": "string",
171
+ "format": "date-time"
172
+ }
173
+ },
174
+ {
175
+ "name": "lastModifiedDateFrom",
176
+ "in": "query",
177
+ "required": false,
178
+ "style": "form",
179
+ "explode": true,
180
+ "schema": {
181
+ "type": "string",
182
+ "format": "date-time"
183
+ }
184
+ },
185
+ {
186
+ "name": "lastModifiedDateTo",
187
+ "in": "query",
188
+ "required": false,
189
+ "style": "form",
190
+ "explode": true,
191
+ "schema": {
192
+ "type": "string",
193
+ "format": "date-time"
194
+ }
195
+ },
196
+ {
197
+ "name": "siteId",
198
+ "in": "query",
199
+ "required": true,
200
+ "style": "form",
201
+ "explode": true,
202
+ "schema": {
203
+ "$ref": "#/components/schemas/SiteId"
204
+ }
205
+ },
206
+ {
207
+ "name": "limit",
208
+ "in": "query",
209
+ "required": false,
210
+ "style": "form",
211
+ "explode": true,
212
+ "schema": {
213
+ "type": "integer",
214
+ "format": "int32",
215
+ "default": 100,
216
+ "maximum": 200,
217
+ "minimum": 1
218
+ }
219
+ },
220
+ {
221
+ "name": "offset",
222
+ "in": "query",
223
+ "required": false,
224
+ "style": "form",
225
+ "explode": true,
226
+ "schema": {
227
+ "type": "integer",
228
+ "format": "int32",
229
+ "default": 0,
230
+ "minimum": 0
231
+ }
232
+ }
233
+ ],
234
+ "responses": {
235
+ "200": {
236
+ "description": "Order details returned successfully.",
237
+ "content": {
238
+ "application/json": {
239
+ "schema": {
240
+ "$ref": "#/components/schemas/OrdersResponse"
241
+ }
242
+ }
243
+ }
244
+ },
245
+ "404": {
246
+ "description": "The given site ID does not reference an existing site.\n",
247
+ "content": {
248
+ "application/json": {
249
+ "schema": {
250
+ "$ref": "#/components/schemas/ErrorResponse"
251
+ }
252
+ }
253
+ }
254
+ }
255
+ },
256
+ "security": [
257
+ {
258
+ "AmOAuth2": [
259
+ "sfcc.orders",
260
+ "sfcc.orders.rw"
261
+ ]
262
+ }
263
+ ]
264
+ },
265
+ "post": {
266
+ "operationId": "createOrders",
267
+ "parameters": [
268
+ {
269
+ "name": "organizationId",
270
+ "in": "path",
271
+ "required": true,
272
+ "style": "simple",
273
+ "explode": false,
274
+ "schema": {
275
+ "$ref": "#/components/schemas/OrganizationId"
276
+ }
277
+ },
278
+ {
279
+ "name": "siteId",
280
+ "in": "query",
281
+ "required": true,
282
+ "style": "form",
283
+ "explode": true,
284
+ "schema": {
285
+ "$ref": "#/components/schemas/SiteId"
286
+ }
287
+ }
288
+ ],
289
+ "requestBody": {
290
+ "content": {
291
+ "application/json": {
292
+ "schema": {
293
+ "$ref": "#/components/schemas/CreateOrderRequest"
294
+ }
295
+ }
296
+ }
297
+ },
298
+ "responses": {
299
+ "201": {
300
+ "description": "Order created successfully. No content returned.\n",
301
+ "headers": {
302
+ "Location": {
303
+ "style": "simple",
304
+ "explode": false,
305
+ "schema": {
306
+ "type": "string"
307
+ }
308
+ }
309
+ }
310
+ },
311
+ "400": {
312
+ "description": "The passed taxTotal is not equal to the calculated taxTotal.\n",
313
+ "content": {
314
+ "application/json": {
315
+ "schema": {
316
+ "$ref": "#/components/schemas/ErrorResponse"
317
+ }
318
+ }
319
+ }
320
+ },
321
+ "404": {
322
+ "description": "The given shipment ID does not reference an existing shipment.\n",
323
+ "content": {
324
+ "application/json": {
325
+ "schema": {
326
+ "$ref": "#/components/schemas/ErrorResponse"
327
+ }
328
+ }
329
+ }
330
+ }
331
+ },
332
+ "security": [
333
+ {
334
+ "ShopperTokenTsob": [
335
+ "sfcc.orders.rw"
336
+ ]
337
+ }
338
+ ]
339
+ }
340
+ },
341
+ "/organizations/{organizationId}/orders/{orderNo}": {
342
+ "get": {
343
+ "operationId": "getOrder",
344
+ "parameters": [
345
+ {
346
+ "name": "orderNo",
347
+ "in": "path",
348
+ "required": true,
349
+ "style": "simple",
350
+ "explode": false,
351
+ "schema": {
352
+ "$ref": "#/components/schemas/OrderNo"
353
+ }
354
+ },
355
+ {
356
+ "name": "organizationId",
357
+ "in": "path",
358
+ "required": true,
359
+ "style": "simple",
360
+ "explode": false,
361
+ "schema": {
362
+ "$ref": "#/components/schemas/OrganizationId"
363
+ }
364
+ },
365
+ {
366
+ "name": "siteId",
367
+ "in": "query",
368
+ "required": true,
369
+ "style": "form",
370
+ "explode": true,
371
+ "schema": {
372
+ "$ref": "#/components/schemas/SiteId"
373
+ }
374
+ }
375
+ ],
376
+ "responses": {
377
+ "200": {
378
+ "description": "Order details returned successfully.",
379
+ "content": {
380
+ "application/json": {
381
+ "schema": {
382
+ "$ref": "#/components/schemas/Order"
383
+ }
384
+ }
385
+ }
386
+ },
387
+ "404": {
388
+ "description": "The given site ID does not reference an existing site.\n",
389
+ "content": {
390
+ "application/json": {
391
+ "schema": {
392
+ "$ref": "#/components/schemas/ErrorResponse"
393
+ }
394
+ }
395
+ }
396
+ }
397
+ },
398
+ "security": [
399
+ {
400
+ "AmOAuth2": [
401
+ "sfcc.orders",
402
+ "sfcc.orders.rw"
403
+ ]
404
+ }
405
+ ]
406
+ },
407
+ "patch": {
408
+ "operationId": "updateOrder",
409
+ "parameters": [
410
+ {
411
+ "name": "orderNo",
412
+ "in": "path",
413
+ "required": true,
414
+ "style": "simple",
415
+ "explode": false,
416
+ "schema": {
417
+ "$ref": "#/components/schemas/OrderNo"
418
+ }
419
+ },
420
+ {
421
+ "name": "organizationId",
422
+ "in": "path",
423
+ "required": true,
424
+ "style": "simple",
425
+ "explode": false,
426
+ "schema": {
427
+ "$ref": "#/components/schemas/OrganizationId"
428
+ }
429
+ },
430
+ {
431
+ "name": "siteId",
432
+ "in": "query",
433
+ "required": true,
434
+ "style": "form",
435
+ "explode": true,
436
+ "schema": {
437
+ "$ref": "#/components/schemas/SiteId"
438
+ }
439
+ }
440
+ ],
441
+ "requestBody": {
442
+ "content": {
443
+ "application/json": {
444
+ "schema": {
445
+ "$ref": "#/components/schemas/OrderUpdateRequest"
446
+ }
447
+ }
448
+ }
449
+ },
450
+ "responses": {
451
+ "204": {
452
+ "description": "Order updated successfully. No content returned.\n"
453
+ },
454
+ "400": {
455
+ "description": "Request body or path violate required syntax.\n",
456
+ "content": {
457
+ "application/json": {
458
+ "schema": {
459
+ "$ref": "#/components/schemas/ErrorResponse"
460
+ }
461
+ }
462
+ }
463
+ },
464
+ "404": {
465
+ "description": "The given site ID does not reference an existing site.\n",
466
+ "content": {
467
+ "application/json": {
468
+ "schema": {
469
+ "$ref": "#/components/schemas/ErrorResponse"
470
+ }
471
+ }
472
+ }
473
+ }
474
+ },
475
+ "security": [
476
+ {
477
+ "AmOAuth2": [
478
+ "sfcc.orders.rw"
479
+ ]
480
+ },
481
+ {
482
+ "ShopperTokenTsob": [
483
+ "sfcc.orders.rw"
484
+ ]
485
+ }
486
+ ]
487
+ }
488
+ },
489
+ "/organizations/{organizationId}/orders/{orderNo}/confirmation-status": {
490
+ "put": {
491
+ "operationId": "updateOrderConfirmationStatus",
492
+ "parameters": [
493
+ {
494
+ "name": "organizationId",
495
+ "in": "path",
496
+ "required": true,
497
+ "style": "simple",
498
+ "explode": false,
499
+ "schema": {
500
+ "$ref": "#/components/schemas/OrganizationId"
501
+ }
502
+ },
503
+ {
504
+ "name": "orderNo",
505
+ "in": "path",
506
+ "required": true,
507
+ "style": "simple",
508
+ "explode": false,
509
+ "schema": {
510
+ "$ref": "#/components/schemas/OrderNo"
511
+ }
512
+ },
513
+ {
514
+ "name": "siteId",
515
+ "in": "query",
516
+ "required": true,
517
+ "style": "form",
518
+ "explode": true,
519
+ "schema": {
520
+ "$ref": "#/components/schemas/SiteId"
521
+ }
522
+ }
523
+ ],
524
+ "requestBody": {
525
+ "content": {
526
+ "application/json": {
527
+ "schema": {
528
+ "$ref": "#/components/schemas/OrderConfirmationStatusUpdateRequest"
529
+ }
530
+ }
531
+ }
532
+ },
533
+ "responses": {
534
+ "204": {
535
+ "description": "Order confirmation status updated successfully. No content returned.\n"
536
+ },
537
+ "400": {
538
+ "description": "Request body or path violate required syntax.\n",
539
+ "content": {
540
+ "application/json": {
541
+ "schema": {
542
+ "$ref": "#/components/schemas/ErrorResponse"
543
+ }
544
+ }
545
+ }
546
+ },
547
+ "404": {
548
+ "description": "The given site ID does not reference an existing site.\n",
549
+ "content": {
550
+ "application/json": {
551
+ "schema": {
552
+ "$ref": "#/components/schemas/ErrorResponse"
553
+ }
554
+ }
555
+ }
556
+ }
557
+ },
558
+ "security": [
559
+ {
560
+ "AmOAuth2": [
561
+ "sfcc.orders.rw"
562
+ ]
563
+ }
564
+ ]
565
+ }
566
+ },
567
+ "/organizations/{organizationId}/orders/{orderNo}/export-status": {
568
+ "put": {
569
+ "operationId": "updateOrderExportStatus",
570
+ "parameters": [
571
+ {
572
+ "name": "organizationId",
573
+ "in": "path",
574
+ "required": true,
575
+ "style": "simple",
576
+ "explode": false,
577
+ "schema": {
578
+ "$ref": "#/components/schemas/OrganizationId"
579
+ }
580
+ },
581
+ {
582
+ "name": "orderNo",
583
+ "in": "path",
584
+ "required": true,
585
+ "style": "simple",
586
+ "explode": false,
587
+ "schema": {
588
+ "$ref": "#/components/schemas/OrderNo"
589
+ }
590
+ },
591
+ {
592
+ "name": "siteId",
593
+ "in": "query",
594
+ "required": true,
595
+ "style": "form",
596
+ "explode": true,
597
+ "schema": {
598
+ "$ref": "#/components/schemas/SiteId"
599
+ }
600
+ }
601
+ ],
602
+ "requestBody": {
603
+ "content": {
604
+ "application/json": {
605
+ "schema": {
606
+ "$ref": "#/components/schemas/OrderExportStatusUpdateRequest"
607
+ }
608
+ }
609
+ }
610
+ },
611
+ "responses": {
612
+ "204": {
613
+ "description": "Order export status updated successfully. No content returned.\n"
614
+ },
615
+ "400": {
616
+ "description": "Request body or path violate required syntax.\n",
617
+ "content": {
618
+ "application/json": {
619
+ "schema": {
620
+ "$ref": "#/components/schemas/ErrorResponse"
621
+ }
622
+ }
623
+ }
624
+ },
625
+ "404": {
626
+ "description": "The given site ID does not reference an existing site.\n",
627
+ "content": {
628
+ "application/json": {
629
+ "schema": {
630
+ "$ref": "#/components/schemas/ErrorResponse"
631
+ }
632
+ }
633
+ }
634
+ }
635
+ },
636
+ "security": [
637
+ {
638
+ "AmOAuth2": [
639
+ "sfcc.orders.rw"
640
+ ]
641
+ }
642
+ ]
643
+ }
644
+ },
645
+ "/organizations/{organizationId}/orders/{orderNo}/external-status": {
646
+ "put": {
647
+ "operationId": "updateOrderExternalStatus",
648
+ "parameters": [
649
+ {
650
+ "name": "organizationId",
651
+ "in": "path",
652
+ "required": true,
653
+ "style": "simple",
654
+ "explode": false,
655
+ "schema": {
656
+ "$ref": "#/components/schemas/OrganizationId"
657
+ }
658
+ },
659
+ {
660
+ "name": "orderNo",
661
+ "in": "path",
662
+ "required": true,
663
+ "style": "simple",
664
+ "explode": false,
665
+ "schema": {
666
+ "$ref": "#/components/schemas/OrderNo"
667
+ }
668
+ },
669
+ {
670
+ "name": "siteId",
671
+ "in": "query",
672
+ "required": true,
673
+ "style": "form",
674
+ "explode": true,
675
+ "schema": {
676
+ "$ref": "#/components/schemas/SiteId"
677
+ }
678
+ }
679
+ ],
680
+ "requestBody": {
681
+ "content": {
682
+ "application/json": {
683
+ "schema": {
684
+ "$ref": "#/components/schemas/OrderExternalStatusUpdateRequest"
685
+ }
686
+ }
687
+ }
688
+ },
689
+ "responses": {
690
+ "204": {
691
+ "description": "Order external status updated successfully. No content returned.\n"
692
+ },
693
+ "400": {
694
+ "description": "Request body or path violate required syntax.\n",
695
+ "content": {
696
+ "application/json": {
697
+ "schema": {
698
+ "$ref": "#/components/schemas/ErrorResponse"
699
+ }
700
+ }
701
+ }
702
+ },
703
+ "404": {
704
+ "description": "The given site ID does not reference an existing site.\n",
705
+ "content": {
706
+ "application/json": {
707
+ "schema": {
708
+ "$ref": "#/components/schemas/ErrorResponse"
709
+ }
710
+ }
711
+ }
712
+ }
713
+ },
714
+ "security": [
715
+ {
716
+ "AmOAuth2": [
717
+ "sfcc.orders.rw"
718
+ ]
719
+ }
720
+ ]
721
+ }
722
+ },
723
+ "/organizations/{organizationId}/orders/{orderNo}/payment-status": {
724
+ "put": {
725
+ "operationId": "updateOrderPaymentStatus",
726
+ "parameters": [
727
+ {
728
+ "name": "organizationId",
729
+ "in": "path",
730
+ "required": true,
731
+ "style": "simple",
732
+ "explode": false,
733
+ "schema": {
734
+ "$ref": "#/components/schemas/OrganizationId"
735
+ }
736
+ },
737
+ {
738
+ "name": "orderNo",
739
+ "in": "path",
740
+ "required": true,
741
+ "style": "simple",
742
+ "explode": false,
743
+ "schema": {
744
+ "$ref": "#/components/schemas/OrderNo"
745
+ }
746
+ },
747
+ {
748
+ "name": "siteId",
749
+ "in": "query",
750
+ "required": true,
751
+ "style": "form",
752
+ "explode": true,
753
+ "schema": {
754
+ "$ref": "#/components/schemas/SiteId"
755
+ }
756
+ }
757
+ ],
758
+ "requestBody": {
759
+ "content": {
760
+ "application/json": {
761
+ "schema": {
762
+ "$ref": "#/components/schemas/OrderPaymentStatusUpdateRequest"
763
+ }
764
+ }
765
+ }
766
+ },
767
+ "responses": {
768
+ "204": {
769
+ "description": "Order payment status updated successfully. No content returned.\n"
770
+ },
771
+ "400": {
772
+ "description": "Request body or path violate required syntax.\n",
773
+ "content": {
774
+ "application/json": {
775
+ "schema": {
776
+ "$ref": "#/components/schemas/ErrorResponse"
777
+ }
778
+ }
779
+ }
780
+ },
781
+ "404": {
782
+ "description": "The given site ID does not reference an existing site.\n",
783
+ "content": {
784
+ "application/json": {
785
+ "schema": {
786
+ "$ref": "#/components/schemas/ErrorResponse"
787
+ }
788
+ }
789
+ }
790
+ }
791
+ },
792
+ "security": [
793
+ {
794
+ "AmOAuth2": [
795
+ "sfcc.orders.rw"
796
+ ]
797
+ }
798
+ ]
799
+ }
800
+ },
801
+ "/organizations/{organizationId}/orders/{orderNo}/shipping-status": {
802
+ "put": {
803
+ "operationId": "updateOrderShippingStatus",
804
+ "parameters": [
805
+ {
806
+ "name": "organizationId",
807
+ "in": "path",
808
+ "required": true,
809
+ "style": "simple",
810
+ "explode": false,
811
+ "schema": {
812
+ "$ref": "#/components/schemas/OrganizationId"
813
+ }
814
+ },
815
+ {
816
+ "name": "orderNo",
817
+ "in": "path",
818
+ "required": true,
819
+ "style": "simple",
820
+ "explode": false,
821
+ "schema": {
822
+ "$ref": "#/components/schemas/OrderNo"
823
+ }
824
+ },
825
+ {
826
+ "name": "siteId",
827
+ "in": "query",
828
+ "required": true,
829
+ "style": "form",
830
+ "explode": true,
831
+ "schema": {
832
+ "$ref": "#/components/schemas/SiteId"
833
+ }
834
+ }
835
+ ],
836
+ "requestBody": {
837
+ "content": {
838
+ "application/json": {
839
+ "schema": {
840
+ "$ref": "#/components/schemas/OrderShippingStatusUpdateRequest"
841
+ }
842
+ }
843
+ }
844
+ },
845
+ "responses": {
846
+ "204": {
847
+ "description": "Order shipping status updated successfully. No content returned.\n"
848
+ },
849
+ "400": {
850
+ "description": "Request body or path violate required syntax.\n",
851
+ "content": {
852
+ "application/json": {
853
+ "schema": {
854
+ "$ref": "#/components/schemas/ErrorResponse"
855
+ }
856
+ }
857
+ }
858
+ },
859
+ "404": {
860
+ "description": "The given site ID does not reference an existing site.\n",
861
+ "content": {
862
+ "application/json": {
863
+ "schema": {
864
+ "$ref": "#/components/schemas/ErrorResponse"
865
+ }
866
+ }
867
+ }
868
+ }
869
+ },
870
+ "security": [
871
+ {
872
+ "AmOAuth2": [
873
+ "sfcc.orders.rw"
874
+ ]
875
+ }
876
+ ]
877
+ }
878
+ },
879
+ "/organizations/{organizationId}/orders/{orderNo}/oms-status-events": {
880
+ "post": {
881
+ "operationId": "createOmsStatusEvent",
882
+ "parameters": [
883
+ {
884
+ "name": "organizationId",
885
+ "in": "path",
886
+ "required": true,
887
+ "style": "simple",
888
+ "explode": false,
889
+ "schema": {
890
+ "$ref": "#/components/schemas/OrganizationId"
891
+ }
892
+ },
893
+ {
894
+ "name": "orderNo",
895
+ "in": "path",
896
+ "required": true,
897
+ "style": "simple",
898
+ "explode": false,
899
+ "schema": {
900
+ "$ref": "#/components/schemas/OrderNo"
901
+ }
902
+ },
903
+ {
904
+ "name": "siteId",
905
+ "in": "query",
906
+ "required": true,
907
+ "style": "form",
908
+ "explode": true,
909
+ "schema": {
910
+ "$ref": "#/components/schemas/SiteId"
911
+ }
912
+ }
913
+ ],
914
+ "requestBody": {
915
+ "content": {
916
+ "application/json": {
917
+ "schema": {
918
+ "$ref": "#/components/schemas/OmsStatusEventRequest"
919
+ }
920
+ }
921
+ },
922
+ "required": true
923
+ },
924
+ "responses": {
925
+ "202": {
926
+ "description": "The status event was accepted and queued for forwarding to order event subscribers. No content returned.\n"
927
+ },
928
+ "400": {
929
+ "description": "The request body or path violates required syntax (for example, neither or both event objects present,\nor a required field/enum constraint is violated).\n",
930
+ "content": {
931
+ "application/json": {
932
+ "schema": {
933
+ "$ref": "#/components/schemas/ErrorResponse"
934
+ }
935
+ }
936
+ }
937
+ },
938
+ "409": {
939
+ "description": "Order Management (OMS) is not active for this site. The site does not have an OMS integration enabled, so\nthe status event cannot be forwarded.\n",
940
+ "content": {
941
+ "application/json": {
942
+ "schema": {
943
+ "$ref": "#/components/schemas/ErrorResponse"
944
+ }
945
+ }
946
+ }
947
+ }
948
+ },
949
+ "security": [
950
+ {
951
+ "AmOAuth2": [
952
+ "sfcc.orders.rw"
953
+ ]
954
+ }
955
+ ]
956
+ }
957
+ },
958
+ "/organizations/{organizationId}/orders/{orderNo}/status": {
959
+ "put": {
960
+ "operationId": "updateOrderStatus",
961
+ "parameters": [
962
+ {
963
+ "name": "organizationId",
964
+ "in": "path",
965
+ "required": true,
966
+ "style": "simple",
967
+ "explode": false,
968
+ "schema": {
969
+ "$ref": "#/components/schemas/OrganizationId"
970
+ }
971
+ },
972
+ {
973
+ "name": "orderNo",
974
+ "in": "path",
975
+ "required": true,
976
+ "style": "simple",
977
+ "explode": false,
978
+ "schema": {
979
+ "$ref": "#/components/schemas/OrderNo"
980
+ }
981
+ },
982
+ {
983
+ "name": "siteId",
984
+ "in": "query",
985
+ "required": true,
986
+ "style": "form",
987
+ "explode": true,
988
+ "schema": {
989
+ "$ref": "#/components/schemas/SiteId"
990
+ }
991
+ }
992
+ ],
993
+ "requestBody": {
994
+ "content": {
995
+ "application/json": {
996
+ "schema": {
997
+ "$ref": "#/components/schemas/OrderStatusUpdateRequest"
998
+ }
999
+ }
1000
+ }
1001
+ },
1002
+ "responses": {
1003
+ "201": {
1004
+ "description": "Order status updated successfully. No content returned.\n",
1005
+ "headers": {
1006
+ "Location": {
1007
+ "style": "simple",
1008
+ "explode": false,
1009
+ "schema": {
1010
+ "type": "string"
1011
+ }
1012
+ }
1013
+ }
1014
+ },
1015
+ "204": {
1016
+ "description": "Order status updated successfully. No content returned.\n"
1017
+ },
1018
+ "400": {
1019
+ "description": "Request body or path violate required syntax.\n",
1020
+ "content": {
1021
+ "application/json": {
1022
+ "schema": {
1023
+ "$ref": "#/components/schemas/ErrorResponse"
1024
+ }
1025
+ }
1026
+ }
1027
+ },
1028
+ "404": {
1029
+ "description": "The given site ID does not reference an existing site.\n",
1030
+ "content": {
1031
+ "application/json": {
1032
+ "schema": {
1033
+ "$ref": "#/components/schemas/ErrorResponse"
1034
+ }
1035
+ }
1036
+ }
1037
+ },
1038
+ "409": {
1039
+ "description": "The failed order can't be reopened.\n",
1040
+ "content": {
1041
+ "application/json": {
1042
+ "schema": {
1043
+ "$ref": "#/components/schemas/ErrorResponse"
1044
+ }
1045
+ }
1046
+ }
1047
+ }
1048
+ },
1049
+ "security": [
1050
+ {
1051
+ "AmOAuth2": [
1052
+ "sfcc.orders.rw"
1053
+ ]
1054
+ }
1055
+ ]
1056
+ }
1057
+ },
1058
+ "/organizations/{organizationId}/orders/{orderNo}/payment-instruments/{paymentInstrumentId}": {
1059
+ "patch": {
1060
+ "operationId": "updateOrderPaymentInstrument",
1061
+ "parameters": [
1062
+ {
1063
+ "name": "paymentInstrumentId",
1064
+ "in": "path",
1065
+ "required": true,
1066
+ "style": "simple",
1067
+ "explode": false,
1068
+ "schema": {
1069
+ "type": "string",
1070
+ "minLength": 1
1071
+ }
1072
+ },
1073
+ {
1074
+ "name": "organizationId",
1075
+ "in": "path",
1076
+ "required": true,
1077
+ "style": "simple",
1078
+ "explode": false,
1079
+ "schema": {
1080
+ "$ref": "#/components/schemas/OrganizationId"
1081
+ }
1082
+ },
1083
+ {
1084
+ "name": "orderNo",
1085
+ "in": "path",
1086
+ "required": true,
1087
+ "style": "simple",
1088
+ "explode": false,
1089
+ "schema": {
1090
+ "$ref": "#/components/schemas/OrderNo"
1091
+ }
1092
+ },
1093
+ {
1094
+ "name": "siteId",
1095
+ "in": "query",
1096
+ "required": true,
1097
+ "style": "form",
1098
+ "explode": true,
1099
+ "schema": {
1100
+ "$ref": "#/components/schemas/SiteId"
1101
+ }
1102
+ }
1103
+ ],
1104
+ "requestBody": {
1105
+ "content": {
1106
+ "application/json": {
1107
+ "schema": {
1108
+ "$ref": "#/components/schemas/PaymentInstrumentUpdateRequest"
1109
+ }
1110
+ }
1111
+ }
1112
+ },
1113
+ "responses": {
1114
+ "204": {
1115
+ "description": "Order payment instrument updated successfully. No content returned.\n"
1116
+ },
1117
+ "400": {
1118
+ "description": "Request body or path violate required syntax.\n",
1119
+ "content": {
1120
+ "application/json": {
1121
+ "schema": {
1122
+ "$ref": "#/components/schemas/ErrorResponse"
1123
+ }
1124
+ }
1125
+ }
1126
+ },
1127
+ "404": {
1128
+ "description": "The given payment instrument ID does not reference an existing payment instrument.\n",
1129
+ "content": {
1130
+ "application/json": {
1131
+ "schema": {
1132
+ "$ref": "#/components/schemas/ErrorResponse"
1133
+ }
1134
+ }
1135
+ }
1136
+ }
1137
+ },
1138
+ "security": [
1139
+ {
1140
+ "AmOAuth2": [
1141
+ "sfcc.orders.rw"
1142
+ ]
1143
+ }
1144
+ ]
1145
+ }
1146
+ },
1147
+ "/organizations/{organizationId}/orders/{orderNo}/payment-instruments/{paymentInstrumentId}/transaction": {
1148
+ "patch": {
1149
+ "operationId": "updateOrderPaymentTransaction",
1150
+ "parameters": [
1151
+ {
1152
+ "name": "organizationId",
1153
+ "in": "path",
1154
+ "required": true,
1155
+ "style": "simple",
1156
+ "explode": false,
1157
+ "schema": {
1158
+ "$ref": "#/components/schemas/OrganizationId"
1159
+ }
1160
+ },
1161
+ {
1162
+ "name": "paymentInstrumentId",
1163
+ "in": "path",
1164
+ "required": true,
1165
+ "style": "simple",
1166
+ "explode": false,
1167
+ "schema": {
1168
+ "type": "string",
1169
+ "minLength": 1
1170
+ }
1171
+ },
1172
+ {
1173
+ "name": "orderNo",
1174
+ "in": "path",
1175
+ "required": true,
1176
+ "style": "simple",
1177
+ "explode": false,
1178
+ "schema": {
1179
+ "$ref": "#/components/schemas/OrderNo"
1180
+ }
1181
+ },
1182
+ {
1183
+ "name": "siteId",
1184
+ "in": "query",
1185
+ "required": true,
1186
+ "style": "form",
1187
+ "explode": true,
1188
+ "schema": {
1189
+ "$ref": "#/components/schemas/SiteId"
1190
+ }
1191
+ }
1192
+ ],
1193
+ "requestBody": {
1194
+ "content": {
1195
+ "application/json": {
1196
+ "schema": {
1197
+ "$ref": "#/components/schemas/PaymentTransactionUpdateRequest"
1198
+ }
1199
+ }
1200
+ }
1201
+ },
1202
+ "responses": {
1203
+ "204": {
1204
+ "description": "Payment instrument transaction updated successfully. No content returned.\n"
1205
+ },
1206
+ "400": {
1207
+ "description": "Request body or path violate required syntax.\n",
1208
+ "content": {
1209
+ "application/json": {
1210
+ "schema": {
1211
+ "$ref": "#/components/schemas/ErrorResponse"
1212
+ }
1213
+ }
1214
+ }
1215
+ },
1216
+ "404": {
1217
+ "description": "The given payment instrument ID does not reference an existing payment instrument.\n",
1218
+ "content": {
1219
+ "application/json": {
1220
+ "schema": {
1221
+ "$ref": "#/components/schemas/ErrorResponse"
1222
+ }
1223
+ }
1224
+ }
1225
+ }
1226
+ },
1227
+ "security": [
1228
+ {
1229
+ "AmOAuth2": [
1230
+ "sfcc.orders.rw"
1231
+ ]
1232
+ }
1233
+ ]
1234
+ }
1235
+ },
1236
+ "/organizations/{organizationId}/orders/{orderNo}/shipments/{shipmentId}/shipping-address": {
1237
+ "put": {
1238
+ "operationId": "updateOrderShippingAddress",
1239
+ "parameters": [
1240
+ {
1241
+ "name": "organizationId",
1242
+ "in": "path",
1243
+ "required": true,
1244
+ "style": "simple",
1245
+ "explode": false,
1246
+ "schema": {
1247
+ "$ref": "#/components/schemas/OrganizationId"
1248
+ }
1249
+ },
1250
+ {
1251
+ "name": "shipmentId",
1252
+ "in": "path",
1253
+ "required": true,
1254
+ "style": "simple",
1255
+ "explode": false,
1256
+ "schema": {
1257
+ "type": "string",
1258
+ "minLength": 1
1259
+ }
1260
+ },
1261
+ {
1262
+ "name": "orderNo",
1263
+ "in": "path",
1264
+ "required": true,
1265
+ "style": "simple",
1266
+ "explode": false,
1267
+ "schema": {
1268
+ "$ref": "#/components/schemas/OrderNo"
1269
+ }
1270
+ },
1271
+ {
1272
+ "name": "siteId",
1273
+ "in": "query",
1274
+ "required": true,
1275
+ "style": "form",
1276
+ "explode": true,
1277
+ "schema": {
1278
+ "$ref": "#/components/schemas/SiteId"
1279
+ }
1280
+ }
1281
+ ],
1282
+ "requestBody": {
1283
+ "content": {
1284
+ "application/json": {
1285
+ "schema": {
1286
+ "$ref": "#/components/schemas/ShippingAddressUpdateRequest"
1287
+ }
1288
+ }
1289
+ }
1290
+ },
1291
+ "responses": {
1292
+ "204": {
1293
+ "description": "Shipping address created or replaced successfully. No content returned.\n"
1294
+ },
1295
+ "400": {
1296
+ "description": "Request body or path violate required syntax.\n",
1297
+ "content": {
1298
+ "application/json": {
1299
+ "schema": {
1300
+ "$ref": "#/components/schemas/ErrorResponse"
1301
+ }
1302
+ }
1303
+ }
1304
+ },
1305
+ "404": {
1306
+ "description": "The given shipment ID does not reference an existing shipment.\n",
1307
+ "content": {
1308
+ "application/json": {
1309
+ "schema": {
1310
+ "$ref": "#/components/schemas/ErrorResponse"
1311
+ }
1312
+ }
1313
+ }
1314
+ }
1315
+ },
1316
+ "security": [
1317
+ {
1318
+ "AmOAuth2": [
1319
+ "sfcc.orders.rw"
1320
+ ]
1321
+ }
1322
+ ]
1323
+ }
1324
+ }
1325
+ },
1326
+ "components": {
1327
+ "schemas": {
1328
+ "OrganizationId": {
1329
+ "type": "string",
1330
+ "pattern": "^f_ecom_[a-z]{4}_(prd|stg|dev|s[0-9]{2}|[0-9]{3})$"
1331
+ },
1332
+ "OrderExportStatus": {
1333
+ "type": "string",
1334
+ "enum": [
1335
+ "exported",
1336
+ "not_exported",
1337
+ "ready",
1338
+ "failed"
1339
+ ]
1340
+ },
1341
+ "OrderPaymentStatus": {
1342
+ "type": "string",
1343
+ "enum": [
1344
+ "paid",
1345
+ "part_paid",
1346
+ "not_paid"
1347
+ ]
1348
+ },
1349
+ "OrderShippingStatus": {
1350
+ "type": "string",
1351
+ "enum": [
1352
+ "shipped",
1353
+ "part_shipped",
1354
+ "not_shipped"
1355
+ ]
1356
+ },
1357
+ "SiteId": {
1358
+ "type": "string",
1359
+ "maxLength": 32,
1360
+ "minLength": 1
1361
+ },
1362
+ "CountryCode": {
1363
+ "type": "string",
1364
+ "pattern": "^[A-Z][A-Z]$"
1365
+ },
1366
+ "Address": {
1367
+ "type": "object",
1368
+ "additionalProperties": {},
1369
+ "properties": {
1370
+ "address1": {
1371
+ "type": "string",
1372
+ "maxLength": 256
1373
+ },
1374
+ "address2": {
1375
+ "type": "string",
1376
+ "maxLength": 256
1377
+ },
1378
+ "city": {
1379
+ "type": "string",
1380
+ "maxLength": 256
1381
+ },
1382
+ "companyName": {
1383
+ "type": "string",
1384
+ "maxLength": 256
1385
+ },
1386
+ "countryCode": {
1387
+ "$ref": "#/components/schemas/CountryCode"
1388
+ },
1389
+ "firstName": {
1390
+ "type": "string",
1391
+ "maxLength": 256
1392
+ },
1393
+ "fullName": {
1394
+ "type": "string",
1395
+ "maxLength": 256
1396
+ },
1397
+ "jobTitle": {
1398
+ "type": "string",
1399
+ "maxLength": 256
1400
+ },
1401
+ "lastName": {
1402
+ "type": "string",
1403
+ "maxLength": 256
1404
+ },
1405
+ "phone": {
1406
+ "type": "string",
1407
+ "maxLength": 256
1408
+ },
1409
+ "postBox": {
1410
+ "type": "string",
1411
+ "maxLength": 256
1412
+ },
1413
+ "postalCode": {
1414
+ "type": "string",
1415
+ "maxLength": 256
1416
+ },
1417
+ "salutation": {
1418
+ "type": "string",
1419
+ "maxLength": 256
1420
+ },
1421
+ "secondName": {
1422
+ "type": "string",
1423
+ "maxLength": 256
1424
+ },
1425
+ "stateCode": {
1426
+ "type": "string",
1427
+ "maxLength": 256
1428
+ },
1429
+ "suffix": {
1430
+ "type": "string",
1431
+ "maxLength": 256
1432
+ },
1433
+ "suite": {
1434
+ "type": "string",
1435
+ "maxLength": 256
1436
+ },
1437
+ "title": {
1438
+ "type": "string",
1439
+ "maxLength": 256
1440
+ }
1441
+ }
1442
+ },
1443
+ "ProductId": {
1444
+ "type": "string",
1445
+ "maxLength": 100,
1446
+ "minLength": 1
1447
+ },
1448
+ "ProductReference": {
1449
+ "type": "object",
1450
+ "additionalProperties": false,
1451
+ "properties": {
1452
+ "productId": {
1453
+ "$ref": "#/components/schemas/ProductId"
1454
+ },
1455
+ "productName": {
1456
+ "type": "string",
1457
+ "maxLength": 4000
1458
+ }
1459
+ }
1460
+ },
1461
+ "BonusDiscountLineItem": {
1462
+ "type": "object",
1463
+ "additionalProperties": {},
1464
+ "properties": {
1465
+ "bonusProducts": {
1466
+ "type": "array",
1467
+ "items": {
1468
+ "$ref": "#/components/schemas/ProductReference"
1469
+ }
1470
+ },
1471
+ "couponCode": {
1472
+ "type": "string",
1473
+ "maxLength": 256
1474
+ },
1475
+ "id": {
1476
+ "type": "string",
1477
+ "maxLength": 256,
1478
+ "minLength": 1
1479
+ },
1480
+ "maxBonusItems": {
1481
+ "type": "integer",
1482
+ "format": "int32"
1483
+ },
1484
+ "promotionId": {
1485
+ "type": "string",
1486
+ "maxLength": 256
1487
+ }
1488
+ }
1489
+ },
1490
+ "OrderConfirmationStatus": {
1491
+ "type": "string",
1492
+ "enum": [
1493
+ "confirmed",
1494
+ "not_confirmed"
1495
+ ]
1496
+ },
1497
+ "CouponItem": {
1498
+ "type": "object",
1499
+ "additionalProperties": false,
1500
+ "properties": {
1501
+ "code": {
1502
+ "type": "string",
1503
+ "maxLength": 256
1504
+ },
1505
+ "couponItemId": {
1506
+ "type": "string",
1507
+ "maxLength": 256,
1508
+ "minLength": 1
1509
+ },
1510
+ "statusCode": {
1511
+ "type": "string",
1512
+ "enum": [
1513
+ "coupon_code_already_in_basket",
1514
+ "coupon_code_already_redeemed",
1515
+ "coupon_code_unknown",
1516
+ "coupon_disabled",
1517
+ "redemption_limit_exceeded",
1518
+ "customer_redemption_limit_exceeded",
1519
+ "timeframe_redemption_limit_exceeded",
1520
+ "no_active_promotion",
1521
+ "coupon_already_in_basket",
1522
+ "no_applicable_promotion",
1523
+ "applied",
1524
+ "adhoc"
1525
+ ]
1526
+ },
1527
+ "valid": {
1528
+ "type": "boolean"
1529
+ }
1530
+ }
1531
+ },
1532
+ "CurrencyCode": {
1533
+ "type": "string",
1534
+ "pattern": "^([A-Z][A-Z][A-Z]|N/A)$"
1535
+ },
1536
+ "CustomerInfo": {
1537
+ "type": "object",
1538
+ "additionalProperties": false,
1539
+ "properties": {
1540
+ "customerId": {
1541
+ "type": "string",
1542
+ "maxLength": 100
1543
+ },
1544
+ "customerName": {
1545
+ "type": "string",
1546
+ "maxLength": 256
1547
+ },
1548
+ "customerNo": {
1549
+ "type": "string",
1550
+ "maxLength": 100
1551
+ },
1552
+ "email": {
1553
+ "type": "string",
1554
+ "maxLength": 256
1555
+ },
1556
+ "guest": {
1557
+ "type": "boolean"
1558
+ }
1559
+ }
1560
+ },
1561
+ "GiftCertificateItem": {
1562
+ "type": "object",
1563
+ "additionalProperties": {},
1564
+ "properties": {
1565
+ "basePrice": {
1566
+ "type": "number",
1567
+ "format": "double"
1568
+ },
1569
+ "grossPrice": {
1570
+ "type": "number",
1571
+ "format": "double"
1572
+ },
1573
+ "itemText": {
1574
+ "type": "string",
1575
+ "maxLength": 256
1576
+ },
1577
+ "netPrice": {
1578
+ "type": "number",
1579
+ "format": "double"
1580
+ },
1581
+ "tax": {
1582
+ "type": "number",
1583
+ "format": "double"
1584
+ },
1585
+ "taxBasis": {
1586
+ "type": "number",
1587
+ "format": "double"
1588
+ },
1589
+ "giftCertificateMerchantId": {
1590
+ "type": "string",
1591
+ "maxLength": 256,
1592
+ "minLength": 1
1593
+ },
1594
+ "giftCertificateItemId": {
1595
+ "type": "string",
1596
+ "maxLength": 256,
1597
+ "minLength": 1
1598
+ },
1599
+ "message": {
1600
+ "type": "string",
1601
+ "maxLength": 4000
1602
+ },
1603
+ "recipientEmail": {
1604
+ "type": "string",
1605
+ "maxLength": 256
1606
+ },
1607
+ "recipientName": {
1608
+ "type": "string",
1609
+ "maxLength": 256
1610
+ },
1611
+ "senderName": {
1612
+ "type": "string",
1613
+ "maxLength": 256
1614
+ },
1615
+ "shipmentId": {
1616
+ "type": "string",
1617
+ "maxLength": 256,
1618
+ "minLength": 1
1619
+ }
1620
+ }
1621
+ },
1622
+ "OrderNo": {
1623
+ "type": "string",
1624
+ "maxLength": 50,
1625
+ "minLength": 1
1626
+ },
1627
+ "ABTestSegment": {
1628
+ "type": "object",
1629
+ "additionalProperties": false,
1630
+ "properties": {
1631
+ "testId": {
1632
+ "type": "string",
1633
+ "maxLength": 40,
1634
+ "minLength": 1
1635
+ },
1636
+ "segmentId": {
1637
+ "type": "string",
1638
+ "maxLength": 40,
1639
+ "minLength": 1
1640
+ }
1641
+ },
1642
+ "required": [
1643
+ "segmentId",
1644
+ "testId"
1645
+ ]
1646
+ },
1647
+ "Discount": {
1648
+ "type": "object",
1649
+ "additionalProperties": false,
1650
+ "properties": {
1651
+ "amount": {
1652
+ "type": "number",
1653
+ "format": "double"
1654
+ },
1655
+ "percentage": {
1656
+ "type": "number",
1657
+ "format": "double"
1658
+ },
1659
+ "priceBookId": {
1660
+ "type": "string",
1661
+ "maxLength": 256
1662
+ },
1663
+ "type": {
1664
+ "type": "string",
1665
+ "enum": [
1666
+ "percentage",
1667
+ "fixed_price",
1668
+ "amount",
1669
+ "free",
1670
+ "price_book_price",
1671
+ "bonus",
1672
+ "total_fixed_price",
1673
+ "bonus_choice",
1674
+ "percentage_off_options"
1675
+ ]
1676
+ }
1677
+ },
1678
+ "required": [
1679
+ "type"
1680
+ ]
1681
+ },
1682
+ "PriceAdjustment": {
1683
+ "type": "object",
1684
+ "additionalProperties": {},
1685
+ "properties": {
1686
+ "basePrice": {
1687
+ "type": "number",
1688
+ "format": "double"
1689
+ },
1690
+ "grossPrice": {
1691
+ "type": "number",
1692
+ "format": "double"
1693
+ },
1694
+ "itemText": {
1695
+ "type": "string",
1696
+ "maxLength": 256
1697
+ },
1698
+ "netPrice": {
1699
+ "type": "number",
1700
+ "format": "double"
1701
+ },
1702
+ "tax": {
1703
+ "type": "number",
1704
+ "format": "double"
1705
+ },
1706
+ "taxBasis": {
1707
+ "type": "number",
1708
+ "format": "double"
1709
+ },
1710
+ "abTestSegment": {
1711
+ "allOf": [
1712
+ {
1713
+ "$ref": "#/components/schemas/ABTestSegment"
1714
+ }
1715
+ ]
1716
+ },
1717
+ "appliedDiscount": {
1718
+ "allOf": [
1719
+ {
1720
+ "$ref": "#/components/schemas/Discount"
1721
+ }
1722
+ ]
1723
+ },
1724
+ "campaignId": {
1725
+ "type": "string",
1726
+ "maxLength": 256,
1727
+ "minLength": 1
1728
+ },
1729
+ "couponCode": {
1730
+ "type": "string",
1731
+ "maxLength": 256,
1732
+ "minLength": 1
1733
+ },
1734
+ "createdBy": {
1735
+ "type": "string",
1736
+ "maxLength": 256
1737
+ },
1738
+ "creationDate": {
1739
+ "type": "string",
1740
+ "format": "date-time"
1741
+ },
1742
+ "custom": {
1743
+ "type": "boolean"
1744
+ },
1745
+ "lastModified": {
1746
+ "type": "string",
1747
+ "format": "date-time"
1748
+ },
1749
+ "manual": {
1750
+ "type": "boolean"
1751
+ },
1752
+ "priceAdjustmentId": {
1753
+ "type": "string",
1754
+ "maxLength": 256,
1755
+ "minLength": 1
1756
+ },
1757
+ "promotionId": {
1758
+ "type": "string",
1759
+ "maxLength": 256,
1760
+ "minLength": 1
1761
+ },
1762
+ "reasonCode": {
1763
+ "type": "string",
1764
+ "maxLength": 256,
1765
+ "minLength": 1
1766
+ }
1767
+ },
1768
+ "required": [
1769
+ "promotionId"
1770
+ ]
1771
+ },
1772
+ "PaymentCard": {
1773
+ "type": "object",
1774
+ "additionalProperties": false,
1775
+ "properties": {
1776
+ "cardType": {
1777
+ "type": "string",
1778
+ "maxLength": 256
1779
+ },
1780
+ "creditCardExpired": {
1781
+ "type": "boolean"
1782
+ },
1783
+ "creditCardToken": {
1784
+ "type": "string",
1785
+ "maxLength": 256
1786
+ },
1787
+ "expirationMonth": {
1788
+ "type": "integer",
1789
+ "format": "int32",
1790
+ "maximum": 12,
1791
+ "minimum": 1
1792
+ },
1793
+ "expirationYear": {
1794
+ "type": "integer",
1795
+ "format": "int32"
1796
+ },
1797
+ "holder": {
1798
+ "type": "string",
1799
+ "maxLength": 256
1800
+ },
1801
+ "issueNumber": {
1802
+ "type": "string",
1803
+ "maxLength": 256
1804
+ },
1805
+ "maskedNumber": {
1806
+ "type": "string",
1807
+ "maxLength": 256
1808
+ },
1809
+ "numberLastDigits": {
1810
+ "type": "string",
1811
+ "maxLength": 4
1812
+ },
1813
+ "validFromMonth": {
1814
+ "type": "integer",
1815
+ "format": "int32",
1816
+ "maximum": 12,
1817
+ "minimum": 1
1818
+ },
1819
+ "validFromYear": {
1820
+ "type": "integer",
1821
+ "format": "int32"
1822
+ }
1823
+ }
1824
+ },
1825
+ "Status": {
1826
+ "type": "object",
1827
+ "additionalProperties": false,
1828
+ "properties": {
1829
+ "code": {
1830
+ "type": "string",
1831
+ "maxLength": 256
1832
+ },
1833
+ "message": {
1834
+ "type": "string",
1835
+ "maxLength": 256
1836
+ },
1837
+ "status": {
1838
+ "type": "integer",
1839
+ "format": "int32",
1840
+ "maximum": 2,
1841
+ "minimum": 0
1842
+ }
1843
+ }
1844
+ },
1845
+ "PaymentTransaction": {
1846
+ "type": "object",
1847
+ "additionalProperties": {},
1848
+ "properties": {
1849
+ "amount": {
1850
+ "type": "number",
1851
+ "format": "double"
1852
+ },
1853
+ "authorizationStatus": {
1854
+ "allOf": [
1855
+ {
1856
+ "$ref": "#/components/schemas/Status"
1857
+ }
1858
+ ]
1859
+ },
1860
+ "transactionId": {
1861
+ "type": "string",
1862
+ "maxLength": 256
1863
+ }
1864
+ }
1865
+ },
1866
+ "PaymentInstrument": {
1867
+ "type": "object",
1868
+ "additionalProperties": {},
1869
+ "properties": {
1870
+ "bankRoutingNumber": {
1871
+ "type": "string",
1872
+ "maxLength": 256
1873
+ },
1874
+ "maskedGiftCertificateCode": {
1875
+ "type": "string",
1876
+ "maxLength": 256
1877
+ },
1878
+ "paymentCard": {
1879
+ "allOf": [
1880
+ {
1881
+ "$ref": "#/components/schemas/PaymentCard"
1882
+ }
1883
+ ]
1884
+ },
1885
+ "paymentInstrumentId": {
1886
+ "type": "string",
1887
+ "maxLength": 256,
1888
+ "minLength": 1
1889
+ },
1890
+ "paymentMethodId": {
1891
+ "type": "string",
1892
+ "maxLength": 256
1893
+ },
1894
+ "paymentTransaction": {
1895
+ "allOf": [
1896
+ {
1897
+ "$ref": "#/components/schemas/PaymentTransaction"
1898
+ }
1899
+ ]
1900
+ }
1901
+ }
1902
+ },
1903
+ "ProductItem": {
1904
+ "type": "object",
1905
+ "additionalProperties": {},
1906
+ "properties": {
1907
+ "basePrice": {
1908
+ "type": "number",
1909
+ "format": "double"
1910
+ },
1911
+ "grossPrice": {
1912
+ "type": "number",
1913
+ "format": "double"
1914
+ },
1915
+ "itemText": {
1916
+ "type": "string",
1917
+ "maxLength": 256
1918
+ },
1919
+ "netPrice": {
1920
+ "type": "number",
1921
+ "format": "double"
1922
+ },
1923
+ "tax": {
1924
+ "type": "number",
1925
+ "format": "double"
1926
+ },
1927
+ "taxBasis": {
1928
+ "type": "number",
1929
+ "format": "double"
1930
+ },
1931
+ "adjustedTax": {
1932
+ "type": "number",
1933
+ "format": "double"
1934
+ },
1935
+ "bonusDiscountLineItemId": {
1936
+ "type": "string",
1937
+ "maxLength": 256,
1938
+ "minLength": 1
1939
+ },
1940
+ "bonusProductLineItem": {
1941
+ "type": "boolean"
1942
+ },
1943
+ "brand": {
1944
+ "type": "string",
1945
+ "maxLength": 256
1946
+ },
1947
+ "bundledProductItems": {
1948
+ "type": "array",
1949
+ "items": {
1950
+ "$ref": "#/components/schemas/ProductItem"
1951
+ }
1952
+ },
1953
+ "externalLineItemStatus": {
1954
+ "type": "string",
1955
+ "maxLength": 256
1956
+ },
1957
+ "externalLineItemText": {
1958
+ "type": "string"
1959
+ },
1960
+ "gift": {
1961
+ "type": "boolean"
1962
+ },
1963
+ "giftMessage": {
1964
+ "type": "string",
1965
+ "maxLength": 4000
1966
+ },
1967
+ "inventoryId": {
1968
+ "type": "string",
1969
+ "maxLength": 256
1970
+ },
1971
+ "itemId": {
1972
+ "type": "string",
1973
+ "maxLength": 256,
1974
+ "minLength": 1
1975
+ },
1976
+ "minOrderQuantity": {
1977
+ "type": "number",
1978
+ "format": "double"
1979
+ },
1980
+ "optionItems": {
1981
+ "type": "array",
1982
+ "items": {
1983
+ "$ref": "#/components/schemas/OptionItem"
1984
+ }
1985
+ },
1986
+ "position": {
1987
+ "type": "number",
1988
+ "format": "double"
1989
+ },
1990
+ "priceAdjustments": {
1991
+ "type": "array",
1992
+ "items": {
1993
+ "$ref": "#/components/schemas/PriceAdjustment"
1994
+ }
1995
+ },
1996
+ "priceAfterItemDiscount": {
1997
+ "type": "number",
1998
+ "format": "double"
1999
+ },
2000
+ "priceAfterOrderDiscount": {
2001
+ "type": "number",
2002
+ "format": "double"
2003
+ },
2004
+ "productId": {
2005
+ "$ref": "#/components/schemas/ProductId"
2006
+ },
2007
+ "productListItem": {
2008
+ "allOf": [
2009
+ {
2010
+ "$ref": "#/components/schemas/ProductListItemReference"
2011
+ }
2012
+ ]
2013
+ },
2014
+ "productName": {
2015
+ "type": "string",
2016
+ "maxLength": 4000
2017
+ },
2018
+ "quantity": {
2019
+ "type": "number",
2020
+ "format": "double",
2021
+ "minimum": 0
2022
+ },
2023
+ "shipmentId": {
2024
+ "type": "string",
2025
+ "maxLength": 256,
2026
+ "minLength": 1
2027
+ },
2028
+ "shippingItemId": {
2029
+ "type": "string",
2030
+ "maxLength": 256,
2031
+ "minLength": 1
2032
+ },
2033
+ "stepQuantity": {
2034
+ "type": "number",
2035
+ "format": "double"
2036
+ },
2037
+ "taxItems": {
2038
+ "type": "array",
2039
+ "items": {
2040
+ "$ref": "#/components/schemas/TaxItem"
2041
+ },
2042
+ "maxItems": 10
2043
+ },
2044
+ "taxRate": {
2045
+ "type": "number",
2046
+ "format": "double"
2047
+ }
2048
+ },
2049
+ "required": [
2050
+ "productId",
2051
+ "shipmentId",
2052
+ "taxRate"
2053
+ ]
2054
+ },
2055
+ "OptionItem": {
2056
+ "type": "object",
2057
+ "additionalProperties": {},
2058
+ "properties": {
2059
+ "basePrice": {
2060
+ "type": "number",
2061
+ "format": "double"
2062
+ },
2063
+ "grossPrice": {
2064
+ "type": "number",
2065
+ "format": "double"
2066
+ },
2067
+ "gift": {
2068
+ "type": "boolean"
2069
+ },
2070
+ "itemText": {
2071
+ "type": "string",
2072
+ "maxLength": 256
2073
+ },
2074
+ "netPrice": {
2075
+ "type": "number",
2076
+ "format": "double"
2077
+ },
2078
+ "tax": {
2079
+ "type": "number",
2080
+ "format": "double"
2081
+ },
2082
+ "taxBasis": {
2083
+ "type": "number",
2084
+ "format": "double"
2085
+ },
2086
+ "optionId": {
2087
+ "type": "string",
2088
+ "maxLength": 256,
2089
+ "minLength": 1
2090
+ },
2091
+ "optionValueId": {
2092
+ "type": "string",
2093
+ "maxLength": 256,
2094
+ "minLength": 1
2095
+ },
2096
+ "priceAdjustments": {
2097
+ "type": "array",
2098
+ "items": {
2099
+ "$ref": "#/components/schemas/PriceAdjustment"
2100
+ }
2101
+ },
2102
+ "productId": {
2103
+ "$ref": "#/components/schemas/ProductId"
2104
+ }
2105
+ },
2106
+ "required": [
2107
+ "productId"
2108
+ ]
2109
+ },
2110
+ "ProductListReference": {
2111
+ "type": "object",
2112
+ "additionalProperties": false,
2113
+ "properties": {
2114
+ "description": {
2115
+ "type": "string",
2116
+ "maxLength": 256
2117
+ },
2118
+ "name": {
2119
+ "type": "string",
2120
+ "maxLength": 256
2121
+ },
2122
+ "public": {
2123
+ "type": "boolean"
2124
+ },
2125
+ "type": {
2126
+ "type": "string",
2127
+ "enum": [
2128
+ "wish_list",
2129
+ "gift_registry",
2130
+ "shopping_list",
2131
+ "custom_1",
2132
+ "custom_2",
2133
+ "custom_3"
2134
+ ]
2135
+ }
2136
+ }
2137
+ },
2138
+ "ProductListItemReference": {
2139
+ "type": "object",
2140
+ "additionalProperties": false,
2141
+ "properties": {
2142
+ "id": {
2143
+ "type": "string",
2144
+ "maxLength": 256,
2145
+ "minLength": 1
2146
+ },
2147
+ "priority": {
2148
+ "type": "integer",
2149
+ "format": "int32"
2150
+ },
2151
+ "product": {
2152
+ "allOf": [
2153
+ {
2154
+ "$ref": "#/components/schemas/ProductReference"
2155
+ }
2156
+ ]
2157
+ },
2158
+ "productList": {
2159
+ "allOf": [
2160
+ {
2161
+ "$ref": "#/components/schemas/ProductListReference"
2162
+ }
2163
+ ]
2164
+ },
2165
+ "public": {
2166
+ "type": "boolean"
2167
+ },
2168
+ "purchasedQuantity": {
2169
+ "type": "number",
2170
+ "format": "double"
2171
+ },
2172
+ "quantity": {
2173
+ "type": "number",
2174
+ "format": "double",
2175
+ "minimum": 0
2176
+ },
2177
+ "type": {
2178
+ "type": "string",
2179
+ "enum": [
2180
+ "product",
2181
+ "gift_certificate"
2182
+ ]
2183
+ }
2184
+ },
2185
+ "required": [
2186
+ "purchasedQuantity"
2187
+ ]
2188
+ },
2189
+ "TaxItem": {
2190
+ "type": "object",
2191
+ "additionalProperties": {},
2192
+ "properties": {
2193
+ "id": {
2194
+ "type": "string",
2195
+ "maxLength": 256,
2196
+ "minLength": 1
2197
+ },
2198
+ "rate": {
2199
+ "type": "number",
2200
+ "format": "double"
2201
+ },
2202
+ "value": {
2203
+ "type": "number",
2204
+ "format": "double"
2205
+ }
2206
+ },
2207
+ "required": [
2208
+ "id",
2209
+ "rate"
2210
+ ]
2211
+ },
2212
+ "ShippingMethodReference": {
2213
+ "type": "object",
2214
+ "additionalProperties": false,
2215
+ "properties": {
2216
+ "id": {
2217
+ "type": "string",
2218
+ "maxLength": 256
2219
+ }
2220
+ }
2221
+ },
2222
+ "Shipment": {
2223
+ "type": "object",
2224
+ "additionalProperties": {},
2225
+ "properties": {
2226
+ "adjustedMerchandizeTotalTax": {
2227
+ "type": "number",
2228
+ "format": "double"
2229
+ },
2230
+ "adjustedShippingTotalTax": {
2231
+ "type": "number",
2232
+ "format": "double"
2233
+ },
2234
+ "gift": {
2235
+ "type": "boolean"
2236
+ },
2237
+ "giftMessage": {
2238
+ "type": "string",
2239
+ "maxLength": 4000
2240
+ },
2241
+ "merchandizeTotalTax": {
2242
+ "type": "number",
2243
+ "format": "double"
2244
+ },
2245
+ "productSubTotal": {
2246
+ "type": "number",
2247
+ "format": "double"
2248
+ },
2249
+ "productTotal": {
2250
+ "type": "number",
2251
+ "format": "double"
2252
+ },
2253
+ "shipmentId": {
2254
+ "type": "string",
2255
+ "maxLength": 256,
2256
+ "minLength": 1
2257
+ },
2258
+ "shipmentNo": {
2259
+ "type": "string",
2260
+ "maxLength": 256
2261
+ },
2262
+ "shipmentTotal": {
2263
+ "type": "number",
2264
+ "format": "double"
2265
+ },
2266
+ "shippingAddress": {
2267
+ "allOf": [
2268
+ {
2269
+ "$ref": "#/components/schemas/Address"
2270
+ }
2271
+ ]
2272
+ },
2273
+ "shippingMethod": {
2274
+ "allOf": [
2275
+ {
2276
+ "$ref": "#/components/schemas/ShippingMethodReference"
2277
+ }
2278
+ ]
2279
+ },
2280
+ "shippingStatus": {
2281
+ "type": "string",
2282
+ "enum": [
2283
+ "not_shipped",
2284
+ "shipped"
2285
+ ]
2286
+ },
2287
+ "shippingTotal": {
2288
+ "type": "number",
2289
+ "format": "double"
2290
+ },
2291
+ "shippingTotalTax": {
2292
+ "type": "number",
2293
+ "format": "double"
2294
+ },
2295
+ "taxTotal": {
2296
+ "type": "number",
2297
+ "format": "double"
2298
+ },
2299
+ "trackingNumber": {
2300
+ "type": "string",
2301
+ "maxLength": 256
2302
+ }
2303
+ },
2304
+ "required": [
2305
+ "shipmentId",
2306
+ "shipmentNo"
2307
+ ]
2308
+ },
2309
+ "ShippingItem": {
2310
+ "type": "object",
2311
+ "additionalProperties": {},
2312
+ "properties": {
2313
+ "basePrice": {
2314
+ "type": "number",
2315
+ "format": "double"
2316
+ },
2317
+ "grossPrice": {
2318
+ "type": "number",
2319
+ "format": "double"
2320
+ },
2321
+ "itemText": {
2322
+ "type": "string",
2323
+ "maxLength": 256
2324
+ },
2325
+ "netPrice": {
2326
+ "type": "number",
2327
+ "format": "double"
2328
+ },
2329
+ "tax": {
2330
+ "type": "number",
2331
+ "format": "double"
2332
+ },
2333
+ "taxBasis": {
2334
+ "type": "number",
2335
+ "format": "double"
2336
+ },
2337
+ "adjustedTax": {
2338
+ "type": "number",
2339
+ "format": "double"
2340
+ },
2341
+ "itemId": {
2342
+ "type": "string",
2343
+ "maxLength": 256,
2344
+ "minLength": 1
2345
+ },
2346
+ "priceAdjustments": {
2347
+ "type": "array",
2348
+ "items": {
2349
+ "$ref": "#/components/schemas/PriceAdjustment"
2350
+ }
2351
+ },
2352
+ "priceAfterItemDiscount": {
2353
+ "type": "number",
2354
+ "format": "double"
2355
+ },
2356
+ "shipmentId": {
2357
+ "type": "string",
2358
+ "maxLength": 256,
2359
+ "minLength": 1
2360
+ },
2361
+ "taxRate": {
2362
+ "type": "number",
2363
+ "format": "double"
2364
+ },
2365
+ "type": {
2366
+ "type": "string",
2367
+ "default": "fixed_price",
2368
+ "enum": [
2369
+ "fixed_price",
2370
+ "surcharge"
2371
+ ]
2372
+ }
2373
+ },
2374
+ "required": [
2375
+ "taxRate"
2376
+ ]
2377
+ },
2378
+ "OrderStatus": {
2379
+ "type": "string",
2380
+ "enum": [
2381
+ "created",
2382
+ "new",
2383
+ "completed",
2384
+ "cancelled",
2385
+ "failed"
2386
+ ]
2387
+ },
2388
+ "Order": {
2389
+ "type": "object",
2390
+ "additionalProperties": {},
2391
+ "properties": {
2392
+ "adjustedMerchandizeTotalTax": {
2393
+ "type": "number",
2394
+ "format": "double"
2395
+ },
2396
+ "adjustedShippingTotalTax": {
2397
+ "type": "number",
2398
+ "format": "double"
2399
+ },
2400
+ "affiliatePartnerId": {
2401
+ "type": "string",
2402
+ "maxLength": 256
2403
+ },
2404
+ "affiliatePartnerName": {
2405
+ "type": "string",
2406
+ "maxLength": 256
2407
+ },
2408
+ "billingAddress": {
2409
+ "allOf": [
2410
+ {
2411
+ "$ref": "#/components/schemas/Address"
2412
+ }
2413
+ ]
2414
+ },
2415
+ "bonusDiscountLineItems": {
2416
+ "type": "array",
2417
+ "items": {
2418
+ "$ref": "#/components/schemas/BonusDiscountLineItem"
2419
+ }
2420
+ },
2421
+ "businessType": {
2422
+ "type": "string",
2423
+ "enum": [
2424
+ "b2c",
2425
+ "b2b"
2426
+ ]
2427
+ },
2428
+ "cancelCode": {
2429
+ "type": "string",
2430
+ "maxLength": 256
2431
+ },
2432
+ "cancelDescription": {
2433
+ "type": "string",
2434
+ "maxLength": 4000
2435
+ },
2436
+ "channelType": {
2437
+ "type": "string",
2438
+ "enum": [
2439
+ "storefront",
2440
+ "callcenter",
2441
+ "marketplace",
2442
+ "dss",
2443
+ "store",
2444
+ "pinterest",
2445
+ "twitter",
2446
+ "facebookads",
2447
+ "subscriptions",
2448
+ "onlinereservation",
2449
+ "customerservicecenter",
2450
+ "instagramcommerce",
2451
+ "tiktok",
2452
+ "snapchat",
2453
+ "google",
2454
+ "whatsapp",
2455
+ "youtube"
2456
+ ]
2457
+ },
2458
+ "confirmationStatus": {
2459
+ "$ref": "#/components/schemas/OrderConfirmationStatus"
2460
+ },
2461
+ "couponItems": {
2462
+ "type": "array",
2463
+ "items": {
2464
+ "$ref": "#/components/schemas/CouponItem"
2465
+ }
2466
+ },
2467
+ "createdBy": {
2468
+ "type": "string",
2469
+ "maxLength": 256
2470
+ },
2471
+ "creationDate": {
2472
+ "type": "string",
2473
+ "format": "date-time"
2474
+ },
2475
+ "customerLocale": {
2476
+ "type": "string",
2477
+ "maxLength": 256
2478
+ },
2479
+ "currency": {
2480
+ "$ref": "#/components/schemas/CurrencyCode"
2481
+ },
2482
+ "customerInfo": {
2483
+ "$ref": "#/components/schemas/CustomerInfo"
2484
+ },
2485
+ "customerOrderReference": {
2486
+ "type": "string",
2487
+ "maxLength": 256
2488
+ },
2489
+ "exportStatus": {
2490
+ "$ref": "#/components/schemas/OrderExportStatus"
2491
+ },
2492
+ "externalOrderNo": {
2493
+ "type": "string",
2494
+ "maxLength": 256
2495
+ },
2496
+ "externalOrderStatus": {
2497
+ "type": "string",
2498
+ "maxLength": 256
2499
+ },
2500
+ "externalOrderText": {
2501
+ "type": "string",
2502
+ "maxLength": 4000
2503
+ },
2504
+ "giftCertificateItems": {
2505
+ "type": "array",
2506
+ "items": {
2507
+ "$ref": "#/components/schemas/GiftCertificateItem"
2508
+ }
2509
+ },
2510
+ "globalPartyId": {
2511
+ "type": "string",
2512
+ "maxLength": 256
2513
+ },
2514
+ "invoiceNo": {
2515
+ "type": "string",
2516
+ "maxLength": 256
2517
+ },
2518
+ "lastModified": {
2519
+ "type": "string",
2520
+ "format": "date-time"
2521
+ },
2522
+ "merchandizeTotalTax": {
2523
+ "type": "number",
2524
+ "format": "double"
2525
+ },
2526
+ "orderNo": {
2527
+ "$ref": "#/components/schemas/OrderNo"
2528
+ },
2529
+ "orderPriceAdjustments": {
2530
+ "type": "array",
2531
+ "items": {
2532
+ "$ref": "#/components/schemas/PriceAdjustment"
2533
+ }
2534
+ },
2535
+ "orderTotal": {
2536
+ "type": "number",
2537
+ "format": "double"
2538
+ },
2539
+ "paymentInstruments": {
2540
+ "type": "array",
2541
+ "items": {
2542
+ "$ref": "#/components/schemas/PaymentInstrument"
2543
+ }
2544
+ },
2545
+ "paymentStatus": {
2546
+ "$ref": "#/components/schemas/OrderPaymentStatus"
2547
+ },
2548
+ "placeDate": {
2549
+ "type": "string",
2550
+ "format": "date-time"
2551
+ },
2552
+ "productItems": {
2553
+ "type": "array",
2554
+ "items": {
2555
+ "$ref": "#/components/schemas/ProductItem"
2556
+ }
2557
+ },
2558
+ "productSubTotal": {
2559
+ "type": "number",
2560
+ "format": "double"
2561
+ },
2562
+ "productTotal": {
2563
+ "type": "number",
2564
+ "format": "double"
2565
+ },
2566
+ "remoteHost": {
2567
+ "type": "string",
2568
+ "maxLength": 40
2569
+ },
2570
+ "shipments": {
2571
+ "type": "array",
2572
+ "items": {
2573
+ "$ref": "#/components/schemas/Shipment"
2574
+ }
2575
+ },
2576
+ "shippingItems": {
2577
+ "type": "array",
2578
+ "items": {
2579
+ "$ref": "#/components/schemas/ShippingItem"
2580
+ }
2581
+ },
2582
+ "shippingStatus": {
2583
+ "$ref": "#/components/schemas/OrderShippingStatus"
2584
+ },
2585
+ "shippingTotal": {
2586
+ "type": "number",
2587
+ "format": "double"
2588
+ },
2589
+ "shippingTotalTax": {
2590
+ "type": "number",
2591
+ "format": "double"
2592
+ },
2593
+ "siteId": {
2594
+ "$ref": "#/components/schemas/SiteId"
2595
+ },
2596
+ "sourceCode": {
2597
+ "type": "string",
2598
+ "maxLength": 256
2599
+ },
2600
+ "sourceCodeGroupId": {
2601
+ "type": "string",
2602
+ "maxLength": 256,
2603
+ "minLength": 1
2604
+ },
2605
+ "status": {
2606
+ "$ref": "#/components/schemas/OrderStatus"
2607
+ },
2608
+ "taxTotal": {
2609
+ "type": "number",
2610
+ "format": "double"
2611
+ },
2612
+ "taxation": {
2613
+ "type": "string",
2614
+ "enum": [
2615
+ "gross",
2616
+ "net"
2617
+ ]
2618
+ }
2619
+ },
2620
+ "required": [
2621
+ "orderNo"
2622
+ ]
2623
+ },
2624
+ "OrdersResponse": {
2625
+ "type": "object",
2626
+ "additionalProperties": false,
2627
+ "properties": {
2628
+ "data": {
2629
+ "type": "array",
2630
+ "items": {
2631
+ "$ref": "#/components/schemas/Order"
2632
+ }
2633
+ }
2634
+ },
2635
+ "required": [
2636
+ "data"
2637
+ ]
2638
+ },
2639
+ "ErrorResponse": {
2640
+ "type": "object",
2641
+ "additionalProperties": true,
2642
+ "properties": {
2643
+ "title": {
2644
+ "type": "string",
2645
+ "maxLength": 256
2646
+ },
2647
+ "type": {
2648
+ "type": "string",
2649
+ "maxLength": 2048
2650
+ },
2651
+ "detail": {
2652
+ "type": "string"
2653
+ },
2654
+ "instance": {
2655
+ "type": "string",
2656
+ "maxLength": 2048
2657
+ }
2658
+ },
2659
+ "required": [
2660
+ "detail",
2661
+ "title",
2662
+ "type"
2663
+ ]
2664
+ },
2665
+ "CreateOrderPriceAdjustment": {
2666
+ "type": "object",
2667
+ "additionalProperties": {},
2668
+ "properties": {
2669
+ "amount": {
2670
+ "type": "number",
2671
+ "format": "double"
2672
+ },
2673
+ "basePrice": {
2674
+ "type": "number",
2675
+ "format": "double"
2676
+ },
2677
+ "grossPrice": {
2678
+ "type": "number",
2679
+ "format": "double"
2680
+ },
2681
+ "itemText": {
2682
+ "type": "string"
2683
+ },
2684
+ "netPrice": {
2685
+ "type": "number",
2686
+ "format": "double"
2687
+ },
2688
+ "reasonCode": {
2689
+ "type": "string"
2690
+ },
2691
+ "tax": {
2692
+ "type": "number",
2693
+ "format": "double"
2694
+ },
2695
+ "taxBasis": {
2696
+ "type": "number",
2697
+ "format": "double"
2698
+ }
2699
+ },
2700
+ "required": [
2701
+ "grossPrice",
2702
+ "netPrice",
2703
+ "tax"
2704
+ ]
2705
+ },
2706
+ "CreateOrderPaymentTransaction": {
2707
+ "type": "object",
2708
+ "additionalProperties": {},
2709
+ "properties": {
2710
+ "amount": {
2711
+ "type": "number",
2712
+ "format": "double"
2713
+ },
2714
+ "authorizationStatus": {
2715
+ "allOf": [
2716
+ {
2717
+ "$ref": "#/components/schemas/Status"
2718
+ }
2719
+ ]
2720
+ },
2721
+ "transactionId": {
2722
+ "type": "string",
2723
+ "maxLength": 256
2724
+ }
2725
+ },
2726
+ "required": [
2727
+ "amount",
2728
+ "transactionId"
2729
+ ]
2730
+ },
2731
+ "CreateOrderPaymentInstrument": {
2732
+ "type": "object",
2733
+ "additionalProperties": {},
2734
+ "properties": {
2735
+ "paymentMethodId": {
2736
+ "type": "string",
2737
+ "maxLength": 256
2738
+ },
2739
+ "paymentTransaction": {
2740
+ "allOf": [
2741
+ {
2742
+ "$ref": "#/components/schemas/CreateOrderPaymentTransaction"
2743
+ }
2744
+ ]
2745
+ }
2746
+ },
2747
+ "required": [
2748
+ "paymentMethodId"
2749
+ ]
2750
+ },
2751
+ "CreateOrderOptionItem": {
2752
+ "type": "object",
2753
+ "additionalProperties": {},
2754
+ "properties": {
2755
+ "basePrice": {
2756
+ "type": "number",
2757
+ "format": "double"
2758
+ },
2759
+ "grossPrice": {
2760
+ "type": "number",
2761
+ "format": "double"
2762
+ },
2763
+ "itemText": {
2764
+ "type": "string",
2765
+ "maxLength": 256
2766
+ },
2767
+ "netPrice": {
2768
+ "type": "number",
2769
+ "format": "double"
2770
+ },
2771
+ "tax": {
2772
+ "type": "number",
2773
+ "format": "double"
2774
+ },
2775
+ "taxBasis": {
2776
+ "type": "number",
2777
+ "format": "double"
2778
+ },
2779
+ "optionId": {
2780
+ "type": "string",
2781
+ "maxLength": 256,
2782
+ "minLength": 1
2783
+ },
2784
+ "optionValueId": {
2785
+ "type": "string",
2786
+ "maxLength": 256,
2787
+ "minLength": 1
2788
+ },
2789
+ "priceAdjustments": {
2790
+ "type": "array",
2791
+ "items": {
2792
+ "$ref": "#/components/schemas/CreateOrderPriceAdjustment"
2793
+ },
2794
+ "maxItems": 20
2795
+ },
2796
+ "productId": {
2797
+ "$ref": "#/components/schemas/ProductId"
2798
+ }
2799
+ },
2800
+ "required": [
2801
+ "basePrice",
2802
+ "grossPrice",
2803
+ "netPrice",
2804
+ "optionId",
2805
+ "optionValueId",
2806
+ "productId",
2807
+ "tax"
2808
+ ]
2809
+ },
2810
+ "CreateOrderProductItems": {
2811
+ "type": "object",
2812
+ "additionalProperties": {},
2813
+ "properties": {
2814
+ "basePrice": {
2815
+ "type": "number",
2816
+ "format": "double"
2817
+ },
2818
+ "brand": {
2819
+ "type": "string",
2820
+ "maxLength": 256
2821
+ },
2822
+ "grossPrice": {
2823
+ "type": "number",
2824
+ "format": "double"
2825
+ },
2826
+ "itemText": {
2827
+ "type": "string"
2828
+ },
2829
+ "netPrice": {
2830
+ "type": "number",
2831
+ "format": "double"
2832
+ },
2833
+ "optionItems": {
2834
+ "type": "array",
2835
+ "items": {
2836
+ "$ref": "#/components/schemas/CreateOrderOptionItem"
2837
+ },
2838
+ "maxItems": 10
2839
+ },
2840
+ "priceAdjustments": {
2841
+ "type": "array",
2842
+ "items": {
2843
+ "$ref": "#/components/schemas/CreateOrderPriceAdjustment"
2844
+ },
2845
+ "maxItems": 20
2846
+ },
2847
+ "productId": {
2848
+ "$ref": "#/components/schemas/ProductId"
2849
+ },
2850
+ "productName": {
2851
+ "type": "string",
2852
+ "maxLength": 256
2853
+ },
2854
+ "quantity": {
2855
+ "type": "number",
2856
+ "format": "double",
2857
+ "minimum": 0
2858
+ },
2859
+ "shipmentId": {
2860
+ "type": "string",
2861
+ "maxLength": 256,
2862
+ "minLength": 1
2863
+ },
2864
+ "tax": {
2865
+ "type": "number",
2866
+ "format": "double"
2867
+ },
2868
+ "taxBasis": {
2869
+ "type": "number",
2870
+ "format": "double"
2871
+ },
2872
+ "taxItems": {
2873
+ "type": "array",
2874
+ "items": {
2875
+ "$ref": "#/components/schemas/TaxItem"
2876
+ },
2877
+ "maxItems": 10
2878
+ },
2879
+ "taxRate": {
2880
+ "type": "number",
2881
+ "format": "double"
2882
+ }
2883
+ },
2884
+ "required": [
2885
+ "basePrice",
2886
+ "grossPrice",
2887
+ "netPrice",
2888
+ "productId",
2889
+ "quantity",
2890
+ "shipmentId",
2891
+ "tax"
2892
+ ]
2893
+ },
2894
+ "CreateOrderShipment": {
2895
+ "type": "object",
2896
+ "additionalProperties": {},
2897
+ "properties": {
2898
+ "shipmentId": {
2899
+ "type": "string",
2900
+ "maxLength": 256,
2901
+ "minLength": 1
2902
+ },
2903
+ "shippingMethod": {
2904
+ "type": "string"
2905
+ },
2906
+ "shippingAddress": {
2907
+ "allOf": [
2908
+ {
2909
+ "$ref": "#/components/schemas/Address"
2910
+ }
2911
+ ]
2912
+ },
2913
+ "shippingTotal": {
2914
+ "type": "number",
2915
+ "format": "double"
2916
+ },
2917
+ "taxTotal": {
2918
+ "type": "number",
2919
+ "format": "double"
2920
+ }
2921
+ },
2922
+ "required": [
2923
+ "shipmentId",
2924
+ "shippingAddress",
2925
+ "shippingMethod",
2926
+ "shippingTotal",
2927
+ "taxTotal"
2928
+ ]
2929
+ },
2930
+ "CreateOrderRequest": {
2931
+ "type": "object",
2932
+ "additionalProperties": {},
2933
+ "properties": {
2934
+ "billingAddress": {
2935
+ "allOf": [
2936
+ {
2937
+ "$ref": "#/components/schemas/Address"
2938
+ }
2939
+ ]
2940
+ },
2941
+ "businessType": {
2942
+ "type": "string",
2943
+ "enum": [
2944
+ "b2c",
2945
+ "b2b"
2946
+ ]
2947
+ },
2948
+ "channelType": {
2949
+ "type": "string",
2950
+ "enum": [
2951
+ "storefront",
2952
+ "callcenter",
2953
+ "marketplace",
2954
+ "dss",
2955
+ "store",
2956
+ "pinterest",
2957
+ "twitter",
2958
+ "facebookads",
2959
+ "subscriptions",
2960
+ "onlinereservation",
2961
+ "customerservicecenter",
2962
+ "instagramcommerce",
2963
+ "tiktok",
2964
+ "snapchat",
2965
+ "google",
2966
+ "whatsapp",
2967
+ "youtube"
2968
+ ]
2969
+ },
2970
+ "currency": {
2971
+ "$ref": "#/components/schemas/CurrencyCode"
2972
+ },
2973
+ "customerLocale": {
2974
+ "type": "string",
2975
+ "maxLength": 256
2976
+ },
2977
+ "orderNo": {
2978
+ "allOf": [
2979
+ {
2980
+ "$ref": "#/components/schemas/OrderNo"
2981
+ }
2982
+ ]
2983
+ },
2984
+ "orderPriceAdjustments": {
2985
+ "type": "array",
2986
+ "items": {
2987
+ "$ref": "#/components/schemas/CreateOrderPriceAdjustment"
2988
+ },
2989
+ "maxItems": 20
2990
+ },
2991
+ "orderTotal": {
2992
+ "type": "number",
2993
+ "format": "double"
2994
+ },
2995
+ "paymentInstruments": {
2996
+ "type": "array",
2997
+ "items": {
2998
+ "$ref": "#/components/schemas/CreateOrderPaymentInstrument"
2999
+ },
3000
+ "maxItems": 20
3001
+ },
3002
+ "paymentStatus": {
3003
+ "type": "string",
3004
+ "enum": [
3005
+ "paid",
3006
+ "not_paid"
3007
+ ]
3008
+ },
3009
+ "productItems": {
3010
+ "type": "array",
3011
+ "items": {
3012
+ "$ref": "#/components/schemas/CreateOrderProductItems"
3013
+ },
3014
+ "maxItems": 200,
3015
+ "minItems": 1
3016
+ },
3017
+ "shipments": {
3018
+ "type": "array",
3019
+ "items": {
3020
+ "$ref": "#/components/schemas/CreateOrderShipment"
3021
+ },
3022
+ "maxItems": 10,
3023
+ "minItems": 1
3024
+ },
3025
+ "taxTotal": {
3026
+ "type": "number",
3027
+ "format": "double"
3028
+ }
3029
+ },
3030
+ "required": [
3031
+ "billingAddress",
3032
+ "currency",
3033
+ "orderTotal",
3034
+ "paymentInstruments",
3035
+ "productItems",
3036
+ "shipments",
3037
+ "taxTotal"
3038
+ ]
3039
+ },
3040
+ "OrderUpdateRequest": {
3041
+ "type": "object",
3042
+ "additionalProperties": {}
3043
+ },
3044
+ "OrderConfirmationStatusUpdateRequest": {
3045
+ "type": "object",
3046
+ "additionalProperties": false,
3047
+ "properties": {
3048
+ "status": {
3049
+ "$ref": "#/components/schemas/OrderConfirmationStatus"
3050
+ }
3051
+ },
3052
+ "required": [
3053
+ "status"
3054
+ ]
3055
+ },
3056
+ "OrderExportStatusUpdateRequest": {
3057
+ "type": "object",
3058
+ "additionalProperties": false,
3059
+ "properties": {
3060
+ "status": {
3061
+ "$ref": "#/components/schemas/OrderExportStatus"
3062
+ }
3063
+ },
3064
+ "required": [
3065
+ "status"
3066
+ ]
3067
+ },
3068
+ "OrderExternalStatusUpdateRequest": {
3069
+ "type": "object",
3070
+ "additionalProperties": false,
3071
+ "properties": {
3072
+ "status": {
3073
+ "type": "string",
3074
+ "maxLength": 256,
3075
+ "minLength": 1
3076
+ }
3077
+ },
3078
+ "required": [
3079
+ "status"
3080
+ ]
3081
+ },
3082
+ "OrderPaymentStatusUpdateRequest": {
3083
+ "type": "object",
3084
+ "additionalProperties": false,
3085
+ "properties": {
3086
+ "status": {
3087
+ "$ref": "#/components/schemas/OrderPaymentStatus"
3088
+ }
3089
+ },
3090
+ "required": [
3091
+ "status"
3092
+ ]
3093
+ },
3094
+ "OrderShippingStatusUpdateRequest": {
3095
+ "type": "object",
3096
+ "additionalProperties": false,
3097
+ "properties": {
3098
+ "status": {
3099
+ "$ref": "#/components/schemas/OrderShippingStatus"
3100
+ }
3101
+ },
3102
+ "required": [
3103
+ "status"
3104
+ ]
3105
+ },
3106
+ "OmsLineItemReference": {
3107
+ "type": "object",
3108
+ "additionalProperties": false,
3109
+ "properties": {
3110
+ "id": {
3111
+ "type": "string",
3112
+ "maxLength": 256,
3113
+ "minLength": 1
3114
+ },
3115
+ "quantity": {
3116
+ "type": "integer",
3117
+ "minimum": 0
3118
+ }
3119
+ },
3120
+ "required": [
3121
+ "id",
3122
+ "quantity"
3123
+ ]
3124
+ },
3125
+ "OmsFulfillmentEvent": {
3126
+ "type": "object",
3127
+ "additionalProperties": false,
3128
+ "properties": {
3129
+ "id": {
3130
+ "type": "string",
3131
+ "maxLength": 256,
3132
+ "minLength": 1
3133
+ },
3134
+ "occurredAt": {
3135
+ "type": "string",
3136
+ "format": "date-time"
3137
+ },
3138
+ "type": {
3139
+ "type": "string",
3140
+ "maxLength": 256,
3141
+ "minLength": 1
3142
+ },
3143
+ "lineItems": {
3144
+ "type": "array",
3145
+ "items": {
3146
+ "$ref": "#/components/schemas/OmsLineItemReference"
3147
+ },
3148
+ "maxItems": 200,
3149
+ "minItems": 1
3150
+ },
3151
+ "trackingNumber": {
3152
+ "type": "string",
3153
+ "maxLength": 256,
3154
+ "minLength": 1
3155
+ },
3156
+ "trackingUrl": {
3157
+ "type": "string",
3158
+ "format": "uri",
3159
+ "maxLength": 2048,
3160
+ "minLength": 1
3161
+ },
3162
+ "carrier": {
3163
+ "type": "string",
3164
+ "maxLength": 256,
3165
+ "minLength": 1
3166
+ },
3167
+ "description": {
3168
+ "type": "string",
3169
+ "maxLength": 256,
3170
+ "minLength": 1
3171
+ }
3172
+ },
3173
+ "required": [
3174
+ "id",
3175
+ "lineItems",
3176
+ "occurredAt",
3177
+ "type"
3178
+ ]
3179
+ },
3180
+ "OmsAdjustmentLineItem": {
3181
+ "type": "object",
3182
+ "additionalProperties": false,
3183
+ "properties": {
3184
+ "id": {
3185
+ "type": "string",
3186
+ "maxLength": 256,
3187
+ "minLength": 1
3188
+ },
3189
+ "quantity": {
3190
+ "type": "integer"
3191
+ }
3192
+ },
3193
+ "required": [
3194
+ "id",
3195
+ "quantity"
3196
+ ]
3197
+ },
3198
+ "OmsAdjustmentTotal": {
3199
+ "type": "object",
3200
+ "additionalProperties": false,
3201
+ "properties": {
3202
+ "type": {
3203
+ "type": "string",
3204
+ "maxLength": 256,
3205
+ "minLength": 1
3206
+ },
3207
+ "amount": {
3208
+ "type": "integer"
3209
+ },
3210
+ "displayText": {
3211
+ "type": "string",
3212
+ "maxLength": 256,
3213
+ "minLength": 1
3214
+ }
3215
+ },
3216
+ "required": [
3217
+ "amount",
3218
+ "type"
3219
+ ]
3220
+ },
3221
+ "OmsAdjustment": {
3222
+ "type": "object",
3223
+ "additionalProperties": false,
3224
+ "properties": {
3225
+ "id": {
3226
+ "type": "string",
3227
+ "maxLength": 256,
3228
+ "minLength": 1
3229
+ },
3230
+ "type": {
3231
+ "type": "string",
3232
+ "maxLength": 256,
3233
+ "minLength": 1
3234
+ },
3235
+ "occurredAt": {
3236
+ "type": "string",
3237
+ "format": "date-time"
3238
+ },
3239
+ "status": {
3240
+ "type": "string",
3241
+ "enum": [
3242
+ "pending",
3243
+ "completed",
3244
+ "failed"
3245
+ ]
3246
+ },
3247
+ "lineItems": {
3248
+ "type": "array",
3249
+ "items": {
3250
+ "$ref": "#/components/schemas/OmsAdjustmentLineItem"
3251
+ },
3252
+ "maxItems": 200
3253
+ },
3254
+ "totals": {
3255
+ "type": "array",
3256
+ "items": {
3257
+ "$ref": "#/components/schemas/OmsAdjustmentTotal"
3258
+ },
3259
+ "maxItems": 200
3260
+ },
3261
+ "description": {
3262
+ "type": "string",
3263
+ "maxLength": 256,
3264
+ "minLength": 1
3265
+ }
3266
+ },
3267
+ "required": [
3268
+ "id",
3269
+ "occurredAt",
3270
+ "status",
3271
+ "type"
3272
+ ]
3273
+ },
3274
+ "OmsStatusEventRequest": {
3275
+ "additionalProperties": false,
3276
+ "oneOf": [
3277
+ {
3278
+ "required": [
3279
+ "fulfillmentEvent"
3280
+ ]
3281
+ },
3282
+ {
3283
+ "required": [
3284
+ "adjustment"
3285
+ ]
3286
+ }
3287
+ ],
3288
+ "properties": {
3289
+ "omsOrderId": {
3290
+ "type": "string",
3291
+ "maxLength": 256,
3292
+ "minLength": 1
3293
+ },
3294
+ "fulfillmentEvent": {
3295
+ "$ref": "#/components/schemas/OmsFulfillmentEvent"
3296
+ },
3297
+ "adjustment": {
3298
+ "$ref": "#/components/schemas/OmsAdjustment"
3299
+ }
3300
+ }
3301
+ },
3302
+ "OrderStatusUpdateRequest": {
3303
+ "type": "object",
3304
+ "additionalProperties": false,
3305
+ "properties": {
3306
+ "status": {
3307
+ "type": "string",
3308
+ "enum": [
3309
+ "created",
3310
+ "new",
3311
+ "completed",
3312
+ "cancelled",
3313
+ "failed",
3314
+ "failed_with_reopen"
3315
+ ]
3316
+ }
3317
+ },
3318
+ "required": [
3319
+ "status"
3320
+ ]
3321
+ },
3322
+ "PaymentInstrumentUpdateRequest": {
3323
+ "type": "object",
3324
+ "additionalProperties": {}
3325
+ },
3326
+ "PaymentTransactionUpdateRequest": {
3327
+ "type": "object",
3328
+ "additionalProperties": {}
3329
+ },
3330
+ "ShippingAddressUpdateRequest": {
3331
+ "allOf": [
3332
+ {
3333
+ "$ref": "#/components/schemas/Address"
3334
+ }
3335
+ ]
3336
+ }
3337
+ },
3338
+ "parameters": {
3339
+ "organizationId": {
3340
+ "name": "organizationId",
3341
+ "in": "path",
3342
+ "required": true,
3343
+ "style": "simple",
3344
+ "explode": false,
3345
+ "schema": {
3346
+ "$ref": "#/components/schemas/OrganizationId"
3347
+ }
3348
+ },
3349
+ "sortBy": {
3350
+ "name": "sortBy",
3351
+ "in": "query",
3352
+ "required": false,
3353
+ "style": "form",
3354
+ "explode": true,
3355
+ "schema": {
3356
+ "type": "string",
3357
+ "default": "creation_date",
3358
+ "enum": [
3359
+ "creation_date",
3360
+ "last_modified_date"
3361
+ ]
3362
+ }
3363
+ },
3364
+ "sortOrder": {
3365
+ "name": "sortOrder",
3366
+ "in": "query",
3367
+ "required": false,
3368
+ "style": "form",
3369
+ "explode": true,
3370
+ "schema": {
3371
+ "type": "string",
3372
+ "default": "desc",
3373
+ "enum": [
3374
+ "asc",
3375
+ "desc"
3376
+ ]
3377
+ }
3378
+ },
3379
+ "status": {
3380
+ "name": "status",
3381
+ "in": "query",
3382
+ "required": false,
3383
+ "style": "form",
3384
+ "explode": true,
3385
+ "schema": {
3386
+ "type": "string"
3387
+ }
3388
+ },
3389
+ "exportStatus": {
3390
+ "name": "exportStatus",
3391
+ "in": "query",
3392
+ "required": false,
3393
+ "style": "form",
3394
+ "explode": false,
3395
+ "schema": {
3396
+ "type": "array",
3397
+ "items": {
3398
+ "allOf": [
3399
+ {
3400
+ "$ref": "#/components/schemas/OrderExportStatus"
3401
+ }
3402
+ ]
3403
+ },
3404
+ "maxItems": 3
3405
+ }
3406
+ },
3407
+ "externalStatus": {
3408
+ "name": "externalStatus",
3409
+ "in": "query",
3410
+ "required": false,
3411
+ "style": "form",
3412
+ "explode": true,
3413
+ "schema": {
3414
+ "type": "string"
3415
+ }
3416
+ },
3417
+ "confirmationStatus": {
3418
+ "name": "confirmationStatus",
3419
+ "in": "query",
3420
+ "required": false,
3421
+ "style": "form",
3422
+ "explode": true,
3423
+ "schema": {
3424
+ "type": "string",
3425
+ "enum": [
3426
+ "confirmed",
3427
+ "not_confirmed"
3428
+ ]
3429
+ }
3430
+ },
3431
+ "paymentStatus": {
3432
+ "name": "paymentStatus",
3433
+ "in": "query",
3434
+ "required": false,
3435
+ "style": "form",
3436
+ "explode": false,
3437
+ "schema": {
3438
+ "type": "array",
3439
+ "items": {
3440
+ "allOf": [
3441
+ {
3442
+ "$ref": "#/components/schemas/OrderPaymentStatus"
3443
+ }
3444
+ ]
3445
+ },
3446
+ "maxItems": 3
3447
+ }
3448
+ },
3449
+ "shippingStatus": {
3450
+ "name": "shippingStatus",
3451
+ "in": "query",
3452
+ "required": false,
3453
+ "style": "form",
3454
+ "explode": false,
3455
+ "schema": {
3456
+ "type": "array",
3457
+ "items": {
3458
+ "allOf": [
3459
+ {
3460
+ "$ref": "#/components/schemas/OrderShippingStatus"
3461
+ }
3462
+ ]
3463
+ },
3464
+ "maxItems": 3
3465
+ }
3466
+ },
3467
+ "creationDateFrom": {
3468
+ "name": "creationDateFrom",
3469
+ "in": "query",
3470
+ "required": false,
3471
+ "style": "form",
3472
+ "explode": true,
3473
+ "schema": {
3474
+ "type": "string",
3475
+ "format": "date-time"
3476
+ }
3477
+ },
3478
+ "creationDateTo": {
3479
+ "name": "creationDateTo",
3480
+ "in": "query",
3481
+ "required": false,
3482
+ "style": "form",
3483
+ "explode": true,
3484
+ "schema": {
3485
+ "type": "string",
3486
+ "format": "date-time"
3487
+ }
3488
+ },
3489
+ "lastModifiedDateFrom": {
3490
+ "name": "lastModifiedDateFrom",
3491
+ "in": "query",
3492
+ "required": false,
3493
+ "style": "form",
3494
+ "explode": true,
3495
+ "schema": {
3496
+ "type": "string",
3497
+ "format": "date-time"
3498
+ }
3499
+ },
3500
+ "lastModifiedDateTo": {
3501
+ "name": "lastModifiedDateTo",
3502
+ "in": "query",
3503
+ "required": false,
3504
+ "style": "form",
3505
+ "explode": true,
3506
+ "schema": {
3507
+ "type": "string",
3508
+ "format": "date-time"
3509
+ }
3510
+ },
3511
+ "siteId": {
3512
+ "name": "siteId",
3513
+ "in": "query",
3514
+ "required": true,
3515
+ "style": "form",
3516
+ "explode": true,
3517
+ "schema": {
3518
+ "$ref": "#/components/schemas/SiteId"
3519
+ }
3520
+ },
3521
+ "orderNo": {
3522
+ "name": "orderNo",
3523
+ "in": "path",
3524
+ "required": true,
3525
+ "style": "simple",
3526
+ "explode": false,
3527
+ "schema": {
3528
+ "$ref": "#/components/schemas/OrderNo"
3529
+ }
3530
+ },
3531
+ "paymentInstrumentId": {
3532
+ "name": "paymentInstrumentId",
3533
+ "in": "path",
3534
+ "required": true,
3535
+ "style": "simple",
3536
+ "explode": false,
3537
+ "schema": {
3538
+ "type": "string",
3539
+ "minLength": 1
3540
+ }
3541
+ },
3542
+ "shipmentId": {
3543
+ "name": "shipmentId",
3544
+ "in": "path",
3545
+ "required": true,
3546
+ "style": "simple",
3547
+ "explode": false,
3548
+ "schema": {
3549
+ "type": "string",
3550
+ "minLength": 1
3551
+ }
3552
+ }
3553
+ },
3554
+ "securitySchemes": {
3555
+ "AmOAuth2": {
3556
+ "type": "oauth2",
3557
+ "flows": {
3558
+ "clientCredentials": {
3559
+ "tokenUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
3560
+ "scopes": {
3561
+ "sfcc.orders": "Scope granting read access to order endpoints",
3562
+ "sfcc.orders.rw": "Scope granting read and write access to order endpoints"
3563
+ }
3564
+ },
3565
+ "authorizationCode": {
3566
+ "authorizationUrl": "https://account.demandware.com/dwsso/oauth2/authorize",
3567
+ "tokenUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
3568
+ "scopes": {
3569
+ "sfcc.orders": "Scope granting read access to order endpoints",
3570
+ "sfcc.orders.rw": "Scope granting read and write access to order endpoints"
3571
+ }
3572
+ }
3573
+ }
3574
+ },
3575
+ "ShopperTokenTsob": {
3576
+ "type": "oauth2",
3577
+ "flows": {
3578
+ "clientCredentials": {
3579
+ "tokenUrl": "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/v1/organizations/{organizationId}/oauth2/trusted-system/token",
3580
+ "scopes": {
3581
+ "sfcc.orders": "Scope granting read access to order endpoints",
3582
+ "sfcc.orders.rw": "Scope granting read and write access to order endpoints"
3583
+ }
3584
+ }
3585
+ }
3586
+ }
3587
+ }
3588
+ }
3589
+ }