@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,4411 @@
1
+ {
2
+ "openapi": "3.0.3",
3
+ "info": {
4
+ "title": "Shopper Orders",
5
+ "version": "1.20.1",
6
+ "x-api-type": "Shopper",
7
+ "x-api-family": "Checkout"
8
+ },
9
+ "servers": [
10
+ {
11
+ "url": "https://{shortCode}.api.commercecloud.salesforce.com/checkout/shopper-orders/v1",
12
+ "variables": {
13
+ "shortCode": {
14
+ "default": "shortCode"
15
+ }
16
+ }
17
+ }
18
+ ],
19
+ "paths": {
20
+ "/organizations/{organizationId}/orders": {
21
+ "post": {
22
+ "operationId": "createOrder",
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": "siteId",
36
+ "in": "query",
37
+ "required": true,
38
+ "style": "form",
39
+ "explode": true,
40
+ "schema": {
41
+ "$ref": "#/components/schemas/SiteId"
42
+ }
43
+ },
44
+ {
45
+ "name": "locale",
46
+ "in": "query",
47
+ "required": false,
48
+ "style": "form",
49
+ "explode": true,
50
+ "schema": {
51
+ "$ref": "#/components/schemas/LocaleCode"
52
+ }
53
+ },
54
+ {
55
+ "name": "sfdc_usid",
56
+ "in": "header",
57
+ "required": false,
58
+ "style": "simple",
59
+ "explode": false,
60
+ "schema": {
61
+ "type": "string",
62
+ "format": "uuid"
63
+ }
64
+ },
65
+ {
66
+ "name": "sfdc_dw_dnt",
67
+ "in": "header",
68
+ "required": false,
69
+ "style": "simple",
70
+ "explode": false,
71
+ "schema": {
72
+ "type": "string",
73
+ "enum": [
74
+ "0",
75
+ "1"
76
+ ]
77
+ }
78
+ },
79
+ {
80
+ "name": "sfdc_shopper_context",
81
+ "in": "header",
82
+ "required": false,
83
+ "style": "simple",
84
+ "explode": false,
85
+ "schema": {
86
+ "type": "string"
87
+ }
88
+ }
89
+ ],
90
+ "requestBody": {
91
+ "content": {
92
+ "application/json": {
93
+ "schema": {
94
+ "$ref": "#/components/schemas/Basket"
95
+ }
96
+ }
97
+ }
98
+ },
99
+ "responses": {
100
+ "200": {
101
+ "description": "Success, the response body contains the submitted order.",
102
+ "content": {
103
+ "application/json": {
104
+ "schema": {
105
+ "$ref": "#/components/schemas/Order"
106
+ }
107
+ }
108
+ }
109
+ },
110
+ "400": {
111
+ "description": "Possible reasons:\n- a failure during the creation of a gift certificate\nfor a gift certificate item.\n- the basket ID in the request body is null or\nempty.\n- an invalid product item.\n- an option with the specified option ID is\nunknown.\n- an option with the specified option value ID\nis unknown.\n- a product item is not available.\n- the customer assigned to the basket does not\nmatch the verified customer represented by the JWT token.\n- the basket contains flashes (validation errors that prevent order placement).",
112
+ "content": {
113
+ "application/problem+json": {
114
+ "schema": {
115
+ "$ref": "#/components/schemas/ErrorResponse"
116
+ }
117
+ }
118
+ }
119
+ },
120
+ "404": {
121
+ "description": "The basket with the given basket ID is unknown.",
122
+ "content": {
123
+ "application/problem+json": {
124
+ "schema": {
125
+ "$ref": "#/components/schemas/ErrorResponse"
126
+ }
127
+ }
128
+ }
129
+ }
130
+ },
131
+ "security": [
132
+ {
133
+ "ShopperToken": [
134
+ "sfcc.shopper-baskets-orders.rw",
135
+ "sfcc.shopper-standard"
136
+ ]
137
+ },
138
+ {
139
+ "ShopperClientContextToken": [
140
+ "sfcc.shopper-baskets-orders.rw",
141
+ "sfcc.shopper-standard"
142
+ ]
143
+ }
144
+ ]
145
+ }
146
+ },
147
+ "/organizations/{organizationId}/orders/oms-meta-data": {
148
+ "get": {
149
+ "operationId": "getOmsMetaData",
150
+ "parameters": [
151
+ {
152
+ "name": "organizationId",
153
+ "in": "path",
154
+ "required": true,
155
+ "style": "simple",
156
+ "explode": false,
157
+ "schema": {
158
+ "$ref": "#/components/schemas/OrganizationId"
159
+ }
160
+ },
161
+ {
162
+ "name": "siteId",
163
+ "in": "query",
164
+ "required": true,
165
+ "style": "form",
166
+ "explode": true,
167
+ "schema": {
168
+ "$ref": "#/components/schemas/SiteId"
169
+ }
170
+ },
171
+ {
172
+ "name": "sfdc_usid",
173
+ "in": "header",
174
+ "required": false,
175
+ "style": "simple",
176
+ "explode": false,
177
+ "schema": {
178
+ "type": "string",
179
+ "format": "uuid"
180
+ }
181
+ },
182
+ {
183
+ "name": "sfdc_dw_dnt",
184
+ "in": "header",
185
+ "required": false,
186
+ "style": "simple",
187
+ "explode": false,
188
+ "schema": {
189
+ "type": "string",
190
+ "enum": [
191
+ "0",
192
+ "1"
193
+ ]
194
+ }
195
+ },
196
+ {
197
+ "name": "personalized",
198
+ "in": "query",
199
+ "required": false,
200
+ "style": "form",
201
+ "explode": true,
202
+ "schema": {
203
+ "type": "string",
204
+ "enum": [
205
+ "none"
206
+ ]
207
+ }
208
+ },
209
+ {
210
+ "name": "sfdc_shopper_context",
211
+ "in": "header",
212
+ "required": false,
213
+ "style": "simple",
214
+ "explode": false,
215
+ "schema": {
216
+ "type": "string"
217
+ }
218
+ }
219
+ ],
220
+ "responses": {
221
+ "200": {
222
+ "description": "Success, the response body contains the OMS meta data.",
223
+ "content": {
224
+ "application/json": {
225
+ "schema": {
226
+ "$ref": "#/components/schemas/OmsMetaData"
227
+ }
228
+ }
229
+ }
230
+ },
231
+ "409": {
232
+ "$ref": "#/components/responses/409OmsNotActive"
233
+ }
234
+ },
235
+ "security": [
236
+ {
237
+ "ShopperToken": [
238
+ "sfcc.shopper-baskets-orders",
239
+ "sfcc.shopper-baskets-orders.rw",
240
+ "sfcc.shopper-standard"
241
+ ]
242
+ },
243
+ {
244
+ "ShopperClientContextToken": [
245
+ "sfcc.shopper-baskets-orders",
246
+ "sfcc.shopper-baskets-orders.rw",
247
+ "sfcc.shopper-standard"
248
+ ]
249
+ }
250
+ ],
251
+ "x-extensionPoints": [
252
+ {
253
+ "phase": "modifyResponse",
254
+ "name": "sfcc.checkout.shopper-orders.v1.orders.oms-meta-data.modifyGETResponse",
255
+ "description": "Called to modify the OMS meta data returned in the response.",
256
+ "arguments": [
257
+ {
258
+ "$ref": "#/components/schemas/OmsMetaData"
259
+ }
260
+ ]
261
+ }
262
+ ]
263
+ }
264
+ },
265
+ "/organizations/{organizationId}/orders/{orderNo}": {
266
+ "get": {
267
+ "operationId": "getOrder",
268
+ "parameters": [
269
+ {
270
+ "name": "orderNo",
271
+ "in": "path",
272
+ "required": true,
273
+ "style": "simple",
274
+ "explode": false,
275
+ "schema": {
276
+ "$ref": "#/components/schemas/OrderNo"
277
+ }
278
+ },
279
+ {
280
+ "name": "organizationId",
281
+ "in": "path",
282
+ "required": true,
283
+ "style": "simple",
284
+ "explode": false,
285
+ "schema": {
286
+ "$ref": "#/components/schemas/OrganizationId"
287
+ }
288
+ },
289
+ {
290
+ "name": "siteId",
291
+ "in": "query",
292
+ "required": true,
293
+ "style": "form",
294
+ "explode": true,
295
+ "schema": {
296
+ "$ref": "#/components/schemas/SiteId"
297
+ }
298
+ },
299
+ {
300
+ "name": "locale",
301
+ "in": "query",
302
+ "required": false,
303
+ "style": "form",
304
+ "explode": true,
305
+ "schema": {
306
+ "$ref": "#/components/schemas/LocaleCode"
307
+ }
308
+ },
309
+ {
310
+ "name": "expand",
311
+ "in": "query",
312
+ "required": false,
313
+ "style": "form",
314
+ "explode": false,
315
+ "schema": {
316
+ "type": "array",
317
+ "items": {
318
+ "type": "string",
319
+ "enum": [
320
+ "oms",
321
+ "oms_shipments"
322
+ ]
323
+ }
324
+ }
325
+ },
326
+ {
327
+ "name": "sfdc_usid",
328
+ "in": "header",
329
+ "required": false,
330
+ "style": "simple",
331
+ "explode": false,
332
+ "schema": {
333
+ "type": "string",
334
+ "format": "uuid"
335
+ }
336
+ },
337
+ {
338
+ "name": "sfdc_dw_dnt",
339
+ "in": "header",
340
+ "required": false,
341
+ "style": "simple",
342
+ "explode": false,
343
+ "schema": {
344
+ "type": "string",
345
+ "enum": [
346
+ "0",
347
+ "1"
348
+ ]
349
+ }
350
+ },
351
+ {
352
+ "name": "personalized",
353
+ "in": "query",
354
+ "required": false,
355
+ "style": "form",
356
+ "explode": true,
357
+ "schema": {
358
+ "type": "string",
359
+ "enum": [
360
+ "none"
361
+ ]
362
+ }
363
+ },
364
+ {
365
+ "name": "sfdc_shopper_context",
366
+ "in": "header",
367
+ "required": false,
368
+ "style": "simple",
369
+ "explode": false,
370
+ "schema": {
371
+ "type": "string"
372
+ }
373
+ }
374
+ ],
375
+ "responses": {
376
+ "200": {
377
+ "description": "Success, the response body contains the order.",
378
+ "content": {
379
+ "application/json": {
380
+ "schema": {
381
+ "$ref": "#/components/schemas/Order"
382
+ }
383
+ }
384
+ }
385
+ },
386
+ "404": {
387
+ "description": "The order with the given order number is unknown.",
388
+ "content": {
389
+ "application/problem+json": {
390
+ "schema": {
391
+ "$ref": "#/components/schemas/ErrorResponse"
392
+ }
393
+ }
394
+ }
395
+ }
396
+ },
397
+ "security": [
398
+ {
399
+ "ShopperToken": [
400
+ "sfcc.shopper-baskets-orders",
401
+ "sfcc.shopper-baskets-orders.rw",
402
+ "sfcc.shopper-standard"
403
+ ]
404
+ },
405
+ {
406
+ "ShopperClientContextToken": [
407
+ "sfcc.shopper-baskets-orders",
408
+ "sfcc.shopper-baskets-orders.rw",
409
+ "sfcc.shopper-standard"
410
+ ]
411
+ }
412
+ ]
413
+ }
414
+ },
415
+ "/organizations/{organizationId}/orders/{orderNo}/lookup": {
416
+ "post": {
417
+ "operationId": "guestOrderLookup",
418
+ "parameters": [
419
+ {
420
+ "name": "organizationId",
421
+ "in": "path",
422
+ "required": true,
423
+ "style": "simple",
424
+ "explode": false,
425
+ "schema": {
426
+ "$ref": "#/components/schemas/OrganizationId"
427
+ }
428
+ },
429
+ {
430
+ "name": "orderNo",
431
+ "in": "path",
432
+ "required": true,
433
+ "style": "simple",
434
+ "explode": false,
435
+ "schema": {
436
+ "$ref": "#/components/schemas/OrderNo"
437
+ }
438
+ },
439
+ {
440
+ "name": "siteId",
441
+ "in": "query",
442
+ "required": true,
443
+ "style": "form",
444
+ "explode": true,
445
+ "schema": {
446
+ "$ref": "#/components/schemas/SiteId"
447
+ }
448
+ },
449
+ {
450
+ "name": "locale",
451
+ "in": "query",
452
+ "required": false,
453
+ "style": "form",
454
+ "explode": true,
455
+ "schema": {
456
+ "$ref": "#/components/schemas/LocaleCode"
457
+ }
458
+ },
459
+ {
460
+ "name": "expand",
461
+ "in": "query",
462
+ "required": false,
463
+ "style": "form",
464
+ "explode": false,
465
+ "schema": {
466
+ "type": "array",
467
+ "items": {
468
+ "type": "string",
469
+ "enum": [
470
+ "oms",
471
+ "oms_shipments"
472
+ ]
473
+ }
474
+ }
475
+ },
476
+ {
477
+ "name": "sfdc_usid",
478
+ "in": "header",
479
+ "required": false,
480
+ "style": "simple",
481
+ "explode": false,
482
+ "schema": {
483
+ "type": "string",
484
+ "format": "uuid"
485
+ }
486
+ },
487
+ {
488
+ "name": "sfdc_dw_dnt",
489
+ "in": "header",
490
+ "required": false,
491
+ "style": "simple",
492
+ "explode": false,
493
+ "schema": {
494
+ "type": "string",
495
+ "enum": [
496
+ "0",
497
+ "1"
498
+ ]
499
+ }
500
+ },
501
+ {
502
+ "name": "sfdc_shopper_context",
503
+ "in": "header",
504
+ "required": false,
505
+ "style": "simple",
506
+ "explode": false,
507
+ "schema": {
508
+ "type": "string"
509
+ }
510
+ }
511
+ ],
512
+ "requestBody": {
513
+ "content": {
514
+ "application/json": {
515
+ "schema": {
516
+ "$ref": "#/components/schemas/OrderLookupRequest"
517
+ }
518
+ }
519
+ }
520
+ },
521
+ "responses": {
522
+ "200": {
523
+ "description": "Success, the response returns the order, though sensitive details may be filtered based on access level.",
524
+ "content": {
525
+ "application/json": {
526
+ "schema": {
527
+ "$ref": "#/components/schemas/Order"
528
+ }
529
+ }
530
+ }
531
+ },
532
+ "400": {
533
+ "description": "Possible reasons:\n- The combination of identifying information is not sufficient for any access level.",
534
+ "content": {
535
+ "application/problem+json": {
536
+ "schema": {
537
+ "$ref": "#/components/schemas/ErrorResponse"
538
+ }
539
+ }
540
+ }
541
+ },
542
+ "404": {
543
+ "description": "Order was not found. Possible reasons:\n- the order with the given order number is unknown.\n- the combination of identifying information you provided, such as email or postal code, does not match the order record.\n- the provided access code is invalid or has expired.",
544
+ "content": {
545
+ "application/problem+json": {
546
+ "schema": {
547
+ "$ref": "#/components/schemas/ErrorResponse"
548
+ }
549
+ }
550
+ }
551
+ }
552
+ },
553
+ "security": [
554
+ {
555
+ "ShopperToken": [
556
+ "sfcc.shopper-baskets-orders",
557
+ "sfcc.shopper-baskets-orders.rw",
558
+ "sfcc.shopper-standard"
559
+ ]
560
+ },
561
+ {
562
+ "ShopperClientContextToken": [
563
+ "sfcc.shopper-baskets-orders",
564
+ "sfcc.shopper-baskets-orders.rw",
565
+ "sfcc.shopper-standard"
566
+ ]
567
+ }
568
+ ]
569
+ }
570
+ },
571
+ "/organizations/{organizationId}/orders/{orderNo}/actions/fail": {
572
+ "post": {
573
+ "operationId": "failOrder",
574
+ "parameters": [
575
+ {
576
+ "name": "organizationId",
577
+ "in": "path",
578
+ "required": true,
579
+ "style": "simple",
580
+ "explode": false,
581
+ "schema": {
582
+ "$ref": "#/components/schemas/OrganizationId"
583
+ }
584
+ },
585
+ {
586
+ "name": "orderNo",
587
+ "in": "path",
588
+ "required": true,
589
+ "style": "simple",
590
+ "explode": false,
591
+ "schema": {
592
+ "$ref": "#/components/schemas/OrderNo"
593
+ }
594
+ },
595
+ {
596
+ "name": "siteId",
597
+ "in": "query",
598
+ "required": true,
599
+ "style": "form",
600
+ "explode": true,
601
+ "schema": {
602
+ "$ref": "#/components/schemas/SiteId"
603
+ }
604
+ },
605
+ {
606
+ "name": "locale",
607
+ "in": "query",
608
+ "required": false,
609
+ "style": "form",
610
+ "explode": true,
611
+ "schema": {
612
+ "$ref": "#/components/schemas/LocaleCode"
613
+ }
614
+ },
615
+ {
616
+ "name": "reopenBasket",
617
+ "in": "query",
618
+ "required": false,
619
+ "style": "form",
620
+ "explode": true,
621
+ "schema": {
622
+ "type": "boolean",
623
+ "default": false
624
+ }
625
+ },
626
+ {
627
+ "name": "sfdc_usid",
628
+ "in": "header",
629
+ "required": false,
630
+ "style": "simple",
631
+ "explode": false,
632
+ "schema": {
633
+ "type": "string",
634
+ "format": "uuid"
635
+ }
636
+ },
637
+ {
638
+ "name": "sfdc_dw_dnt",
639
+ "in": "header",
640
+ "required": false,
641
+ "style": "simple",
642
+ "explode": false,
643
+ "schema": {
644
+ "type": "string",
645
+ "enum": [
646
+ "0",
647
+ "1"
648
+ ]
649
+ }
650
+ },
651
+ {
652
+ "name": "sfdc_shopper_context",
653
+ "in": "header",
654
+ "required": false,
655
+ "style": "simple",
656
+ "explode": false,
657
+ "schema": {
658
+ "type": "string"
659
+ }
660
+ }
661
+ ],
662
+ "requestBody": {
663
+ "content": {
664
+ "application/json": {
665
+ "schema": {
666
+ "$ref": "#/components/schemas/FailOrderRequest"
667
+ }
668
+ }
669
+ }
670
+ },
671
+ "responses": {
672
+ "201": {
673
+ "description": "Order failed successfully. No content returned.\n",
674
+ "headers": {
675
+ "Location": {
676
+ "style": "simple",
677
+ "explode": false,
678
+ "schema": {
679
+ "type": "string"
680
+ }
681
+ }
682
+ }
683
+ },
684
+ "204": {
685
+ "description": "Order failed successfully. No content returned.\n"
686
+ },
687
+ "400": {
688
+ "description": "Possible reasons:\n - Invalid request parameters.",
689
+ "content": {
690
+ "application/problem+json": {
691
+ "schema": {
692
+ "$ref": "#/components/schemas/ErrorResponse"
693
+ }
694
+ }
695
+ }
696
+ },
697
+ "404": {
698
+ "description": "The order with the given order number is unknown for the shopper.",
699
+ "content": {
700
+ "application/problem+json": {
701
+ "schema": {
702
+ "$ref": "#/components/schemas/ErrorResponse"
703
+ }
704
+ }
705
+ }
706
+ },
707
+ "409": {
708
+ "description": "The order is in invalid status.",
709
+ "content": {
710
+ "application/problem+json": {
711
+ "schema": {
712
+ "$ref": "#/components/schemas/ErrorResponse"
713
+ }
714
+ }
715
+ }
716
+ }
717
+ },
718
+ "security": [
719
+ {
720
+ "ShopperToken": [
721
+ "sfcc.shopper-baskets-orders.rw",
722
+ "sfcc.shopper-standard"
723
+ ]
724
+ },
725
+ {
726
+ "ShopperClientContextToken": [
727
+ "sfcc.shopper-baskets-orders.rw",
728
+ "sfcc.shopper-standard"
729
+ ]
730
+ }
731
+ ]
732
+ }
733
+ },
734
+ "/organizations/{organizationId}/orders/{orderNo}/actions/oms-cancel-order": {
735
+ "post": {
736
+ "operationId": "cancelOmsOrder",
737
+ "parameters": [
738
+ {
739
+ "name": "organizationId",
740
+ "in": "path",
741
+ "required": true,
742
+ "style": "simple",
743
+ "explode": false,
744
+ "schema": {
745
+ "$ref": "#/components/schemas/OrganizationId"
746
+ }
747
+ },
748
+ {
749
+ "name": "orderNo",
750
+ "in": "path",
751
+ "required": true,
752
+ "style": "simple",
753
+ "explode": false,
754
+ "schema": {
755
+ "$ref": "#/components/schemas/OrderNo"
756
+ }
757
+ },
758
+ {
759
+ "name": "siteId",
760
+ "in": "query",
761
+ "required": true,
762
+ "style": "form",
763
+ "explode": true,
764
+ "schema": {
765
+ "$ref": "#/components/schemas/SiteId"
766
+ }
767
+ },
768
+ {
769
+ "name": "locale",
770
+ "in": "query",
771
+ "required": false,
772
+ "style": "form",
773
+ "explode": true,
774
+ "schema": {
775
+ "$ref": "#/components/schemas/LocaleCode"
776
+ }
777
+ },
778
+ {
779
+ "name": "sfdc_usid",
780
+ "in": "header",
781
+ "required": false,
782
+ "style": "simple",
783
+ "explode": false,
784
+ "schema": {
785
+ "type": "string",
786
+ "format": "uuid"
787
+ }
788
+ },
789
+ {
790
+ "name": "sfdc_dw_dnt",
791
+ "in": "header",
792
+ "required": false,
793
+ "style": "simple",
794
+ "explode": false,
795
+ "schema": {
796
+ "type": "string",
797
+ "enum": [
798
+ "0",
799
+ "1"
800
+ ]
801
+ }
802
+ },
803
+ {
804
+ "name": "sfdc_shopper_context",
805
+ "in": "header",
806
+ "required": false,
807
+ "style": "simple",
808
+ "explode": false,
809
+ "schema": {
810
+ "type": "string"
811
+ }
812
+ }
813
+ ],
814
+ "requestBody": {
815
+ "content": {
816
+ "application/json": {
817
+ "schema": {
818
+ "$ref": "#/components/schemas/OmsCancelOrderRequest"
819
+ }
820
+ }
821
+ },
822
+ "required": true
823
+ },
824
+ "responses": {
825
+ "200": {
826
+ "description": "Success, the response body contains the updated order retrieved from Order Management (OMS).",
827
+ "content": {
828
+ "application/json": {
829
+ "schema": {
830
+ "$ref": "#/components/schemas/Order"
831
+ }
832
+ }
833
+ }
834
+ },
835
+ "400": {
836
+ "$ref": "#/components/responses/400OmsCancelBadRequest"
837
+ },
838
+ "404": {
839
+ "description": "Order was not found. Possible reasons:\n- the order with the given order number is unknown.\n- the provided access code is invalid or has expired.",
840
+ "content": {
841
+ "application/problem+json": {
842
+ "schema": {
843
+ "$ref": "#/components/schemas/ErrorResponse"
844
+ }
845
+ }
846
+ }
847
+ },
848
+ "409": {
849
+ "$ref": "#/components/responses/409OmsCancelConflict"
850
+ }
851
+ },
852
+ "security": [
853
+ {
854
+ "ShopperToken": [
855
+ "sfcc.shopper-baskets-orders.rw",
856
+ "sfcc.shopper-standard"
857
+ ]
858
+ },
859
+ {
860
+ "ShopperClientContextToken": [
861
+ "sfcc.shopper-baskets-orders.rw",
862
+ "sfcc.shopper-standard"
863
+ ]
864
+ }
865
+ ],
866
+ "x-extensionPoints": [
867
+ {
868
+ "phase": "modifyResponse",
869
+ "name": "sfcc.checkout.shopper-orders.v1.orders.orderNo.actions.oms-cancel-order.modifyPOSTResponse",
870
+ "description": "Called to modify the order returned in the response after cancellation.",
871
+ "arguments": [
872
+ {
873
+ "$ref": "#/components/schemas/Order"
874
+ }
875
+ ]
876
+ }
877
+ ]
878
+ }
879
+ },
880
+ "/organizations/{organizationId}/orders/{orderNo}/actions/oms-return-order": {
881
+ "post": {
882
+ "operationId": "returnOmsOrder",
883
+ "parameters": [
884
+ {
885
+ "name": "organizationId",
886
+ "in": "path",
887
+ "required": true,
888
+ "style": "simple",
889
+ "explode": false,
890
+ "schema": {
891
+ "$ref": "#/components/schemas/OrganizationId"
892
+ }
893
+ },
894
+ {
895
+ "name": "orderNo",
896
+ "in": "path",
897
+ "required": true,
898
+ "style": "simple",
899
+ "explode": false,
900
+ "schema": {
901
+ "$ref": "#/components/schemas/OrderNo"
902
+ }
903
+ },
904
+ {
905
+ "name": "siteId",
906
+ "in": "query",
907
+ "required": true,
908
+ "style": "form",
909
+ "explode": true,
910
+ "schema": {
911
+ "$ref": "#/components/schemas/SiteId"
912
+ }
913
+ },
914
+ {
915
+ "name": "locale",
916
+ "in": "query",
917
+ "required": false,
918
+ "style": "form",
919
+ "explode": true,
920
+ "schema": {
921
+ "$ref": "#/components/schemas/LocaleCode"
922
+ }
923
+ },
924
+ {
925
+ "name": "sfdc_usid",
926
+ "in": "header",
927
+ "required": false,
928
+ "style": "simple",
929
+ "explode": false,
930
+ "schema": {
931
+ "type": "string",
932
+ "format": "uuid"
933
+ }
934
+ },
935
+ {
936
+ "name": "sfdc_dw_dnt",
937
+ "in": "header",
938
+ "required": false,
939
+ "style": "simple",
940
+ "explode": false,
941
+ "schema": {
942
+ "type": "string",
943
+ "enum": [
944
+ "0",
945
+ "1"
946
+ ]
947
+ }
948
+ },
949
+ {
950
+ "name": "sfdc_shopper_context",
951
+ "in": "header",
952
+ "required": false,
953
+ "style": "simple",
954
+ "explode": false,
955
+ "schema": {
956
+ "type": "string"
957
+ }
958
+ }
959
+ ],
960
+ "requestBody": {
961
+ "content": {
962
+ "application/json": {
963
+ "schema": {
964
+ "$ref": "#/components/schemas/OmsReturnOrderRequest"
965
+ }
966
+ }
967
+ },
968
+ "required": true
969
+ },
970
+ "responses": {
971
+ "200": {
972
+ "description": "Success, the response body contains the updated order retrieved from Order Management (OMS).",
973
+ "content": {
974
+ "application/json": {
975
+ "schema": {
976
+ "$ref": "#/components/schemas/Order"
977
+ }
978
+ }
979
+ }
980
+ },
981
+ "400": {
982
+ "$ref": "#/components/responses/400OmsReturnBadRequest"
983
+ },
984
+ "404": {
985
+ "description": "Order was not found. Possible reasons:\n- the order with the given order number is unknown.\n- the provided access code is invalid or has expired.",
986
+ "content": {
987
+ "application/problem+json": {
988
+ "schema": {
989
+ "$ref": "#/components/schemas/ErrorResponse"
990
+ }
991
+ }
992
+ }
993
+ },
994
+ "409": {
995
+ "$ref": "#/components/responses/409OmsReturnConflict"
996
+ }
997
+ },
998
+ "security": [
999
+ {
1000
+ "ShopperToken": [
1001
+ "sfcc.shopper-baskets-orders.rw",
1002
+ "sfcc.shopper-standard"
1003
+ ]
1004
+ },
1005
+ {
1006
+ "ShopperClientContextToken": [
1007
+ "sfcc.shopper-baskets-orders.rw",
1008
+ "sfcc.shopper-standard"
1009
+ ]
1010
+ }
1011
+ ],
1012
+ "x-extensionPoints": [
1013
+ {
1014
+ "phase": "modifyResponse",
1015
+ "name": "sfcc.checkout.shopper-orders.v1.orders.orderNo.actions.oms-return-order.modifyPOSTResponse",
1016
+ "description": "Called to modify the order returned in the response after the return was initiated.",
1017
+ "arguments": [
1018
+ {
1019
+ "$ref": "#/components/schemas/Order"
1020
+ }
1021
+ ]
1022
+ }
1023
+ ]
1024
+ }
1025
+ },
1026
+ "/organizations/{organizationId}/orders/{orderNo}/actions/request-access-code": {
1027
+ "post": {
1028
+ "operationId": "requestOrderAccessCode",
1029
+ "parameters": [
1030
+ {
1031
+ "name": "organizationId",
1032
+ "in": "path",
1033
+ "required": true,
1034
+ "style": "simple",
1035
+ "explode": false,
1036
+ "schema": {
1037
+ "$ref": "#/components/schemas/OrganizationId"
1038
+ }
1039
+ },
1040
+ {
1041
+ "name": "orderNo",
1042
+ "in": "path",
1043
+ "required": true,
1044
+ "style": "simple",
1045
+ "explode": false,
1046
+ "schema": {
1047
+ "$ref": "#/components/schemas/OrderNo"
1048
+ }
1049
+ },
1050
+ {
1051
+ "name": "siteId",
1052
+ "in": "query",
1053
+ "required": true,
1054
+ "style": "form",
1055
+ "explode": true,
1056
+ "schema": {
1057
+ "$ref": "#/components/schemas/SiteId"
1058
+ }
1059
+ },
1060
+ {
1061
+ "name": "locale",
1062
+ "in": "query",
1063
+ "required": false,
1064
+ "style": "form",
1065
+ "explode": true,
1066
+ "schema": {
1067
+ "$ref": "#/components/schemas/LocaleCode"
1068
+ }
1069
+ },
1070
+ {
1071
+ "name": "expand",
1072
+ "in": "query",
1073
+ "required": false,
1074
+ "style": "form",
1075
+ "explode": false,
1076
+ "schema": {
1077
+ "type": "array",
1078
+ "items": {
1079
+ "type": "string",
1080
+ "enum": [
1081
+ "oms"
1082
+ ]
1083
+ }
1084
+ }
1085
+ },
1086
+ {
1087
+ "name": "sfdc_usid",
1088
+ "in": "header",
1089
+ "required": false,
1090
+ "style": "simple",
1091
+ "explode": false,
1092
+ "schema": {
1093
+ "type": "string",
1094
+ "format": "uuid"
1095
+ }
1096
+ },
1097
+ {
1098
+ "name": "sfdc_dw_dnt",
1099
+ "in": "header",
1100
+ "required": false,
1101
+ "style": "simple",
1102
+ "explode": false,
1103
+ "schema": {
1104
+ "type": "string",
1105
+ "enum": [
1106
+ "0",
1107
+ "1"
1108
+ ]
1109
+ }
1110
+ },
1111
+ {
1112
+ "name": "sfdc_shopper_context",
1113
+ "in": "header",
1114
+ "required": false,
1115
+ "style": "simple",
1116
+ "explode": false,
1117
+ "schema": {
1118
+ "type": "string"
1119
+ }
1120
+ }
1121
+ ],
1122
+ "requestBody": {
1123
+ "content": {
1124
+ "application/json": {
1125
+ "schema": {
1126
+ "$ref": "#/components/schemas/RequestOrderAccessCodeRequest"
1127
+ }
1128
+ }
1129
+ },
1130
+ "required": true
1131
+ },
1132
+ "responses": {
1133
+ "202": {
1134
+ "description": "Accepted. Always returned, regardless of whether the order and email combination is valid, to prevent enumeration of valid orders.\nIf the combination is valid, a new access code is generated and delivered via email."
1135
+ },
1136
+ "400": {
1137
+ "$ref": "#/components/responses/400RequestAccessCodeBadRequest"
1138
+ }
1139
+ },
1140
+ "security": [
1141
+ {
1142
+ "ShopperToken": [
1143
+ "sfcc.shopper-baskets-orders",
1144
+ "sfcc.shopper-baskets-orders.rw",
1145
+ "sfcc.shopper-standard"
1146
+ ]
1147
+ },
1148
+ {
1149
+ "ShopperClientContextToken": [
1150
+ "sfcc.shopper-baskets-orders",
1151
+ "sfcc.shopper-baskets-orders.rw",
1152
+ "sfcc.shopper-standard"
1153
+ ]
1154
+ }
1155
+ ],
1156
+ "x-extensionPoints": [
1157
+ {
1158
+ "phase": "service-logic",
1159
+ "name": "sfcc.app.order.sendOrderAccessCode",
1160
+ "description": "Invoked to send the access code via email when the order number and email combination is valid.",
1161
+ "arguments": [
1162
+ {
1163
+ "$ref": "#/components/schemas/Order"
1164
+ },
1165
+ {
1166
+ "$ref": "#/components/schemas/OrderAccessCode"
1167
+ }
1168
+ ]
1169
+ }
1170
+ ]
1171
+ }
1172
+ },
1173
+ "/organizations/{organizationId}/orders/{orderNo}/payment-instruments": {
1174
+ "post": {
1175
+ "operationId": "createPaymentInstrumentForOrder",
1176
+ "parameters": [
1177
+ {
1178
+ "name": "organizationId",
1179
+ "in": "path",
1180
+ "required": true,
1181
+ "style": "simple",
1182
+ "explode": false,
1183
+ "schema": {
1184
+ "$ref": "#/components/schemas/OrganizationId"
1185
+ }
1186
+ },
1187
+ {
1188
+ "name": "orderNo",
1189
+ "in": "path",
1190
+ "required": true,
1191
+ "style": "simple",
1192
+ "explode": false,
1193
+ "schema": {
1194
+ "$ref": "#/components/schemas/OrderNo"
1195
+ }
1196
+ },
1197
+ {
1198
+ "name": "siteId",
1199
+ "in": "query",
1200
+ "required": true,
1201
+ "style": "form",
1202
+ "explode": true,
1203
+ "schema": {
1204
+ "$ref": "#/components/schemas/SiteId"
1205
+ }
1206
+ },
1207
+ {
1208
+ "name": "locale",
1209
+ "in": "query",
1210
+ "required": false,
1211
+ "style": "form",
1212
+ "explode": true,
1213
+ "schema": {
1214
+ "$ref": "#/components/schemas/LocaleCode"
1215
+ }
1216
+ },
1217
+ {
1218
+ "name": "sfdc_usid",
1219
+ "in": "header",
1220
+ "required": false,
1221
+ "style": "simple",
1222
+ "explode": false,
1223
+ "schema": {
1224
+ "type": "string",
1225
+ "format": "uuid"
1226
+ }
1227
+ },
1228
+ {
1229
+ "name": "sfdc_dw_dnt",
1230
+ "in": "header",
1231
+ "required": false,
1232
+ "style": "simple",
1233
+ "explode": false,
1234
+ "schema": {
1235
+ "type": "string",
1236
+ "enum": [
1237
+ "0",
1238
+ "1"
1239
+ ]
1240
+ }
1241
+ },
1242
+ {
1243
+ "name": "sfdc_shopper_context",
1244
+ "in": "header",
1245
+ "required": false,
1246
+ "style": "simple",
1247
+ "explode": false,
1248
+ "schema": {
1249
+ "type": "string"
1250
+ }
1251
+ }
1252
+ ],
1253
+ "requestBody": {
1254
+ "content": {
1255
+ "application/json": {
1256
+ "schema": {
1257
+ "$ref": "#/components/schemas/OrderPaymentInstrumentRequest"
1258
+ }
1259
+ }
1260
+ }
1261
+ },
1262
+ "responses": {
1263
+ "200": {
1264
+ "description": "Success, the response body contains the order with the added payment instrument.",
1265
+ "content": {
1266
+ "application/json": {
1267
+ "schema": {
1268
+ "$ref": "#/components/schemas/Order"
1269
+ }
1270
+ }
1271
+ }
1272
+ },
1273
+ "400": {
1274
+ "description": "Possible reasons:\n- the given order number is invalid.\n- the provided payment method is invalid or not applicable.",
1275
+ "content": {
1276
+ "application/problem+json": {
1277
+ "schema": {
1278
+ "$ref": "#/components/schemas/ErrorResponse"
1279
+ }
1280
+ }
1281
+ }
1282
+ },
1283
+ "404": {
1284
+ "description": "The order with the given order number is unknown.",
1285
+ "content": {
1286
+ "application/problem+json": {
1287
+ "schema": {
1288
+ "$ref": "#/components/schemas/ErrorResponse"
1289
+ }
1290
+ }
1291
+ }
1292
+ }
1293
+ },
1294
+ "security": [
1295
+ {
1296
+ "ShopperToken": [
1297
+ "sfcc.shopper-baskets-orders.rw",
1298
+ "sfcc.shopper-standard"
1299
+ ]
1300
+ },
1301
+ {
1302
+ "ShopperClientContextToken": [
1303
+ "sfcc.shopper-baskets-orders.rw",
1304
+ "sfcc.shopper-standard"
1305
+ ]
1306
+ }
1307
+ ]
1308
+ }
1309
+ },
1310
+ "/organizations/{organizationId}/orders/{orderNo}/payment-instruments/{paymentInstrumentId}": {
1311
+ "delete": {
1312
+ "operationId": "removePaymentInstrumentFromOrder",
1313
+ "parameters": [
1314
+ {
1315
+ "name": "paymentInstrumentId",
1316
+ "in": "path",
1317
+ "required": true,
1318
+ "style": "simple",
1319
+ "explode": false,
1320
+ "schema": {
1321
+ "$ref": "#/components/schemas/PaymentInstrumentId"
1322
+ }
1323
+ },
1324
+ {
1325
+ "name": "organizationId",
1326
+ "in": "path",
1327
+ "required": true,
1328
+ "style": "simple",
1329
+ "explode": false,
1330
+ "schema": {
1331
+ "$ref": "#/components/schemas/OrganizationId"
1332
+ }
1333
+ },
1334
+ {
1335
+ "name": "orderNo",
1336
+ "in": "path",
1337
+ "required": true,
1338
+ "style": "simple",
1339
+ "explode": false,
1340
+ "schema": {
1341
+ "$ref": "#/components/schemas/OrderNo"
1342
+ }
1343
+ },
1344
+ {
1345
+ "name": "siteId",
1346
+ "in": "query",
1347
+ "required": true,
1348
+ "style": "form",
1349
+ "explode": true,
1350
+ "schema": {
1351
+ "$ref": "#/components/schemas/SiteId"
1352
+ }
1353
+ },
1354
+ {
1355
+ "name": "locale",
1356
+ "in": "query",
1357
+ "required": false,
1358
+ "style": "form",
1359
+ "explode": true,
1360
+ "schema": {
1361
+ "$ref": "#/components/schemas/LocaleCode"
1362
+ }
1363
+ },
1364
+ {
1365
+ "name": "sfdc_usid",
1366
+ "in": "header",
1367
+ "required": false,
1368
+ "style": "simple",
1369
+ "explode": false,
1370
+ "schema": {
1371
+ "type": "string",
1372
+ "format": "uuid"
1373
+ }
1374
+ },
1375
+ {
1376
+ "name": "sfdc_dw_dnt",
1377
+ "in": "header",
1378
+ "required": false,
1379
+ "style": "simple",
1380
+ "explode": false,
1381
+ "schema": {
1382
+ "type": "string",
1383
+ "enum": [
1384
+ "0",
1385
+ "1"
1386
+ ]
1387
+ }
1388
+ },
1389
+ {
1390
+ "name": "sfdc_shopper_context",
1391
+ "in": "header",
1392
+ "required": false,
1393
+ "style": "simple",
1394
+ "explode": false,
1395
+ "schema": {
1396
+ "type": "string"
1397
+ }
1398
+ }
1399
+ ],
1400
+ "responses": {
1401
+ "200": {
1402
+ "description": "Success, the response body contains the order without the deleted payment instrument.",
1403
+ "content": {
1404
+ "application/json": {
1405
+ "schema": {
1406
+ "$ref": "#/components/schemas/Order"
1407
+ }
1408
+ }
1409
+ }
1410
+ },
1411
+ "404": {
1412
+ "description": "Possible reasons:\n- The order with the given order number is unknown.\n- The payment instrument with the given order payment\ninstrument ID is unknown.",
1413
+ "content": {
1414
+ "application/problem+json": {
1415
+ "schema": {
1416
+ "$ref": "#/components/schemas/ErrorResponse"
1417
+ }
1418
+ }
1419
+ }
1420
+ }
1421
+ },
1422
+ "security": [
1423
+ {
1424
+ "ShopperToken": [
1425
+ "sfcc.shopper-baskets-orders.rw",
1426
+ "sfcc.shopper-standard"
1427
+ ]
1428
+ },
1429
+ {
1430
+ "ShopperClientContextToken": [
1431
+ "sfcc.shopper-baskets-orders.rw",
1432
+ "sfcc.shopper-standard"
1433
+ ]
1434
+ }
1435
+ ]
1436
+ },
1437
+ "patch": {
1438
+ "operationId": "updatePaymentInstrumentForOrder",
1439
+ "parameters": [
1440
+ {
1441
+ "name": "paymentInstrumentId",
1442
+ "in": "path",
1443
+ "required": true,
1444
+ "style": "simple",
1445
+ "explode": false,
1446
+ "schema": {
1447
+ "$ref": "#/components/schemas/PaymentInstrumentId"
1448
+ }
1449
+ },
1450
+ {
1451
+ "name": "organizationId",
1452
+ "in": "path",
1453
+ "required": true,
1454
+ "style": "simple",
1455
+ "explode": false,
1456
+ "schema": {
1457
+ "$ref": "#/components/schemas/OrganizationId"
1458
+ }
1459
+ },
1460
+ {
1461
+ "name": "orderNo",
1462
+ "in": "path",
1463
+ "required": true,
1464
+ "style": "simple",
1465
+ "explode": false,
1466
+ "schema": {
1467
+ "$ref": "#/components/schemas/OrderNo"
1468
+ }
1469
+ },
1470
+ {
1471
+ "name": "siteId",
1472
+ "in": "query",
1473
+ "required": true,
1474
+ "style": "form",
1475
+ "explode": true,
1476
+ "schema": {
1477
+ "$ref": "#/components/schemas/SiteId"
1478
+ }
1479
+ },
1480
+ {
1481
+ "name": "locale",
1482
+ "in": "query",
1483
+ "required": false,
1484
+ "style": "form",
1485
+ "explode": true,
1486
+ "schema": {
1487
+ "$ref": "#/components/schemas/LocaleCode"
1488
+ }
1489
+ },
1490
+ {
1491
+ "name": "sfdc_usid",
1492
+ "in": "header",
1493
+ "required": false,
1494
+ "style": "simple",
1495
+ "explode": false,
1496
+ "schema": {
1497
+ "type": "string",
1498
+ "format": "uuid"
1499
+ }
1500
+ },
1501
+ {
1502
+ "name": "sfdc_dw_dnt",
1503
+ "in": "header",
1504
+ "required": false,
1505
+ "style": "simple",
1506
+ "explode": false,
1507
+ "schema": {
1508
+ "type": "string",
1509
+ "enum": [
1510
+ "0",
1511
+ "1"
1512
+ ]
1513
+ }
1514
+ },
1515
+ {
1516
+ "name": "sfdc_shopper_context",
1517
+ "in": "header",
1518
+ "required": false,
1519
+ "style": "simple",
1520
+ "explode": false,
1521
+ "schema": {
1522
+ "type": "string"
1523
+ }
1524
+ }
1525
+ ],
1526
+ "requestBody": {
1527
+ "content": {
1528
+ "application/json": {
1529
+ "schema": {
1530
+ "$ref": "#/components/schemas/OrderPaymentInstrumentRequest"
1531
+ }
1532
+ }
1533
+ }
1534
+ },
1535
+ "responses": {
1536
+ "200": {
1537
+ "description": "Success, the response body contains the order with the updated payment instrument. When Salesforce Payments is enabled, the paymentReference object will be included in the paymentInstruments.",
1538
+ "content": {
1539
+ "application/json": {
1540
+ "schema": {
1541
+ "$ref": "#/components/schemas/Order"
1542
+ }
1543
+ }
1544
+ }
1545
+ },
1546
+ "400": {
1547
+ "description": "Possible reasons:\n- the basket payment instrument with the given\nID already is permanently masked.\n- the provided payment method is invalid or not applicable.",
1548
+ "content": {
1549
+ "application/problem+json": {
1550
+ "schema": {
1551
+ "$ref": "#/components/schemas/ErrorResponse"
1552
+ }
1553
+ }
1554
+ }
1555
+ },
1556
+ "404": {
1557
+ "description": "Possible reasons:\n- The order with the given order number is unknown.\n- The payment instrument with the given payment\ninstrument ID is unknown.",
1558
+ "content": {
1559
+ "application/problem+json": {
1560
+ "schema": {
1561
+ "$ref": "#/components/schemas/ErrorResponse"
1562
+ }
1563
+ }
1564
+ }
1565
+ }
1566
+ },
1567
+ "security": [
1568
+ {
1569
+ "ShopperToken": [
1570
+ "sfcc.shopper-baskets-orders.rw",
1571
+ "sfcc.shopper-standard"
1572
+ ]
1573
+ },
1574
+ {
1575
+ "ShopperClientContextToken": [
1576
+ "sfcc.shopper-baskets-orders.rw",
1577
+ "sfcc.shopper-standard"
1578
+ ]
1579
+ }
1580
+ ]
1581
+ }
1582
+ },
1583
+ "/organizations/{organizationId}/orders/{orderNo}/payment-methods": {
1584
+ "get": {
1585
+ "operationId": "getPaymentMethodsForOrder",
1586
+ "parameters": [
1587
+ {
1588
+ "name": "organizationId",
1589
+ "in": "path",
1590
+ "required": true,
1591
+ "style": "simple",
1592
+ "explode": false,
1593
+ "schema": {
1594
+ "$ref": "#/components/schemas/OrganizationId"
1595
+ }
1596
+ },
1597
+ {
1598
+ "name": "orderNo",
1599
+ "in": "path",
1600
+ "required": true,
1601
+ "style": "simple",
1602
+ "explode": false,
1603
+ "schema": {
1604
+ "$ref": "#/components/schemas/OrderNo"
1605
+ }
1606
+ },
1607
+ {
1608
+ "name": "siteId",
1609
+ "in": "query",
1610
+ "required": true,
1611
+ "style": "form",
1612
+ "explode": true,
1613
+ "schema": {
1614
+ "$ref": "#/components/schemas/SiteId"
1615
+ }
1616
+ },
1617
+ {
1618
+ "name": "locale",
1619
+ "in": "query",
1620
+ "required": false,
1621
+ "style": "form",
1622
+ "explode": true,
1623
+ "schema": {
1624
+ "$ref": "#/components/schemas/LocaleCode"
1625
+ }
1626
+ },
1627
+ {
1628
+ "name": "sfdc_usid",
1629
+ "in": "header",
1630
+ "required": false,
1631
+ "style": "simple",
1632
+ "explode": false,
1633
+ "schema": {
1634
+ "type": "string",
1635
+ "format": "uuid"
1636
+ }
1637
+ },
1638
+ {
1639
+ "name": "sfdc_dw_dnt",
1640
+ "in": "header",
1641
+ "required": false,
1642
+ "style": "simple",
1643
+ "explode": false,
1644
+ "schema": {
1645
+ "type": "string",
1646
+ "enum": [
1647
+ "0",
1648
+ "1"
1649
+ ]
1650
+ }
1651
+ },
1652
+ {
1653
+ "name": "personalized",
1654
+ "in": "query",
1655
+ "required": false,
1656
+ "style": "form",
1657
+ "explode": true,
1658
+ "schema": {
1659
+ "type": "string",
1660
+ "enum": [
1661
+ "none"
1662
+ ]
1663
+ }
1664
+ },
1665
+ {
1666
+ "name": "sfdc_shopper_context",
1667
+ "in": "header",
1668
+ "required": false,
1669
+ "style": "simple",
1670
+ "explode": false,
1671
+ "schema": {
1672
+ "type": "string"
1673
+ }
1674
+ }
1675
+ ],
1676
+ "responses": {
1677
+ "200": {
1678
+ "description": "Success, the response body contains the applicable payment methods for the order.",
1679
+ "content": {
1680
+ "application/json": {
1681
+ "schema": {
1682
+ "$ref": "#/components/schemas/PaymentMethodResult"
1683
+ }
1684
+ }
1685
+ }
1686
+ },
1687
+ "400": {
1688
+ "description": "The customer assigned to the order does not\nmatch the verified customer represented by the JSON Web Token (JWT).",
1689
+ "content": {
1690
+ "application/problem+json": {
1691
+ "schema": {
1692
+ "$ref": "#/components/schemas/ErrorResponse"
1693
+ }
1694
+ }
1695
+ }
1696
+ },
1697
+ "404": {
1698
+ "description": "The order with the given order number is unknown.",
1699
+ "content": {
1700
+ "application/problem+json": {
1701
+ "schema": {
1702
+ "$ref": "#/components/schemas/ErrorResponse"
1703
+ }
1704
+ }
1705
+ }
1706
+ }
1707
+ },
1708
+ "security": [
1709
+ {
1710
+ "ShopperToken": [
1711
+ "sfcc.shopper-baskets-orders",
1712
+ "sfcc.shopper-baskets-orders.rw",
1713
+ "sfcc.shopper-standard"
1714
+ ]
1715
+ },
1716
+ {
1717
+ "ShopperClientContextToken": [
1718
+ "sfcc.shopper-baskets-orders",
1719
+ "sfcc.shopper-baskets-orders.rw",
1720
+ "sfcc.shopper-standard"
1721
+ ]
1722
+ }
1723
+ ]
1724
+ }
1725
+ },
1726
+ "/organizations/{organizationId}/orders/{orderNo}/taxes": {
1727
+ "get": {
1728
+ "operationId": "getTaxesFromOrder",
1729
+ "parameters": [
1730
+ {
1731
+ "name": "organizationId",
1732
+ "in": "path",
1733
+ "required": true,
1734
+ "style": "simple",
1735
+ "explode": false,
1736
+ "schema": {
1737
+ "$ref": "#/components/schemas/OrganizationId"
1738
+ }
1739
+ },
1740
+ {
1741
+ "name": "orderNo",
1742
+ "in": "path",
1743
+ "required": true,
1744
+ "style": "simple",
1745
+ "explode": false,
1746
+ "schema": {
1747
+ "$ref": "#/components/schemas/OrderNo"
1748
+ }
1749
+ },
1750
+ {
1751
+ "name": "siteId",
1752
+ "in": "query",
1753
+ "required": true,
1754
+ "style": "form",
1755
+ "explode": true,
1756
+ "schema": {
1757
+ "$ref": "#/components/schemas/SiteId"
1758
+ }
1759
+ },
1760
+ {
1761
+ "name": "personalized",
1762
+ "in": "query",
1763
+ "required": false,
1764
+ "style": "form",
1765
+ "explode": true,
1766
+ "schema": {
1767
+ "type": "string",
1768
+ "enum": [
1769
+ "none"
1770
+ ]
1771
+ }
1772
+ },
1773
+ {
1774
+ "name": "sfdc_shopper_context",
1775
+ "in": "header",
1776
+ "required": false,
1777
+ "style": "simple",
1778
+ "explode": false,
1779
+ "schema": {
1780
+ "type": "string"
1781
+ }
1782
+ }
1783
+ ],
1784
+ "responses": {
1785
+ "200": {
1786
+ "description": "Success, the response body contains the external taxation from all items from the referenced\norder.",
1787
+ "content": {
1788
+ "application/json": {
1789
+ "schema": {
1790
+ "$ref": "#/components/schemas/Taxes"
1791
+ }
1792
+ }
1793
+ }
1794
+ },
1795
+ "404": {
1796
+ "description": "The order with the given order number is unknown.",
1797
+ "content": {
1798
+ "application/problem+json": {
1799
+ "schema": {
1800
+ "$ref": "#/components/schemas/ErrorResponse"
1801
+ }
1802
+ }
1803
+ }
1804
+ },
1805
+ "409": {
1806
+ "description": "Possible Reasons: \n - The tax mode of the referenced basket is not set to EXTERNAL.",
1807
+ "content": {
1808
+ "application/problem+json": {
1809
+ "schema": {
1810
+ "$ref": "#/components/schemas/ErrorResponse"
1811
+ }
1812
+ }
1813
+ }
1814
+ }
1815
+ },
1816
+ "security": [
1817
+ {
1818
+ "AmOAuth2": [
1819
+ "sfcc.shopper-baskets-orders",
1820
+ "sfcc.shopper-baskets-orders.rw"
1821
+ ]
1822
+ }
1823
+ ]
1824
+ }
1825
+ }
1826
+ },
1827
+ "components": {
1828
+ "schemas": {
1829
+ "OrganizationId": {
1830
+ "type": "string",
1831
+ "pattern": "^f_ecom_[a-z]{4}_(prd|stg|dev|s[0-9]{2}|[0-9]{3})$"
1832
+ },
1833
+ "SiteId": {
1834
+ "type": "string",
1835
+ "maxLength": 32,
1836
+ "minLength": 1
1837
+ },
1838
+ "LanguageCountry": {
1839
+ "type": "string",
1840
+ "pattern": "^[a-z][a-z]-[A-Z][A-Z]$"
1841
+ },
1842
+ "LanguageCode": {
1843
+ "type": "string",
1844
+ "pattern": "^[a-z][a-z]$"
1845
+ },
1846
+ "DefaultFallback": {
1847
+ "type": "string",
1848
+ "default": "default",
1849
+ "pattern": "^default$"
1850
+ },
1851
+ "LocaleCode": {
1852
+ "oneOf": [
1853
+ {
1854
+ "$ref": "#/components/schemas/LanguageCountry"
1855
+ },
1856
+ {
1857
+ "$ref": "#/components/schemas/LanguageCode"
1858
+ },
1859
+ {
1860
+ "$ref": "#/components/schemas/DefaultFallback"
1861
+ }
1862
+ ]
1863
+ },
1864
+ "CountryCode": {
1865
+ "type": "string",
1866
+ "pattern": "^[A-Z][A-Z]$"
1867
+ },
1868
+ "OrderAddress": {
1869
+ "type": "object",
1870
+ "additionalProperties": {},
1871
+ "properties": {
1872
+ "address1": {
1873
+ "type": "string"
1874
+ },
1875
+ "address2": {
1876
+ "type": "string"
1877
+ },
1878
+ "city": {
1879
+ "type": "string"
1880
+ },
1881
+ "companyName": {
1882
+ "type": "string"
1883
+ },
1884
+ "countryCode": {
1885
+ "$ref": "#/components/schemas/CountryCode"
1886
+ },
1887
+ "firstName": {
1888
+ "type": "string"
1889
+ },
1890
+ "fullName": {
1891
+ "type": "string"
1892
+ },
1893
+ "id": {
1894
+ "type": "string"
1895
+ },
1896
+ "jobTitle": {
1897
+ "type": "string"
1898
+ },
1899
+ "lastName": {
1900
+ "type": "string"
1901
+ },
1902
+ "phone": {
1903
+ "type": "string"
1904
+ },
1905
+ "postBox": {
1906
+ "type": "string"
1907
+ },
1908
+ "postalCode": {
1909
+ "type": "string"
1910
+ },
1911
+ "salutation": {
1912
+ "type": "string"
1913
+ },
1914
+ "secondName": {
1915
+ "type": "string"
1916
+ },
1917
+ "stateCode": {
1918
+ "type": "string"
1919
+ },
1920
+ "suffix": {
1921
+ "type": "string"
1922
+ },
1923
+ "suite": {
1924
+ "type": "string"
1925
+ },
1926
+ "title": {
1927
+ "type": "string"
1928
+ }
1929
+ }
1930
+ },
1931
+ "ProductId": {
1932
+ "type": "string",
1933
+ "maxLength": 100,
1934
+ "minLength": 1
1935
+ },
1936
+ "ProductDetailsLink": {
1937
+ "type": "object",
1938
+ "additionalProperties": false,
1939
+ "properties": {
1940
+ "productDescription": {
1941
+ "type": "string"
1942
+ },
1943
+ "productId": {
1944
+ "$ref": "#/components/schemas/ProductId"
1945
+ },
1946
+ "productName": {
1947
+ "type": "string"
1948
+ },
1949
+ "title": {
1950
+ "type": "string"
1951
+ }
1952
+ },
1953
+ "required": [
1954
+ "productId"
1955
+ ]
1956
+ },
1957
+ "BonusDiscountLineItem": {
1958
+ "type": "object",
1959
+ "additionalProperties": {},
1960
+ "properties": {
1961
+ "bonusProducts": {
1962
+ "type": "array",
1963
+ "items": {
1964
+ "$ref": "#/components/schemas/ProductDetailsLink"
1965
+ }
1966
+ },
1967
+ "couponCode": {
1968
+ "type": "string"
1969
+ },
1970
+ "id": {
1971
+ "type": "string"
1972
+ },
1973
+ "maxBonusItems": {
1974
+ "type": "integer",
1975
+ "format": "int32"
1976
+ },
1977
+ "promotionId": {
1978
+ "type": "string"
1979
+ }
1980
+ }
1981
+ },
1982
+ "CouponItemId": {
1983
+ "type": "string",
1984
+ "minLength": 1
1985
+ },
1986
+ "CouponItem": {
1987
+ "type": "object",
1988
+ "additionalProperties": {},
1989
+ "properties": {
1990
+ "code": {
1991
+ "type": "string",
1992
+ "maxLength": 256
1993
+ },
1994
+ "couponItemId": {
1995
+ "allOf": [
1996
+ {
1997
+ "$ref": "#/components/schemas/CouponItemId"
1998
+ }
1999
+ ]
2000
+ },
2001
+ "statusCode": {
2002
+ "type": "string",
2003
+ "enum": [
2004
+ "coupon_code_already_in_basket",
2005
+ "coupon_code_already_redeemed",
2006
+ "coupon_code_unknown",
2007
+ "coupon_disabled",
2008
+ "redemption_limit_exceeded",
2009
+ "customer_redemption_limit_exceeded",
2010
+ "timeframe_redemption_limit_exceeded",
2011
+ "no_active_promotion",
2012
+ "coupon_already_in_basket",
2013
+ "no_applicable_promotion",
2014
+ "applied",
2015
+ "adhoc"
2016
+ ]
2017
+ },
2018
+ "valid": {
2019
+ "type": "boolean"
2020
+ }
2021
+ },
2022
+ "required": [
2023
+ "code"
2024
+ ]
2025
+ },
2026
+ "CurrencyCode": {
2027
+ "type": "string",
2028
+ "pattern": "^([A-Z][A-Z][A-Z]|N/A)$"
2029
+ },
2030
+ "CustomerInfo": {
2031
+ "type": "object",
2032
+ "additionalProperties": {},
2033
+ "properties": {
2034
+ "customerId": {
2035
+ "type": "string",
2036
+ "maxLength": 100
2037
+ },
2038
+ "customerName": {
2039
+ "type": "string"
2040
+ },
2041
+ "customerNo": {
2042
+ "type": "string",
2043
+ "maxLength": 100
2044
+ },
2045
+ "email": {
2046
+ "type": "string"
2047
+ }
2048
+ },
2049
+ "required": [
2050
+ "email"
2051
+ ]
2052
+ },
2053
+ "GiftCertificateItemId": {
2054
+ "type": "string",
2055
+ "minLength": 1
2056
+ },
2057
+ "GiftCertificateItem": {
2058
+ "type": "object",
2059
+ "additionalProperties": {},
2060
+ "properties": {
2061
+ "amount": {
2062
+ "type": "number",
2063
+ "format": "double"
2064
+ },
2065
+ "giftCertificateItemId": {
2066
+ "allOf": [
2067
+ {
2068
+ "$ref": "#/components/schemas/GiftCertificateItemId"
2069
+ }
2070
+ ]
2071
+ },
2072
+ "message": {
2073
+ "type": "string",
2074
+ "maxLength": 4000
2075
+ },
2076
+ "recipientEmail": {
2077
+ "type": "string",
2078
+ "minLength": 1
2079
+ },
2080
+ "recipientName": {
2081
+ "type": "string"
2082
+ },
2083
+ "senderName": {
2084
+ "type": "string"
2085
+ },
2086
+ "shipmentId": {
2087
+ "type": "string"
2088
+ }
2089
+ },
2090
+ "required": [
2091
+ "amount",
2092
+ "recipientEmail"
2093
+ ]
2094
+ },
2095
+ "GroupedTaxItem": {
2096
+ "type": "object",
2097
+ "additionalProperties": false,
2098
+ "properties": {
2099
+ "taxRate": {
2100
+ "type": "number",
2101
+ "format": "double"
2102
+ },
2103
+ "taxValue": {
2104
+ "type": "number",
2105
+ "format": "double"
2106
+ }
2107
+ }
2108
+ },
2109
+ "Discount": {
2110
+ "type": "object",
2111
+ "additionalProperties": {},
2112
+ "properties": {
2113
+ "amount": {
2114
+ "type": "number",
2115
+ "format": "double"
2116
+ },
2117
+ "percentage": {
2118
+ "type": "number",
2119
+ "format": "double"
2120
+ },
2121
+ "priceBookId": {
2122
+ "type": "string"
2123
+ },
2124
+ "type": {
2125
+ "type": "string",
2126
+ "enum": [
2127
+ "percentage",
2128
+ "fixed_price",
2129
+ "amount",
2130
+ "free",
2131
+ "price_book_price",
2132
+ "bonus",
2133
+ "total_fixed_price",
2134
+ "bonus_choice",
2135
+ "percentage_off_options"
2136
+ ]
2137
+ }
2138
+ },
2139
+ "required": [
2140
+ "type"
2141
+ ]
2142
+ },
2143
+ "PriceAdjustmentId": {
2144
+ "type": "string"
2145
+ },
2146
+ "PriceAdjustment": {
2147
+ "type": "object",
2148
+ "additionalProperties": {},
2149
+ "properties": {
2150
+ "appliedDiscount": {
2151
+ "allOf": [
2152
+ {
2153
+ "$ref": "#/components/schemas/Discount"
2154
+ }
2155
+ ]
2156
+ },
2157
+ "couponCode": {
2158
+ "type": "string"
2159
+ },
2160
+ "createdBy": {
2161
+ "type": "string"
2162
+ },
2163
+ "creationDate": {
2164
+ "type": "string",
2165
+ "format": "date-time"
2166
+ },
2167
+ "custom": {
2168
+ "type": "boolean"
2169
+ },
2170
+ "itemText": {
2171
+ "type": "string"
2172
+ },
2173
+ "lastModified": {
2174
+ "type": "string",
2175
+ "format": "date-time"
2176
+ },
2177
+ "manual": {
2178
+ "type": "boolean"
2179
+ },
2180
+ "price": {
2181
+ "type": "number",
2182
+ "format": "double"
2183
+ },
2184
+ "priceAdjustmentId": {
2185
+ "allOf": [
2186
+ {
2187
+ "$ref": "#/components/schemas/PriceAdjustmentId"
2188
+ }
2189
+ ]
2190
+ },
2191
+ "promotionId": {
2192
+ "type": "string"
2193
+ },
2194
+ "reasonCode": {
2195
+ "type": "string"
2196
+ }
2197
+ }
2198
+ },
2199
+ "Status": {
2200
+ "type": "object",
2201
+ "additionalProperties": false,
2202
+ "properties": {
2203
+ "code": {
2204
+ "type": "string"
2205
+ },
2206
+ "message": {
2207
+ "type": "string"
2208
+ },
2209
+ "status": {
2210
+ "type": "integer",
2211
+ "format": "int32"
2212
+ }
2213
+ }
2214
+ },
2215
+ "PaymentCard": {
2216
+ "type": "object",
2217
+ "additionalProperties": false,
2218
+ "properties": {
2219
+ "cardType": {
2220
+ "type": "string",
2221
+ "maxLength": 256
2222
+ },
2223
+ "creditCardExpired": {
2224
+ "type": "boolean"
2225
+ },
2226
+ "creditCardToken": {
2227
+ "type": "string"
2228
+ },
2229
+ "expirationMonth": {
2230
+ "type": "integer",
2231
+ "format": "int32"
2232
+ },
2233
+ "expirationYear": {
2234
+ "type": "integer",
2235
+ "format": "int32"
2236
+ },
2237
+ "holder": {
2238
+ "type": "string",
2239
+ "maxLength": 256
2240
+ },
2241
+ "issueNumber": {
2242
+ "type": "string",
2243
+ "maxLength": 256
2244
+ },
2245
+ "maskedNumber": {
2246
+ "type": "string",
2247
+ "maxLength": 4000
2248
+ },
2249
+ "numberLastDigits": {
2250
+ "type": "string",
2251
+ "maxLength": 4000
2252
+ },
2253
+ "validFromMonth": {
2254
+ "type": "integer",
2255
+ "format": "int32",
2256
+ "maximum": 12,
2257
+ "minimum": 1
2258
+ },
2259
+ "validFromYear": {
2260
+ "type": "integer",
2261
+ "format": "int32"
2262
+ }
2263
+ }
2264
+ },
2265
+ "GiftCardResponse": {
2266
+ "type": "object",
2267
+ "additionalProperties": false,
2268
+ "properties": {
2269
+ "brand": {
2270
+ "type": "string",
2271
+ "maxLength": 256
2272
+ },
2273
+ "maskedCardNumber": {
2274
+ "type": "string",
2275
+ "maxLength": 40
2276
+ },
2277
+ "expirationMonth": {
2278
+ "type": "integer",
2279
+ "format": "int32"
2280
+ },
2281
+ "expirationYear": {
2282
+ "type": "integer",
2283
+ "format": "int32"
2284
+ }
2285
+ }
2286
+ },
2287
+ "PaymentInstrumentId": {
2288
+ "type": "string"
2289
+ },
2290
+ "OrderPaymentInstrument": {
2291
+ "type": "object",
2292
+ "properties": {
2293
+ "amount": {
2294
+ "type": "number",
2295
+ "format": "double"
2296
+ },
2297
+ "authorizationStatus": {
2298
+ "allOf": [
2299
+ {
2300
+ "$ref": "#/components/schemas/Status"
2301
+ }
2302
+ ]
2303
+ },
2304
+ "bankRoutingNumber": {
2305
+ "type": "string",
2306
+ "maxLength": 256
2307
+ },
2308
+ "maskedGiftCertificateCode": {
2309
+ "type": "string"
2310
+ },
2311
+ "paymentCard": {
2312
+ "allOf": [
2313
+ {
2314
+ "$ref": "#/components/schemas/PaymentCard"
2315
+ }
2316
+ ]
2317
+ },
2318
+ "giftCard": {
2319
+ "allOf": [
2320
+ {
2321
+ "$ref": "#/components/schemas/GiftCardResponse"
2322
+ }
2323
+ ]
2324
+ },
2325
+ "paymentInstrumentId": {
2326
+ "allOf": [
2327
+ {
2328
+ "$ref": "#/components/schemas/PaymentInstrumentId"
2329
+ }
2330
+ ]
2331
+ },
2332
+ "paymentMethodId": {
2333
+ "type": "string",
2334
+ "maxLength": 256
2335
+ },
2336
+ "paymentReference": {
2337
+ "type": "object",
2338
+ "properties": {
2339
+ "paymentReferenceId": {
2340
+ "type": "string",
2341
+ "maxLength": 256
2342
+ },
2343
+ "gateway": {
2344
+ "type": "string",
2345
+ "enum": [
2346
+ "stripe",
2347
+ "paypal",
2348
+ "adyen"
2349
+ ]
2350
+ },
2351
+ "gatewayProperties": {
2352
+ "type": "object",
2353
+ "additionalProperties": false,
2354
+ "properties": {
2355
+ "stripe": {
2356
+ "type": "object",
2357
+ "additionalProperties": true
2358
+ },
2359
+ "paypal": {
2360
+ "type": "object",
2361
+ "additionalProperties": true
2362
+ },
2363
+ "adyen": {
2364
+ "type": "object",
2365
+ "additionalProperties": true
2366
+ }
2367
+ }
2368
+ }
2369
+ }
2370
+ }
2371
+ }
2372
+ },
2373
+ "ProductItem": {
2374
+ "type": "object",
2375
+ "additionalProperties": {},
2376
+ "properties": {
2377
+ "adjustedTax": {
2378
+ "type": "number",
2379
+ "format": "double"
2380
+ },
2381
+ "basePrice": {
2382
+ "type": "number",
2383
+ "format": "double"
2384
+ },
2385
+ "bonusDiscountLineItemId": {
2386
+ "type": "string"
2387
+ },
2388
+ "bonusProductLineItem": {
2389
+ "type": "boolean"
2390
+ },
2391
+ "bundledProductItems": {
2392
+ "type": "array",
2393
+ "items": {
2394
+ "$ref": "#/components/schemas/ProductItem"
2395
+ }
2396
+ },
2397
+ "gift": {
2398
+ "type": "boolean"
2399
+ },
2400
+ "giftMessage": {
2401
+ "type": "string"
2402
+ },
2403
+ "inventoryId": {
2404
+ "type": "string",
2405
+ "maxLength": 256
2406
+ },
2407
+ "itemId": {
2408
+ "allOf": [
2409
+ {
2410
+ "$ref": "#/components/schemas/ItemId"
2411
+ }
2412
+ ]
2413
+ },
2414
+ "itemText": {
2415
+ "type": "string"
2416
+ },
2417
+ "optionItems": {
2418
+ "type": "array",
2419
+ "items": {
2420
+ "$ref": "#/components/schemas/OptionItem"
2421
+ }
2422
+ },
2423
+ "price": {
2424
+ "type": "number",
2425
+ "format": "double"
2426
+ },
2427
+ "priceAdjustments": {
2428
+ "type": "array",
2429
+ "items": {
2430
+ "$ref": "#/components/schemas/PriceAdjustment"
2431
+ }
2432
+ },
2433
+ "priceAfterItemDiscount": {
2434
+ "type": "number",
2435
+ "format": "double"
2436
+ },
2437
+ "priceAfterOrderDiscount": {
2438
+ "type": "number",
2439
+ "format": "double"
2440
+ },
2441
+ "productId": {
2442
+ "type": "string",
2443
+ "maxLength": 100
2444
+ },
2445
+ "productListItem": {
2446
+ "allOf": [
2447
+ {
2448
+ "$ref": "#/components/schemas/ProductListItemReference"
2449
+ }
2450
+ ]
2451
+ },
2452
+ "productName": {
2453
+ "type": "string"
2454
+ },
2455
+ "qualifyingProductItemId": {
2456
+ "type": "string",
2457
+ "maxLength": 28
2458
+ },
2459
+ "quantity": {
2460
+ "type": "number",
2461
+ "format": "double",
2462
+ "minimum": 0
2463
+ },
2464
+ "shipmentId": {
2465
+ "type": "string"
2466
+ },
2467
+ "shippingItemId": {
2468
+ "type": "string"
2469
+ },
2470
+ "tax": {
2471
+ "type": "number",
2472
+ "format": "double"
2473
+ },
2474
+ "taxBasis": {
2475
+ "type": "number",
2476
+ "format": "double"
2477
+ },
2478
+ "taxClassId": {
2479
+ "type": "string"
2480
+ },
2481
+ "taxItems": {
2482
+ "type": "array",
2483
+ "items": {
2484
+ "$ref": "#/components/schemas/TaxItem"
2485
+ },
2486
+ "maxItems": 10
2487
+ },
2488
+ "taxRate": {
2489
+ "type": "number",
2490
+ "format": "double"
2491
+ }
2492
+ }
2493
+ },
2494
+ "ItemId": {
2495
+ "type": "string"
2496
+ },
2497
+ "OptionItem": {
2498
+ "type": "object",
2499
+ "additionalProperties": {},
2500
+ "properties": {
2501
+ "adjustedTax": {
2502
+ "type": "number",
2503
+ "format": "double"
2504
+ },
2505
+ "basePrice": {
2506
+ "type": "number",
2507
+ "format": "double"
2508
+ },
2509
+ "bonusDiscountLineItemId": {
2510
+ "type": "string"
2511
+ },
2512
+ "bonusProductLineItem": {
2513
+ "type": "boolean"
2514
+ },
2515
+ "bundledProductItems": {
2516
+ "type": "array",
2517
+ "items": {
2518
+ "$ref": "#/components/schemas/ProductItem"
2519
+ }
2520
+ },
2521
+ "gift": {
2522
+ "type": "boolean"
2523
+ },
2524
+ "giftMessage": {
2525
+ "type": "string"
2526
+ },
2527
+ "inventoryId": {
2528
+ "type": "string",
2529
+ "maxLength": 256
2530
+ },
2531
+ "itemId": {
2532
+ "allOf": [
2533
+ {
2534
+ "$ref": "#/components/schemas/ItemId"
2535
+ }
2536
+ ]
2537
+ },
2538
+ "itemText": {
2539
+ "type": "string"
2540
+ },
2541
+ "optionId": {
2542
+ "type": "string",
2543
+ "maxLength": 256
2544
+ },
2545
+ "optionItems": {
2546
+ "type": "array",
2547
+ "items": {
2548
+ "$ref": "#/components/schemas/OptionItem"
2549
+ }
2550
+ },
2551
+ "optionValueId": {
2552
+ "type": "string",
2553
+ "maxLength": 256
2554
+ },
2555
+ "price": {
2556
+ "type": "number",
2557
+ "format": "double"
2558
+ },
2559
+ "priceAdjustments": {
2560
+ "type": "array",
2561
+ "items": {
2562
+ "$ref": "#/components/schemas/PriceAdjustment"
2563
+ }
2564
+ },
2565
+ "priceAfterItemDiscount": {
2566
+ "type": "number",
2567
+ "format": "double"
2568
+ },
2569
+ "priceAfterOrderDiscount": {
2570
+ "type": "number",
2571
+ "format": "double"
2572
+ },
2573
+ "productId": {
2574
+ "$ref": "#/components/schemas/ProductId"
2575
+ },
2576
+ "productListItem": {
2577
+ "allOf": [
2578
+ {
2579
+ "$ref": "#/components/schemas/ProductListItemReference"
2580
+ }
2581
+ ]
2582
+ },
2583
+ "productName": {
2584
+ "type": "string"
2585
+ },
2586
+ "quantity": {
2587
+ "type": "number",
2588
+ "format": "double",
2589
+ "minimum": 0
2590
+ },
2591
+ "shipmentId": {
2592
+ "type": "string"
2593
+ },
2594
+ "shippingItemId": {
2595
+ "type": "string"
2596
+ },
2597
+ "tax": {
2598
+ "type": "number",
2599
+ "format": "double"
2600
+ },
2601
+ "taxBasis": {
2602
+ "type": "number",
2603
+ "format": "double"
2604
+ },
2605
+ "taxClassId": {
2606
+ "type": "string"
2607
+ },
2608
+ "taxRate": {
2609
+ "type": "number",
2610
+ "format": "double"
2611
+ }
2612
+ },
2613
+ "required": [
2614
+ "optionId",
2615
+ "optionValueId"
2616
+ ]
2617
+ },
2618
+ "ProductListLink": {
2619
+ "type": "object",
2620
+ "additionalProperties": false,
2621
+ "properties": {
2622
+ "description": {
2623
+ "type": "string"
2624
+ },
2625
+ "name": {
2626
+ "type": "string"
2627
+ },
2628
+ "public": {
2629
+ "type": "boolean"
2630
+ },
2631
+ "title": {
2632
+ "type": "string"
2633
+ },
2634
+ "type": {
2635
+ "type": "string",
2636
+ "enum": [
2637
+ "wish_list",
2638
+ "gift_registry",
2639
+ "shopping_list",
2640
+ "custom_1",
2641
+ "custom_2",
2642
+ "custom_3"
2643
+ ]
2644
+ }
2645
+ }
2646
+ },
2647
+ "ProductListItemReference": {
2648
+ "type": "object",
2649
+ "additionalProperties": false,
2650
+ "properties": {
2651
+ "id": {
2652
+ "allOf": [
2653
+ {
2654
+ "$ref": "#/components/schemas/ItemId"
2655
+ }
2656
+ ]
2657
+ },
2658
+ "priority": {
2659
+ "type": "integer",
2660
+ "format": "int32"
2661
+ },
2662
+ "productDetailsLink": {
2663
+ "$ref": "#/components/schemas/ProductDetailsLink"
2664
+ },
2665
+ "productList": {
2666
+ "allOf": [
2667
+ {
2668
+ "$ref": "#/components/schemas/ProductListLink"
2669
+ }
2670
+ ]
2671
+ },
2672
+ "public": {
2673
+ "type": "boolean"
2674
+ },
2675
+ "purchasedQuantity": {
2676
+ "type": "number",
2677
+ "format": "double"
2678
+ },
2679
+ "quantity": {
2680
+ "type": "number",
2681
+ "format": "double",
2682
+ "minimum": 0
2683
+ },
2684
+ "type": {
2685
+ "type": "string",
2686
+ "enum": [
2687
+ "product",
2688
+ "gift_certificate"
2689
+ ]
2690
+ }
2691
+ },
2692
+ "required": [
2693
+ "id"
2694
+ ]
2695
+ },
2696
+ "TaxItem": {
2697
+ "type": "object",
2698
+ "additionalProperties": {},
2699
+ "properties": {
2700
+ "id": {
2701
+ "type": "string"
2702
+ },
2703
+ "rate": {
2704
+ "type": "number",
2705
+ "format": "double"
2706
+ },
2707
+ "value": {
2708
+ "type": "number",
2709
+ "format": "double"
2710
+ }
2711
+ },
2712
+ "required": [
2713
+ "id",
2714
+ "rate"
2715
+ ]
2716
+ },
2717
+ "BasketProductItem": {
2718
+ "allOf": [
2719
+ {
2720
+ "$ref": "#/components/schemas/ProductItem"
2721
+ }
2722
+ ]
2723
+ },
2724
+ "DeliveryWindow": {
2725
+ "type": "object",
2726
+ "properties": {
2727
+ "startAt": {
2728
+ "type": "string",
2729
+ "format": "date-time"
2730
+ },
2731
+ "endAt": {
2732
+ "type": "string",
2733
+ "format": "date-time"
2734
+ }
2735
+ }
2736
+ },
2737
+ "ShipmentId": {
2738
+ "type": "string",
2739
+ "minLength": 1
2740
+ },
2741
+ "ShippingPromotion": {
2742
+ "type": "object",
2743
+ "additionalProperties": {},
2744
+ "properties": {
2745
+ "calloutMsg": {
2746
+ "type": "string"
2747
+ },
2748
+ "promotionId": {
2749
+ "type": "string"
2750
+ },
2751
+ "promotionName": {
2752
+ "type": "string"
2753
+ }
2754
+ }
2755
+ },
2756
+ "ShippingMethod": {
2757
+ "type": "object",
2758
+ "additionalProperties": {},
2759
+ "properties": {
2760
+ "deliveryWindow": {
2761
+ "allOf": [
2762
+ {
2763
+ "$ref": "#/components/schemas/DeliveryWindow"
2764
+ }
2765
+ ]
2766
+ },
2767
+ "description": {
2768
+ "type": "string"
2769
+ },
2770
+ "externalShippingMethod": {
2771
+ "type": "string"
2772
+ },
2773
+ "id": {
2774
+ "type": "string",
2775
+ "maxLength": 256
2776
+ },
2777
+ "name": {
2778
+ "type": "string"
2779
+ },
2780
+ "orderCutoffAt": {
2781
+ "type": "string",
2782
+ "format": "date-time"
2783
+ },
2784
+ "price": {
2785
+ "type": "number",
2786
+ "format": "double"
2787
+ },
2788
+ "shippingPromotions": {
2789
+ "type": "array",
2790
+ "items": {
2791
+ "$ref": "#/components/schemas/ShippingPromotion"
2792
+ }
2793
+ }
2794
+ },
2795
+ "required": [
2796
+ "id"
2797
+ ]
2798
+ },
2799
+ "Shipment": {
2800
+ "type": "object",
2801
+ "additionalProperties": {},
2802
+ "properties": {
2803
+ "adjustedMerchandizeTotalTax": {
2804
+ "type": "number",
2805
+ "format": "double"
2806
+ },
2807
+ "adjustedShippingTotalTax": {
2808
+ "type": "number",
2809
+ "format": "double"
2810
+ },
2811
+ "deliveryWindow": {
2812
+ "allOf": [
2813
+ {
2814
+ "$ref": "#/components/schemas/DeliveryWindow"
2815
+ }
2816
+ ]
2817
+ },
2818
+ "gift": {
2819
+ "type": "boolean"
2820
+ },
2821
+ "giftMessage": {
2822
+ "type": "string"
2823
+ },
2824
+ "merchandizeTotalTax": {
2825
+ "type": "number",
2826
+ "format": "double"
2827
+ },
2828
+ "orderCutoffAt": {
2829
+ "type": "string",
2830
+ "format": "date-time"
2831
+ },
2832
+ "productSubTotal": {
2833
+ "type": "number",
2834
+ "format": "double"
2835
+ },
2836
+ "productTotal": {
2837
+ "type": "number",
2838
+ "format": "double"
2839
+ },
2840
+ "shipmentId": {
2841
+ "allOf": [
2842
+ {
2843
+ "$ref": "#/components/schemas/ShipmentId"
2844
+ }
2845
+ ],
2846
+ "default": "me"
2847
+ },
2848
+ "shipmentNo": {
2849
+ "type": "string"
2850
+ },
2851
+ "shipmentTotal": {
2852
+ "type": "number",
2853
+ "format": "double"
2854
+ },
2855
+ "shippingAddress": {
2856
+ "allOf": [
2857
+ {
2858
+ "$ref": "#/components/schemas/OrderAddress"
2859
+ }
2860
+ ]
2861
+ },
2862
+ "shippingMethod": {
2863
+ "$ref": "#/components/schemas/ShippingMethod"
2864
+ },
2865
+ "shippingStatus": {
2866
+ "type": "string",
2867
+ "enum": [
2868
+ "not_shipped",
2869
+ "shipped"
2870
+ ]
2871
+ },
2872
+ "shippingTotal": {
2873
+ "type": "number",
2874
+ "format": "double"
2875
+ },
2876
+ "shippingTotalTax": {
2877
+ "type": "number",
2878
+ "format": "double"
2879
+ },
2880
+ "taxTotal": {
2881
+ "type": "number",
2882
+ "format": "double"
2883
+ },
2884
+ "trackingNumber": {
2885
+ "type": "string"
2886
+ }
2887
+ }
2888
+ },
2889
+ "ShippingItem": {
2890
+ "type": "object",
2891
+ "additionalProperties": {},
2892
+ "properties": {
2893
+ "adjustedTax": {
2894
+ "type": "number",
2895
+ "format": "double"
2896
+ },
2897
+ "basePrice": {
2898
+ "type": "number",
2899
+ "format": "double"
2900
+ },
2901
+ "itemId": {
2902
+ "type": "string"
2903
+ },
2904
+ "itemText": {
2905
+ "type": "string"
2906
+ },
2907
+ "price": {
2908
+ "type": "number",
2909
+ "format": "double"
2910
+ },
2911
+ "priceAdjustments": {
2912
+ "type": "array",
2913
+ "items": {
2914
+ "$ref": "#/components/schemas/PriceAdjustment"
2915
+ }
2916
+ },
2917
+ "priceAfterItemDiscount": {
2918
+ "type": "number",
2919
+ "format": "double"
2920
+ },
2921
+ "shipmentId": {
2922
+ "allOf": [
2923
+ {
2924
+ "$ref": "#/components/schemas/ShipmentId"
2925
+ }
2926
+ ]
2927
+ },
2928
+ "tax": {
2929
+ "type": "number",
2930
+ "format": "double"
2931
+ },
2932
+ "taxBasis": {
2933
+ "type": "number",
2934
+ "format": "double"
2935
+ },
2936
+ "taxClassId": {
2937
+ "type": "string"
2938
+ },
2939
+ "taxItems": {
2940
+ "type": "array",
2941
+ "items": {
2942
+ "$ref": "#/components/schemas/TaxItem"
2943
+ },
2944
+ "maxItems": 10
2945
+ },
2946
+ "taxRate": {
2947
+ "type": "number",
2948
+ "format": "double"
2949
+ }
2950
+ }
2951
+ },
2952
+ "PromotionLink": {
2953
+ "type": "object",
2954
+ "additionalProperties": {},
2955
+ "properties": {
2956
+ "promotionId": {
2957
+ "type": "string",
2958
+ "maxLength": 256,
2959
+ "minLength": 1
2960
+ },
2961
+ "name": {
2962
+ "type": "string",
2963
+ "maxLength": 256,
2964
+ "minLength": 1
2965
+ },
2966
+ "calloutMsg": {
2967
+ "type": "string",
2968
+ "maxLength": 256,
2969
+ "minLength": 1
2970
+ },
2971
+ "title": {
2972
+ "type": "string",
2973
+ "maxLength": 256,
2974
+ "minLength": 1
2975
+ },
2976
+ "link": {
2977
+ "type": "string",
2978
+ "maxLength": 2048,
2979
+ "minLength": 1
2980
+ }
2981
+ }
2982
+ },
2983
+ "ApproachingDiscount": {
2984
+ "type": "object",
2985
+ "additionalProperties": {},
2986
+ "properties": {
2987
+ "type": {
2988
+ "type": "string",
2989
+ "enum": [
2990
+ "order",
2991
+ "shipping"
2992
+ ]
2993
+ },
2994
+ "conditionThreshold": {
2995
+ "type": "number",
2996
+ "format": "double"
2997
+ },
2998
+ "merchandiseTotal": {
2999
+ "type": "number",
3000
+ "format": "double"
3001
+ },
3002
+ "discount": {
3003
+ "allOf": [
3004
+ {
3005
+ "$ref": "#/components/schemas/Discount"
3006
+ }
3007
+ ]
3008
+ },
3009
+ "promotionLink": {
3010
+ "allOf": [
3011
+ {
3012
+ "$ref": "#/components/schemas/PromotionLink"
3013
+ }
3014
+ ]
3015
+ },
3016
+ "shipmentId": {
3017
+ "type": "string",
3018
+ "maxLength": 256,
3019
+ "minLength": 1
3020
+ },
3021
+ "shippingMethods": {
3022
+ "type": "array",
3023
+ "items": {
3024
+ "$ref": "#/components/schemas/ShippingMethod"
3025
+ }
3026
+ }
3027
+ },
3028
+ "required": [
3029
+ "type"
3030
+ ]
3031
+ },
3032
+ "Basket": {
3033
+ "type": "object",
3034
+ "additionalProperties": {},
3035
+ "properties": {
3036
+ "adjustedMerchandizeTotalTax": {
3037
+ "type": "number",
3038
+ "format": "double"
3039
+ },
3040
+ "adjustedShippingTotalTax": {
3041
+ "type": "number",
3042
+ "format": "double"
3043
+ },
3044
+ "agentBasket": {
3045
+ "type": "boolean"
3046
+ },
3047
+ "basketId": {
3048
+ "type": "string"
3049
+ },
3050
+ "billingAddress": {
3051
+ "allOf": [
3052
+ {
3053
+ "$ref": "#/components/schemas/OrderAddress"
3054
+ }
3055
+ ]
3056
+ },
3057
+ "bonusDiscountLineItems": {
3058
+ "type": "array",
3059
+ "items": {
3060
+ "$ref": "#/components/schemas/BonusDiscountLineItem"
3061
+ }
3062
+ },
3063
+ "channelType": {
3064
+ "type": "string",
3065
+ "enum": [
3066
+ "storefront",
3067
+ "callcenter",
3068
+ "marketplace",
3069
+ "dss",
3070
+ "store",
3071
+ "pinterest",
3072
+ "twitter",
3073
+ "facebookads",
3074
+ "subscriptions",
3075
+ "onlinereservation",
3076
+ "customerservicecenter",
3077
+ "instagramcommerce",
3078
+ "tiktok",
3079
+ "snapchat",
3080
+ "google",
3081
+ "whatsapp",
3082
+ "youtube",
3083
+ "chatgpt",
3084
+ "gemini"
3085
+ ]
3086
+ },
3087
+ "couponItems": {
3088
+ "type": "array",
3089
+ "items": {
3090
+ "$ref": "#/components/schemas/CouponItem"
3091
+ }
3092
+ },
3093
+ "creationDate": {
3094
+ "type": "string",
3095
+ "format": "date-time"
3096
+ },
3097
+ "currency": {
3098
+ "$ref": "#/components/schemas/CurrencyCode"
3099
+ },
3100
+ "customerInfo": {
3101
+ "allOf": [
3102
+ {
3103
+ "$ref": "#/components/schemas/CustomerInfo"
3104
+ }
3105
+ ]
3106
+ },
3107
+ "giftCertificateItems": {
3108
+ "type": "array",
3109
+ "items": {
3110
+ "$ref": "#/components/schemas/GiftCertificateItem"
3111
+ }
3112
+ },
3113
+ "groupedTaxItems": {
3114
+ "type": "array",
3115
+ "items": {
3116
+ "$ref": "#/components/schemas/GroupedTaxItem"
3117
+ }
3118
+ },
3119
+ "inventoryReservationExpiry": {
3120
+ "type": "string",
3121
+ "format": "date-time"
3122
+ },
3123
+ "lastModified": {
3124
+ "type": "string",
3125
+ "format": "date-time"
3126
+ },
3127
+ "merchandizeTotalTax": {
3128
+ "type": "number",
3129
+ "format": "double"
3130
+ },
3131
+ "orderPriceAdjustments": {
3132
+ "type": "array",
3133
+ "items": {
3134
+ "$ref": "#/components/schemas/PriceAdjustment"
3135
+ }
3136
+ },
3137
+ "orderTotal": {
3138
+ "type": "number",
3139
+ "format": "double"
3140
+ },
3141
+ "paymentInstruments": {
3142
+ "type": "array",
3143
+ "items": {
3144
+ "$ref": "#/components/schemas/OrderPaymentInstrument"
3145
+ }
3146
+ },
3147
+ "productItems": {
3148
+ "type": "array",
3149
+ "items": {
3150
+ "$ref": "#/components/schemas/BasketProductItem"
3151
+ }
3152
+ },
3153
+ "productSubTotal": {
3154
+ "type": "number",
3155
+ "format": "double"
3156
+ },
3157
+ "productTotal": {
3158
+ "type": "number",
3159
+ "format": "double"
3160
+ },
3161
+ "shipments": {
3162
+ "type": "array",
3163
+ "items": {
3164
+ "$ref": "#/components/schemas/Shipment"
3165
+ }
3166
+ },
3167
+ "shippingItems": {
3168
+ "type": "array",
3169
+ "items": {
3170
+ "$ref": "#/components/schemas/ShippingItem"
3171
+ }
3172
+ },
3173
+ "shippingTotal": {
3174
+ "type": "number",
3175
+ "format": "double"
3176
+ },
3177
+ "shippingTotalTax": {
3178
+ "type": "number",
3179
+ "format": "double"
3180
+ },
3181
+ "sourceCode": {
3182
+ "type": "string"
3183
+ },
3184
+ "taxTotal": {
3185
+ "type": "number",
3186
+ "format": "double"
3187
+ },
3188
+ "taxation": {
3189
+ "type": "string",
3190
+ "enum": [
3191
+ "gross",
3192
+ "net"
3193
+ ]
3194
+ },
3195
+ "taxRoundedAtGroup": {
3196
+ "type": "boolean"
3197
+ },
3198
+ "temporaryBasket": {
3199
+ "type": "boolean"
3200
+ },
3201
+ "approachingDiscounts": {
3202
+ "type": "array",
3203
+ "items": {
3204
+ "$ref": "#/components/schemas/ApproachingDiscount"
3205
+ }
3206
+ }
3207
+ }
3208
+ },
3209
+ "OrderNo": {
3210
+ "type": "string",
3211
+ "maxLength": 50,
3212
+ "minLength": 1
3213
+ },
3214
+ "OmsProductData": {
3215
+ "type": "object",
3216
+ "additionalProperties": false,
3217
+ "properties": {
3218
+ "status": {
3219
+ "type": "string",
3220
+ "enum": [
3221
+ "ordered",
3222
+ "returned",
3223
+ "canceled",
3224
+ "paid",
3225
+ "reshipped",
3226
+ "fulfilled",
3227
+ "partially_fulfilled",
3228
+ "allocated",
3229
+ "partially_allocated",
3230
+ "return_initiated"
3231
+ ]
3232
+ },
3233
+ "quantityAvailableToCancel": {
3234
+ "type": "number",
3235
+ "format": "double"
3236
+ },
3237
+ "quantityAvailableToReturn": {
3238
+ "type": "number",
3239
+ "format": "double"
3240
+ },
3241
+ "quantityCanceled": {
3242
+ "type": "number",
3243
+ "format": "double"
3244
+ },
3245
+ "quantityReturnInitiated": {
3246
+ "type": "number",
3247
+ "format": "double"
3248
+ },
3249
+ "quantityReturned": {
3250
+ "type": "number",
3251
+ "format": "double"
3252
+ },
3253
+ "quantityOrdered": {
3254
+ "type": "number",
3255
+ "format": "double"
3256
+ }
3257
+ }
3258
+ },
3259
+ "OrderProductItem": {
3260
+ "allOf": [
3261
+ {
3262
+ "$ref": "#/components/schemas/ProductItem"
3263
+ }
3264
+ ],
3265
+ "properties": {
3266
+ "omsData": {
3267
+ "allOf": [
3268
+ {
3269
+ "$ref": "#/components/schemas/OmsProductData"
3270
+ }
3271
+ ]
3272
+ }
3273
+ }
3274
+ },
3275
+ "OmsShipmentItem": {
3276
+ "type": "object",
3277
+ "additionalProperties": false,
3278
+ "properties": {
3279
+ "id": {
3280
+ "type": "string"
3281
+ },
3282
+ "productItemId": {
3283
+ "type": "string"
3284
+ },
3285
+ "quantity": {
3286
+ "type": "number",
3287
+ "format": "double"
3288
+ }
3289
+ }
3290
+ },
3291
+ "OmsShipment": {
3292
+ "type": "object",
3293
+ "additionalProperties": false,
3294
+ "properties": {
3295
+ "id": {
3296
+ "type": "string"
3297
+ },
3298
+ "status": {
3299
+ "type": "string"
3300
+ },
3301
+ "provider": {
3302
+ "type": "string"
3303
+ },
3304
+ "trackingNumber": {
3305
+ "type": "string"
3306
+ },
3307
+ "trackingUrl": {
3308
+ "type": "string"
3309
+ },
3310
+ "expectedDeliveryDate": {
3311
+ "type": "string",
3312
+ "format": "date-time"
3313
+ },
3314
+ "actualDeliveryDate": {
3315
+ "type": "string",
3316
+ "format": "date-time"
3317
+ },
3318
+ "shipmentItems": {
3319
+ "type": "array",
3320
+ "items": {
3321
+ "$ref": "#/components/schemas/OmsShipmentItem"
3322
+ }
3323
+ }
3324
+ }
3325
+ },
3326
+ "OmsData": {
3327
+ "type": "object",
3328
+ "additionalProperties": false,
3329
+ "properties": {
3330
+ "status": {
3331
+ "type": "string"
3332
+ },
3333
+ "shipments": {
3334
+ "type": "array",
3335
+ "items": {
3336
+ "$ref": "#/components/schemas/OmsShipment"
3337
+ }
3338
+ }
3339
+ }
3340
+ },
3341
+ "Order": {
3342
+ "type": "object",
3343
+ "properties": {
3344
+ "adjustedMerchandizeTotalTax": {
3345
+ "type": "number",
3346
+ "format": "double"
3347
+ },
3348
+ "adjustedShippingTotalTax": {
3349
+ "type": "number",
3350
+ "format": "double"
3351
+ },
3352
+ "billingAddress": {
3353
+ "allOf": [
3354
+ {
3355
+ "$ref": "#/components/schemas/OrderAddress"
3356
+ }
3357
+ ]
3358
+ },
3359
+ "bonusDiscountLineItems": {
3360
+ "type": "array",
3361
+ "items": {
3362
+ "$ref": "#/components/schemas/BonusDiscountLineItem"
3363
+ }
3364
+ },
3365
+ "channelType": {
3366
+ "type": "string",
3367
+ "enum": [
3368
+ "storefront",
3369
+ "callcenter",
3370
+ "marketplace",
3371
+ "dss",
3372
+ "store",
3373
+ "pinterest",
3374
+ "twitter",
3375
+ "facebookads",
3376
+ "subscriptions",
3377
+ "onlinereservation",
3378
+ "customerservicecenter",
3379
+ "instagramcommerce",
3380
+ "tiktok",
3381
+ "snapchat",
3382
+ "google",
3383
+ "whatsapp",
3384
+ "youtube",
3385
+ "chatgpt",
3386
+ "gemini"
3387
+ ]
3388
+ },
3389
+ "confirmationStatus": {
3390
+ "type": "string",
3391
+ "enum": [
3392
+ "not_confirmed",
3393
+ "confirmed"
3394
+ ]
3395
+ },
3396
+ "couponItems": {
3397
+ "type": "array",
3398
+ "items": {
3399
+ "$ref": "#/components/schemas/CouponItem"
3400
+ }
3401
+ },
3402
+ "createdBy": {
3403
+ "type": "string"
3404
+ },
3405
+ "creationDate": {
3406
+ "type": "string",
3407
+ "format": "date-time"
3408
+ },
3409
+ "currency": {
3410
+ "allOf": [
3411
+ {
3412
+ "$ref": "#/components/schemas/CurrencyCode"
3413
+ }
3414
+ ]
3415
+ },
3416
+ "customerInfo": {
3417
+ "allOf": [
3418
+ {
3419
+ "$ref": "#/components/schemas/CustomerInfo"
3420
+ }
3421
+ ]
3422
+ },
3423
+ "customerName": {
3424
+ "type": "string"
3425
+ },
3426
+ "exportStatus": {
3427
+ "type": "string",
3428
+ "enum": [
3429
+ "not_exported",
3430
+ "exported",
3431
+ "ready",
3432
+ "failed"
3433
+ ]
3434
+ },
3435
+ "externalOrderStatus": {
3436
+ "type": "string"
3437
+ },
3438
+ "giftCertificateItems": {
3439
+ "type": "array",
3440
+ "items": {
3441
+ "$ref": "#/components/schemas/GiftCertificateItem"
3442
+ }
3443
+ },
3444
+ "globalPartyId": {
3445
+ "type": "string"
3446
+ },
3447
+ "lastModified": {
3448
+ "type": "string",
3449
+ "format": "date-time"
3450
+ },
3451
+ "merchandizeTotalTax": {
3452
+ "type": "number",
3453
+ "format": "double"
3454
+ },
3455
+ "orderNo": {
3456
+ "allOf": [
3457
+ {
3458
+ "$ref": "#/components/schemas/OrderNo"
3459
+ }
3460
+ ]
3461
+ },
3462
+ "orderPriceAdjustments": {
3463
+ "type": "array",
3464
+ "items": {
3465
+ "$ref": "#/components/schemas/PriceAdjustment"
3466
+ }
3467
+ },
3468
+ "orderToken": {
3469
+ "type": "string"
3470
+ },
3471
+ "orderTotal": {
3472
+ "type": "number",
3473
+ "format": "double"
3474
+ },
3475
+ "orderViewCode": {
3476
+ "type": "string"
3477
+ },
3478
+ "paymentInstruments": {
3479
+ "type": "array",
3480
+ "items": {
3481
+ "$ref": "#/components/schemas/OrderPaymentInstrument"
3482
+ }
3483
+ },
3484
+ "paymentStatus": {
3485
+ "type": "string",
3486
+ "enum": [
3487
+ "not_paid",
3488
+ "part_paid",
3489
+ "paid"
3490
+ ]
3491
+ },
3492
+ "productItems": {
3493
+ "type": "array",
3494
+ "items": {
3495
+ "$ref": "#/components/schemas/OrderProductItem"
3496
+ }
3497
+ },
3498
+ "productSubTotal": {
3499
+ "type": "number",
3500
+ "format": "double"
3501
+ },
3502
+ "productTotal": {
3503
+ "type": "number",
3504
+ "format": "double"
3505
+ },
3506
+ "taxRoundedAtGroup": {
3507
+ "type": "boolean"
3508
+ },
3509
+ "shipments": {
3510
+ "type": "array",
3511
+ "items": {
3512
+ "$ref": "#/components/schemas/Shipment"
3513
+ }
3514
+ },
3515
+ "shippingItems": {
3516
+ "type": "array",
3517
+ "items": {
3518
+ "$ref": "#/components/schemas/ShippingItem"
3519
+ }
3520
+ },
3521
+ "shippingStatus": {
3522
+ "type": "string",
3523
+ "enum": [
3524
+ "not_shipped",
3525
+ "part_shipped",
3526
+ "shipped"
3527
+ ]
3528
+ },
3529
+ "shippingTotal": {
3530
+ "type": "number",
3531
+ "format": "double"
3532
+ },
3533
+ "shippingTotalTax": {
3534
+ "type": "number",
3535
+ "format": "double"
3536
+ },
3537
+ "siteId": {
3538
+ "allOf": [
3539
+ {
3540
+ "$ref": "#/components/schemas/SiteId"
3541
+ }
3542
+ ]
3543
+ },
3544
+ "omsData": {
3545
+ "allOf": [
3546
+ {
3547
+ "$ref": "#/components/schemas/OmsData"
3548
+ }
3549
+ ]
3550
+ },
3551
+ "sourceCode": {
3552
+ "type": "string"
3553
+ },
3554
+ "status": {
3555
+ "type": "string",
3556
+ "enum": [
3557
+ "created",
3558
+ "new",
3559
+ "completed",
3560
+ "cancelled",
3561
+ "replaced",
3562
+ "failed"
3563
+ ]
3564
+ },
3565
+ "taxTotal": {
3566
+ "type": "number",
3567
+ "format": "double"
3568
+ },
3569
+ "taxation": {
3570
+ "type": "string",
3571
+ "enum": [
3572
+ "gross",
3573
+ "net"
3574
+ ]
3575
+ },
3576
+ "groupedTaxItems": {
3577
+ "type": "array",
3578
+ "items": {
3579
+ "$ref": "#/components/schemas/GroupedTaxItem"
3580
+ }
3581
+ },
3582
+ "guest": {
3583
+ "type": "boolean"
3584
+ }
3585
+ }
3586
+ },
3587
+ "ErrorResponse": {
3588
+ "type": "object",
3589
+ "additionalProperties": true,
3590
+ "properties": {
3591
+ "title": {
3592
+ "type": "string",
3593
+ "maxLength": 256
3594
+ },
3595
+ "type": {
3596
+ "type": "string",
3597
+ "maxLength": 2048
3598
+ },
3599
+ "detail": {
3600
+ "type": "string"
3601
+ },
3602
+ "instance": {
3603
+ "type": "string",
3604
+ "maxLength": 2048
3605
+ }
3606
+ },
3607
+ "required": [
3608
+ "detail",
3609
+ "title",
3610
+ "type"
3611
+ ]
3612
+ },
3613
+ "OmsReasonCode": {
3614
+ "type": "object",
3615
+ "additionalProperties": false,
3616
+ "properties": {
3617
+ "reason": {
3618
+ "type": "string",
3619
+ "maxLength": 256
3620
+ },
3621
+ "default": {
3622
+ "type": "boolean"
3623
+ }
3624
+ },
3625
+ "required": [
3626
+ "default",
3627
+ "reason"
3628
+ ]
3629
+ },
3630
+ "OmsMetaData": {
3631
+ "type": "object",
3632
+ "additionalProperties": false,
3633
+ "properties": {
3634
+ "cancelReasonCodes": {
3635
+ "type": "array",
3636
+ "items": {
3637
+ "$ref": "#/components/schemas/OmsReasonCode"
3638
+ }
3639
+ },
3640
+ "returnReasonCodes": {
3641
+ "type": "array",
3642
+ "items": {
3643
+ "$ref": "#/components/schemas/OmsReasonCode"
3644
+ }
3645
+ }
3646
+ },
3647
+ "required": [
3648
+ "cancelReasonCodes",
3649
+ "returnReasonCodes"
3650
+ ]
3651
+ },
3652
+ "OmsNotActiveErrorResponse": {
3653
+ "allOf": [
3654
+ {
3655
+ "$ref": "#/components/schemas/ErrorResponse"
3656
+ }
3657
+ ]
3658
+ },
3659
+ "OrderLookupRequest": {
3660
+ "type": "object",
3661
+ "additionalProperties": false,
3662
+ "properties": {
3663
+ "email": {
3664
+ "type": "string"
3665
+ },
3666
+ "orderViewCode": {
3667
+ "type": "string"
3668
+ },
3669
+ "postalCode": {
3670
+ "type": "string",
3671
+ "maxLength": 256
3672
+ },
3673
+ "phone": {
3674
+ "type": "string",
3675
+ "maxLength": 256
3676
+ }
3677
+ }
3678
+ },
3679
+ "FailOrderRequest": {
3680
+ "type": "object",
3681
+ "properties": {
3682
+ "reasonCode": {
3683
+ "type": "string",
3684
+ "enum": [
3685
+ "payment_confirm_failure",
3686
+ "payment_capture_failure",
3687
+ "payment_auth_failure"
3688
+ ]
3689
+ }
3690
+ }
3691
+ },
3692
+ "OrderAccessCode": {
3693
+ "type": "string",
3694
+ "maxLength": 6,
3695
+ "pattern": "^\\d{6}$"
3696
+ },
3697
+ "OmsCancelOrderRequest": {
3698
+ "type": "object",
3699
+ "additionalProperties": false,
3700
+ "properties": {
3701
+ "reason": {
3702
+ "type": "string",
3703
+ "maxLength": 256
3704
+ },
3705
+ "orderAccessCode": {
3706
+ "$ref": "#/components/schemas/OrderAccessCode"
3707
+ }
3708
+ }
3709
+ },
3710
+ "InvalidReasonCodeErrorResponse": {
3711
+ "allOf": [
3712
+ {
3713
+ "$ref": "#/components/schemas/ErrorResponse"
3714
+ }
3715
+ ],
3716
+ "properties": {
3717
+ "reason": {
3718
+ "type": "string",
3719
+ "maxLength": 256
3720
+ }
3721
+ }
3722
+ },
3723
+ "OrderCancelFailedErrorResponse": {
3724
+ "allOf": [
3725
+ {
3726
+ "$ref": "#/components/schemas/ErrorResponse"
3727
+ }
3728
+ ],
3729
+ "properties": {
3730
+ "orderNo": {
3731
+ "type": "string",
3732
+ "maxLength": 256
3733
+ }
3734
+ }
3735
+ },
3736
+ "OmsReturnProductItem": {
3737
+ "type": "object",
3738
+ "additionalProperties": false,
3739
+ "properties": {
3740
+ "itemId": {
3741
+ "type": "string",
3742
+ "maxLength": 256
3743
+ },
3744
+ "quantity": {
3745
+ "type": "number",
3746
+ "format": "double",
3747
+ "minimum": 0
3748
+ },
3749
+ "reason": {
3750
+ "type": "string",
3751
+ "maxLength": 256
3752
+ }
3753
+ },
3754
+ "required": [
3755
+ "itemId",
3756
+ "quantity"
3757
+ ]
3758
+ },
3759
+ "OmsReturnOrderRequest": {
3760
+ "type": "object",
3761
+ "additionalProperties": false,
3762
+ "properties": {
3763
+ "productItems": {
3764
+ "type": "array",
3765
+ "items": {
3766
+ "$ref": "#/components/schemas/OmsReturnProductItem"
3767
+ },
3768
+ "minItems": 1
3769
+ },
3770
+ "orderAccessCode": {
3771
+ "$ref": "#/components/schemas/OrderAccessCode"
3772
+ }
3773
+ },
3774
+ "required": [
3775
+ "productItems"
3776
+ ]
3777
+ },
3778
+ "UnknownProductItemIdsErrorResponse": {
3779
+ "allOf": [
3780
+ {
3781
+ "$ref": "#/components/schemas/ErrorResponse"
3782
+ }
3783
+ ],
3784
+ "properties": {
3785
+ "orderNo": {
3786
+ "type": "string",
3787
+ "maxLength": 256
3788
+ },
3789
+ "unknownItemIds": {
3790
+ "type": "array",
3791
+ "items": {
3792
+ "type": "string",
3793
+ "maxLength": 256
3794
+ }
3795
+ }
3796
+ }
3797
+ },
3798
+ "ReturnQuantityExceededErrorResponse": {
3799
+ "allOf": [
3800
+ {
3801
+ "$ref": "#/components/schemas/ErrorResponse"
3802
+ }
3803
+ ],
3804
+ "properties": {
3805
+ "orderNo": {
3806
+ "type": "string",
3807
+ "maxLength": 256
3808
+ },
3809
+ "itemIds": {
3810
+ "type": "array",
3811
+ "items": {
3812
+ "type": "string",
3813
+ "maxLength": 256
3814
+ }
3815
+ }
3816
+ }
3817
+ },
3818
+ "OrderReturnFailedErrorResponse": {
3819
+ "allOf": [
3820
+ {
3821
+ "$ref": "#/components/schemas/ErrorResponse"
3822
+ }
3823
+ ],
3824
+ "properties": {
3825
+ "orderNo": {
3826
+ "type": "string",
3827
+ "maxLength": 256
3828
+ }
3829
+ }
3830
+ },
3831
+ "RequestOrderAccessCodeRequest": {
3832
+ "type": "object",
3833
+ "additionalProperties": false,
3834
+ "properties": {
3835
+ "email": {
3836
+ "type": "string",
3837
+ "maxLength": 256
3838
+ }
3839
+ },
3840
+ "required": [
3841
+ "email"
3842
+ ]
3843
+ },
3844
+ "InvalidAccessCodeRequestErrorResponse": {
3845
+ "allOf": [
3846
+ {
3847
+ "$ref": "#/components/schemas/ErrorResponse"
3848
+ }
3849
+ ]
3850
+ },
3851
+ "OrderPaymentCardRequest": {
3852
+ "type": "object",
3853
+ "properties": {
3854
+ "cardType": {
3855
+ "type": "string",
3856
+ "maxLength": 256
3857
+ },
3858
+ "creditCardToken": {
3859
+ "type": "string"
3860
+ },
3861
+ "expirationMonth": {
3862
+ "type": "integer",
3863
+ "format": "int32"
3864
+ },
3865
+ "expirationYear": {
3866
+ "type": "integer",
3867
+ "format": "int32"
3868
+ },
3869
+ "holder": {
3870
+ "type": "string",
3871
+ "maxLength": 256
3872
+ },
3873
+ "issueNumber": {
3874
+ "type": "string",
3875
+ "maxLength": 256
3876
+ },
3877
+ "maskedNumber": {
3878
+ "type": "string",
3879
+ "maxLength": 25,
3880
+ "pattern": "^[0-9 -]{0,7}\\D{6,15}\\d{0,4}$"
3881
+ },
3882
+ "validFromMonth": {
3883
+ "type": "integer",
3884
+ "format": "int32",
3885
+ "maximum": 12,
3886
+ "minimum": 1
3887
+ },
3888
+ "validFromYear": {
3889
+ "type": "integer",
3890
+ "format": "int32"
3891
+ }
3892
+ }
3893
+ },
3894
+ "GiftCardRequest": {
3895
+ "type": "object",
3896
+ "additionalProperties": false,
3897
+ "properties": {
3898
+ "brand": {
3899
+ "type": "string",
3900
+ "maxLength": 256
3901
+ },
3902
+ "cardNumber": {
3903
+ "type": "string",
3904
+ "maxLength": 40
3905
+ },
3906
+ "cvc": {
3907
+ "type": "string",
3908
+ "maxLength": 4
3909
+ },
3910
+ "expirationMonth": {
3911
+ "type": "integer",
3912
+ "format": "int32"
3913
+ },
3914
+ "expirationYear": {
3915
+ "type": "integer",
3916
+ "format": "int32"
3917
+ }
3918
+ },
3919
+ "required": [
3920
+ "brand",
3921
+ "cardNumber",
3922
+ "cvc"
3923
+ ]
3924
+ },
3925
+ "PaymentReferenceRequest": {
3926
+ "type": "object",
3927
+ "properties": {
3928
+ "paymentMethodType": {
3929
+ "type": "string",
3930
+ "maxLength": 64
3931
+ },
3932
+ "zoneId": {
3933
+ "type": "string",
3934
+ "maxLength": 100,
3935
+ "minLength": 1,
3936
+ "pattern": "^[a-zA-Z0-9\\-_]{1,100}$"
3937
+ },
3938
+ "gateway": {
3939
+ "type": "string",
3940
+ "enum": [
3941
+ "stripe",
3942
+ "paypal",
3943
+ "adyen"
3944
+ ]
3945
+ },
3946
+ "gatewayProperties": {
3947
+ "type": "object",
3948
+ "additionalProperties": false,
3949
+ "properties": {
3950
+ "stripe": {
3951
+ "type": "object",
3952
+ "additionalProperties": true
3953
+ },
3954
+ "paypal": {
3955
+ "type": "object",
3956
+ "additionalProperties": true
3957
+ },
3958
+ "adyen": {
3959
+ "type": "object",
3960
+ "additionalProperties": true
3961
+ }
3962
+ }
3963
+ }
3964
+ }
3965
+ },
3966
+ "OrderPaymentInstrumentRequest": {
3967
+ "type": "object",
3968
+ "additionalProperties": {},
3969
+ "properties": {
3970
+ "amount": {
3971
+ "type": "number",
3972
+ "format": "double"
3973
+ },
3974
+ "bankRoutingNumber": {
3975
+ "type": "string",
3976
+ "maxLength": 256
3977
+ },
3978
+ "giftCertificateCode": {
3979
+ "type": "string",
3980
+ "maxLength": 256
3981
+ },
3982
+ "paymentCard": {
3983
+ "allOf": [
3984
+ {
3985
+ "$ref": "#/components/schemas/OrderPaymentCardRequest"
3986
+ }
3987
+ ]
3988
+ },
3989
+ "giftCardRequest": {
3990
+ "allOf": [
3991
+ {
3992
+ "$ref": "#/components/schemas/GiftCardRequest"
3993
+ }
3994
+ ]
3995
+ },
3996
+ "paymentMethodId": {
3997
+ "type": "string",
3998
+ "maxLength": 256
3999
+ },
4000
+ "paymentReferenceRequest": {
4001
+ "allOf": [
4002
+ {
4003
+ "$ref": "#/components/schemas/PaymentReferenceRequest"
4004
+ }
4005
+ ]
4006
+ }
4007
+ }
4008
+ },
4009
+ "PaymentCardSpec": {
4010
+ "type": "object",
4011
+ "properties": {
4012
+ "cardType": {
4013
+ "type": "string"
4014
+ },
4015
+ "checksumVerificationEnabled": {
4016
+ "type": "boolean"
4017
+ },
4018
+ "description": {
4019
+ "type": "string"
4020
+ },
4021
+ "image": {
4022
+ "type": "string"
4023
+ },
4024
+ "name": {
4025
+ "type": "string"
4026
+ },
4027
+ "numberLengths": {
4028
+ "type": "array",
4029
+ "items": {
4030
+ "type": "string"
4031
+ }
4032
+ },
4033
+ "numberPrefixes": {
4034
+ "type": "array",
4035
+ "items": {
4036
+ "type": "string"
4037
+ }
4038
+ },
4039
+ "securityCodeLength": {
4040
+ "type": "integer",
4041
+ "format": "int32"
4042
+ }
4043
+ }
4044
+ },
4045
+ "PaymentMethod": {
4046
+ "type": "object",
4047
+ "additionalProperties": {},
4048
+ "properties": {
4049
+ "cards": {
4050
+ "type": "array",
4051
+ "items": {
4052
+ "$ref": "#/components/schemas/PaymentCardSpec"
4053
+ }
4054
+ },
4055
+ "description": {
4056
+ "type": "string"
4057
+ },
4058
+ "id": {
4059
+ "type": "string",
4060
+ "maxLength": 256
4061
+ },
4062
+ "image": {
4063
+ "type": "string"
4064
+ },
4065
+ "name": {
4066
+ "type": "string"
4067
+ },
4068
+ "paymentProcessorId": {
4069
+ "type": "string"
4070
+ }
4071
+ },
4072
+ "required": [
4073
+ "id"
4074
+ ]
4075
+ },
4076
+ "PaymentMethodResult": {
4077
+ "type": "object",
4078
+ "properties": {
4079
+ "applicablePaymentMethods": {
4080
+ "type": "array",
4081
+ "items": {
4082
+ "$ref": "#/components/schemas/PaymentMethod"
4083
+ }
4084
+ }
4085
+ }
4086
+ },
4087
+ "TaxItems": {
4088
+ "type": "object",
4089
+ "properties": {
4090
+ "taxItems": {
4091
+ "type": "array",
4092
+ "items": {
4093
+ "$ref": "#/components/schemas/TaxItem"
4094
+ }
4095
+ }
4096
+ }
4097
+ },
4098
+ "Taxes": {
4099
+ "type": "object",
4100
+ "additionalProperties": false,
4101
+ "properties": {
4102
+ "taxes": {
4103
+ "type": "object",
4104
+ "additionalProperties": {
4105
+ "$ref": "#/components/schemas/TaxItems"
4106
+ }
4107
+ }
4108
+ },
4109
+ "required": [
4110
+ "taxes"
4111
+ ]
4112
+ }
4113
+ },
4114
+ "responses": {
4115
+ "409OmsNotActive": {
4116
+ "description": "Order Management (OMS) is not active for this site.",
4117
+ "content": {
4118
+ "application/problem+json": {
4119
+ "schema": {
4120
+ "$ref": "#/components/schemas/OmsNotActiveErrorResponse"
4121
+ }
4122
+ }
4123
+ }
4124
+ },
4125
+ "400OmsCancelBadRequest": {
4126
+ "description": "The cancel request is invalid. Possible reasons:\n- The supplied reason code is not configured in Order Management (OMS).",
4127
+ "content": {
4128
+ "application/problem+json": {
4129
+ "schema": {
4130
+ "$ref": "#/components/schemas/InvalidReasonCodeErrorResponse"
4131
+ }
4132
+ }
4133
+ }
4134
+ },
4135
+ "409OmsCancelConflict": {
4136
+ "description": "The order cannot be cancelled. Possible reasons:\n- The order is no longer in a state that permits cancellation.\n- Order Management (OMS) rejected the cancel request after ECOM accepted the input.\n- Order Management (OMS) is not active for this site.",
4137
+ "content": {
4138
+ "application/problem+json": {
4139
+ "schema": {
4140
+ "oneOf": [
4141
+ {
4142
+ "$ref": "#/components/schemas/OrderCancelFailedErrorResponse"
4143
+ },
4144
+ {
4145
+ "$ref": "#/components/schemas/OmsNotActiveErrorResponse"
4146
+ }
4147
+ ]
4148
+ }
4149
+ }
4150
+ }
4151
+ },
4152
+ "400OmsReturnBadRequest": {
4153
+ "description": "The return request is invalid. Possible reasons:\n- The supplied reason code is not configured in Order Management (OMS).\n- One or more of the supplied `productItems[].itemId` values do not match any product item of the order.\n- The requested return quantity exceeds the quantity available to return for one or more items.",
4154
+ "content": {
4155
+ "application/problem+json": {
4156
+ "schema": {
4157
+ "oneOf": [
4158
+ {
4159
+ "$ref": "#/components/schemas/InvalidReasonCodeErrorResponse"
4160
+ },
4161
+ {
4162
+ "$ref": "#/components/schemas/UnknownProductItemIdsErrorResponse"
4163
+ },
4164
+ {
4165
+ "$ref": "#/components/schemas/ReturnQuantityExceededErrorResponse"
4166
+ }
4167
+ ]
4168
+ }
4169
+ }
4170
+ }
4171
+ },
4172
+ "409OmsReturnConflict": {
4173
+ "description": "The order cannot be returned. Possible reasons:\n- The order is no longer in a state that permits return of the requested items.\n- Order Management (OMS) rejected the return after ECOM accepted the input.\n- Order Management (OMS) is not active for this site.",
4174
+ "content": {
4175
+ "application/problem+json": {
4176
+ "schema": {
4177
+ "oneOf": [
4178
+ {
4179
+ "$ref": "#/components/schemas/OrderReturnFailedErrorResponse"
4180
+ },
4181
+ {
4182
+ "$ref": "#/components/schemas/OmsNotActiveErrorResponse"
4183
+ }
4184
+ ]
4185
+ }
4186
+ }
4187
+ }
4188
+ },
4189
+ "400RequestAccessCodeBadRequest": {
4190
+ "description": "The access code request is invalid. Possible reasons:\n- The email field is missing or empty.",
4191
+ "content": {
4192
+ "application/problem+json": {
4193
+ "schema": {
4194
+ "$ref": "#/components/schemas/InvalidAccessCodeRequestErrorResponse"
4195
+ }
4196
+ }
4197
+ }
4198
+ }
4199
+ },
4200
+ "parameters": {
4201
+ "organizationId": {
4202
+ "name": "organizationId",
4203
+ "in": "path",
4204
+ "required": true,
4205
+ "style": "simple",
4206
+ "explode": false,
4207
+ "schema": {
4208
+ "$ref": "#/components/schemas/OrganizationId"
4209
+ }
4210
+ },
4211
+ "siteId": {
4212
+ "name": "siteId",
4213
+ "in": "query",
4214
+ "required": true,
4215
+ "style": "form",
4216
+ "explode": true,
4217
+ "schema": {
4218
+ "$ref": "#/components/schemas/SiteId"
4219
+ }
4220
+ },
4221
+ "locale": {
4222
+ "name": "locale",
4223
+ "in": "query",
4224
+ "required": false,
4225
+ "style": "form",
4226
+ "explode": true,
4227
+ "schema": {
4228
+ "$ref": "#/components/schemas/LocaleCode"
4229
+ }
4230
+ },
4231
+ "orderNo": {
4232
+ "name": "orderNo",
4233
+ "in": "path",
4234
+ "required": true,
4235
+ "style": "simple",
4236
+ "explode": false,
4237
+ "schema": {
4238
+ "$ref": "#/components/schemas/OrderNo"
4239
+ }
4240
+ },
4241
+ "expandOrders": {
4242
+ "name": "expand",
4243
+ "in": "query",
4244
+ "required": false,
4245
+ "style": "form",
4246
+ "explode": false,
4247
+ "schema": {
4248
+ "type": "array",
4249
+ "items": {
4250
+ "type": "string",
4251
+ "enum": [
4252
+ "oms",
4253
+ "oms_shipments"
4254
+ ]
4255
+ }
4256
+ }
4257
+ },
4258
+ "reopenBasket": {
4259
+ "name": "reopenBasket",
4260
+ "in": "query",
4261
+ "required": false,
4262
+ "style": "form",
4263
+ "explode": true,
4264
+ "schema": {
4265
+ "type": "boolean",
4266
+ "default": false
4267
+ }
4268
+ },
4269
+ "expandOms": {
4270
+ "name": "expand",
4271
+ "in": "query",
4272
+ "required": false,
4273
+ "style": "form",
4274
+ "explode": false,
4275
+ "schema": {
4276
+ "type": "array",
4277
+ "items": {
4278
+ "type": "string",
4279
+ "enum": [
4280
+ "oms"
4281
+ ]
4282
+ }
4283
+ }
4284
+ },
4285
+ "paymentInstrumentId": {
4286
+ "name": "paymentInstrumentId",
4287
+ "in": "path",
4288
+ "required": true,
4289
+ "style": "simple",
4290
+ "explode": false,
4291
+ "schema": {
4292
+ "$ref": "#/components/schemas/PaymentInstrumentId"
4293
+ }
4294
+ },
4295
+ "sfdcUsid": {
4296
+ "name": "sfdc_usid",
4297
+ "in": "header",
4298
+ "required": false,
4299
+ "style": "simple",
4300
+ "explode": false,
4301
+ "schema": {
4302
+ "type": "string",
4303
+ "format": "uuid"
4304
+ }
4305
+ },
4306
+ "sfdcDwDnt": {
4307
+ "name": "sfdc_dw_dnt",
4308
+ "in": "header",
4309
+ "required": false,
4310
+ "style": "simple",
4311
+ "explode": false,
4312
+ "schema": {
4313
+ "type": "string",
4314
+ "enum": [
4315
+ "0",
4316
+ "1"
4317
+ ]
4318
+ }
4319
+ },
4320
+ "personalized": {
4321
+ "name": "personalized",
4322
+ "in": "query",
4323
+ "required": false,
4324
+ "style": "form",
4325
+ "explode": true,
4326
+ "schema": {
4327
+ "type": "string",
4328
+ "enum": [
4329
+ "none"
4330
+ ]
4331
+ }
4332
+ },
4333
+ "sfdcShopperContext": {
4334
+ "name": "sfdc_shopper_context",
4335
+ "in": "header",
4336
+ "required": false,
4337
+ "style": "simple",
4338
+ "explode": false,
4339
+ "schema": {
4340
+ "type": "string"
4341
+ }
4342
+ }
4343
+ },
4344
+ "securitySchemes": {
4345
+ "ShopperToken": {
4346
+ "type": "oauth2",
4347
+ "flows": {
4348
+ "clientCredentials": {
4349
+ "tokenUrl": "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/v1/organizations/{organizationId}/oauth2/token",
4350
+ "scopes": {
4351
+ "sfcc.shopper-baskets-orders": "Scope granting read-access to shopper basket or orders endpoints",
4352
+ "sfcc.shopper-baskets-orders.rw": "Scope granting read and write access to shopper basket or orders endpoints"
4353
+ }
4354
+ },
4355
+ "authorizationCode": {
4356
+ "authorizationUrl": "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/v1/organizations/{organizationId}/oauth2/authorize",
4357
+ "tokenUrl": "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/v1/organizations/{organizationId}/oauth2/token",
4358
+ "scopes": {
4359
+ "sfcc.shopper-baskets-orders": "Scope granting read-access to shopper basket or orders endpoints",
4360
+ "sfcc.shopper-baskets-orders.rw": "Scope granting read and write access to shopper basket or orders endpoints"
4361
+ }
4362
+ }
4363
+ }
4364
+ },
4365
+ "ShopperTokenTsob": {
4366
+ "type": "oauth2",
4367
+ "flows": {
4368
+ "clientCredentials": {
4369
+ "tokenUrl": "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/v1/organizations/{organizationId}/oauth2/trusted-system/token",
4370
+ "scopes": {
4371
+ "sfcc.shopper-baskets-orders": "Scope granting read-access to shopper basket or orders endpoints",
4372
+ "sfcc.shopper-baskets-orders.rw": "Scope granting read and write access to shopper basket or orders endpoints"
4373
+ }
4374
+ }
4375
+ }
4376
+ },
4377
+ "AmOAuth2": {
4378
+ "type": "oauth2",
4379
+ "flows": {
4380
+ "clientCredentials": {
4381
+ "tokenUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
4382
+ "scopes": {
4383
+ "sfcc.shopper-baskets-orders": "Scope granting read-access to shopper basket or orders endpoints",
4384
+ "sfcc.shopper-baskets-orders.rw": "Scope granting read and write access to shopper basket or orders endpoints"
4385
+ }
4386
+ },
4387
+ "authorizationCode": {
4388
+ "authorizationUrl": "https://account.demandware.com/dwsso/oauth2/authorize",
4389
+ "tokenUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
4390
+ "scopes": {
4391
+ "sfcc.shopper-baskets-orders": "Scope granting read-access to shopper basket or orders endpoints",
4392
+ "sfcc.shopper-baskets-orders.rw": "Scope granting read and write access to shopper basket or orders endpoints"
4393
+ }
4394
+ }
4395
+ }
4396
+ },
4397
+ "ShopperClientContextToken": {
4398
+ "type": "oauth2",
4399
+ "flows": {
4400
+ "clientCredentials": {
4401
+ "tokenUrl": "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/v1/organizations/{organizationId}/oauth2/token?hint=client_context",
4402
+ "scopes": {
4403
+ "sfcc.shopper-baskets-orders": "Scope granting read-access to shopper basket or orders endpoints",
4404
+ "sfcc.shopper-baskets-orders.rw": "Scope granting read and write access to shopper basket or orders endpoints"
4405
+ }
4406
+ }
4407
+ }
4408
+ }
4409
+ }
4410
+ }
4411
+ }