@salesforce/b2c-tooling-sdk 1.24.2 → 2.0.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 (460) 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 +80 -116
  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 +3 -0
  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 +138 -9
  55. package/dist/esm/cli/mrt-command.js +277 -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 +1 -0
  61. package/dist/esm/clients/cdn-zones.js +2 -5
  62. package/dist/esm/clients/cdn-zones.js.map +1 -1
  63. package/dist/esm/clients/cip.d.ts +12 -3
  64. package/dist/esm/clients/cip.js +85 -30
  65. package/dist/esm/clients/cip.js.map +1 -1
  66. package/dist/esm/clients/custom-apis.js +2 -5
  67. package/dist/esm/clients/custom-apis.js.map +1 -1
  68. package/dist/esm/clients/dual-backend-factory.d.ts +70 -0
  69. package/dist/esm/clients/dual-backend-factory.js +48 -0
  70. package/dist/esm/clients/dual-backend-factory.js.map +1 -0
  71. package/dist/esm/clients/error-utils.d.ts +62 -0
  72. package/dist/esm/clients/error-utils.js +98 -0
  73. package/dist/esm/clients/error-utils.js.map +1 -1
  74. package/dist/esm/clients/granular-replications.js +2 -5
  75. package/dist/esm/clients/granular-replications.js.map +1 -1
  76. package/dist/esm/clients/index.d.ts +28 -3
  77. package/dist/esm/clients/index.js +24 -2
  78. package/dist/esm/clients/index.js.map +1 -1
  79. package/dist/esm/clients/metrics.js +2 -5
  80. package/dist/esm/clients/metrics.js.map +1 -1
  81. package/dist/esm/clients/middleware-registry.d.ts +4 -2
  82. package/dist/esm/clients/middleware-registry.js +3 -1
  83. package/dist/esm/clients/middleware-registry.js.map +1 -1
  84. package/dist/esm/clients/middleware.d.ts +39 -0
  85. package/dist/esm/clients/middleware.js +126 -25
  86. package/dist/esm/clients/middleware.js.map +1 -1
  87. package/dist/esm/clients/mrt-b2c.js +3 -0
  88. package/dist/esm/clients/mrt-b2c.js.map +1 -1
  89. package/dist/esm/clients/mrt.d.ts +27 -10
  90. package/dist/esm/clients/mrt.generated.d.ts +77 -0
  91. package/dist/esm/clients/mrt.js +68 -0
  92. package/dist/esm/clients/mrt.js.map +1 -1
  93. package/dist/esm/clients/preferences.js +2 -5
  94. package/dist/esm/clients/preferences.js.map +1 -1
  95. package/dist/esm/clients/scapi-backend-utils.d.ts +163 -0
  96. package/dist/esm/clients/scapi-backend-utils.js +180 -0
  97. package/dist/esm/clients/scapi-backend-utils.js.map +1 -0
  98. package/dist/esm/clients/scapi-catalogs.d.ts +12 -0
  99. package/dist/esm/clients/scapi-catalogs.generated.d.ts +104 -0
  100. package/dist/esm/clients/scapi-catalogs.generated.js +6 -0
  101. package/dist/esm/clients/scapi-catalogs.generated.js.map +1 -0
  102. package/dist/esm/clients/scapi-catalogs.js +14 -0
  103. package/dist/esm/clients/scapi-catalogs.js.map +1 -0
  104. package/dist/esm/clients/scapi-client-factory.d.ts +81 -0
  105. package/dist/esm/clients/scapi-client-factory.js +84 -0
  106. package/dist/esm/clients/scapi-client-factory.js.map +1 -0
  107. package/dist/esm/clients/scapi-fallback-backend.d.ts +34 -0
  108. package/dist/esm/clients/scapi-fallback-backend.js +132 -0
  109. package/dist/esm/clients/scapi-fallback-backend.js.map +1 -0
  110. package/dist/esm/clients/scapi-jobs.d.ts +32 -0
  111. package/dist/esm/clients/scapi-jobs.generated.d.ts +535 -0
  112. package/dist/esm/clients/scapi-jobs.generated.js +6 -0
  113. package/dist/esm/clients/scapi-jobs.generated.js.map +1 -0
  114. package/dist/esm/clients/scapi-jobs.js +24 -0
  115. package/dist/esm/clients/scapi-jobs.js.map +1 -0
  116. package/dist/esm/clients/scapi-merchant-roles.d.ts +19 -0
  117. package/dist/esm/clients/scapi-merchant-roles.generated.d.ts +726 -0
  118. package/dist/esm/clients/scapi-merchant-roles.generated.js +6 -0
  119. package/dist/esm/clients/scapi-merchant-roles.generated.js.map +1 -0
  120. package/dist/esm/clients/scapi-merchant-roles.js +12 -0
  121. package/dist/esm/clients/scapi-merchant-roles.js.map +1 -0
  122. package/dist/esm/clients/scapi-merchant-users.d.ts +19 -0
  123. package/dist/esm/clients/scapi-merchant-users.generated.d.ts +300 -0
  124. package/dist/esm/clients/scapi-merchant-users.generated.js +6 -0
  125. package/dist/esm/clients/scapi-merchant-users.generated.js.map +1 -0
  126. package/dist/esm/clients/scapi-merchant-users.js +12 -0
  127. package/dist/esm/clients/scapi-merchant-users.js.map +1 -0
  128. package/dist/esm/clients/scapi-schemas.js +2 -5
  129. package/dist/esm/clients/scapi-schemas.js.map +1 -1
  130. package/dist/esm/clients/scapi-scope-tier.d.ts +78 -0
  131. package/dist/esm/clients/scapi-scope-tier.js +113 -0
  132. package/dist/esm/clients/scapi-scope-tier.js.map +1 -0
  133. package/dist/esm/clients/scapi-scripts.d.ts +17 -0
  134. package/dist/esm/clients/scapi-scripts.generated.d.ts +392 -0
  135. package/dist/esm/clients/scapi-scripts.generated.js +6 -0
  136. package/dist/esm/clients/scapi-scripts.generated.js.map +1 -0
  137. package/dist/esm/clients/scapi-scripts.js +12 -0
  138. package/dist/esm/clients/scapi-scripts.js.map +1 -0
  139. package/dist/esm/clients/scapi-sites.d.ts +26 -0
  140. package/dist/esm/clients/scapi-sites.generated.d.ts +500 -0
  141. package/dist/esm/clients/scapi-sites.generated.js +6 -0
  142. package/dist/esm/clients/scapi-sites.generated.js.map +1 -0
  143. package/dist/esm/clients/scapi-sites.js +25 -0
  144. package/dist/esm/clients/scapi-sites.js.map +1 -0
  145. package/dist/esm/clients/slas-shopper.d.ts +19 -0
  146. package/dist/esm/clients/slas-shopper.generated.d.ts +165 -0
  147. package/dist/esm/clients/slas-shopper.generated.js +6 -0
  148. package/dist/esm/clients/slas-shopper.generated.js.map +1 -0
  149. package/dist/esm/clients/slas-shopper.js +35 -0
  150. package/dist/esm/clients/slas-shopper.js.map +1 -0
  151. package/dist/esm/clients/storefront-deployments.d.ts +56 -0
  152. package/dist/esm/clients/storefront-deployments.generated.d.ts +558 -0
  153. package/dist/esm/clients/storefront-deployments.generated.js +6 -0
  154. package/dist/esm/clients/storefront-deployments.generated.js.map +1 -0
  155. package/dist/esm/clients/storefront-deployments.js +24 -0
  156. package/dist/esm/clients/storefront-deployments.js.map +1 -0
  157. package/dist/esm/clients/webdav.js +4 -1
  158. package/dist/esm/clients/webdav.js.map +1 -1
  159. package/dist/esm/compat/dispatcher.d.ts +49 -0
  160. package/dist/esm/compat/dispatcher.js +124 -0
  161. package/dist/esm/compat/dispatcher.js.map +1 -0
  162. package/dist/esm/compat/index.d.ts +10 -0
  163. package/dist/esm/compat/index.js +15 -0
  164. package/dist/esm/compat/index.js.map +1 -0
  165. package/dist/esm/compat/jobs-backend.d.ts +31 -0
  166. package/dist/esm/compat/jobs-backend.js +76 -0
  167. package/dist/esm/compat/jobs-backend.js.map +1 -0
  168. package/dist/esm/config/dw-json.d.ts +4 -0
  169. package/dist/esm/config/dw-json.js.map +1 -1
  170. package/dist/esm/config/index.d.ts +1 -1
  171. package/dist/esm/config/index.js.map +1 -1
  172. package/dist/esm/config/mapping.d.ts +2 -5
  173. package/dist/esm/config/mapping.js +25 -1
  174. package/dist/esm/config/mapping.js.map +1 -1
  175. package/dist/esm/config/resolved-config.d.ts +2 -2
  176. package/dist/esm/config/resolved-config.js.map +1 -1
  177. package/dist/esm/config/sources/env-source.js +17 -0
  178. package/dist/esm/config/sources/env-source.js.map +1 -1
  179. package/dist/esm/config/types.d.ts +21 -2
  180. package/dist/esm/docs/search.js +2 -25
  181. package/dist/esm/docs/search.js.map +1 -1
  182. package/dist/esm/guidance/catalog.d.ts +37 -0
  183. package/dist/esm/guidance/catalog.js +282 -0
  184. package/dist/esm/guidance/catalog.js.map +1 -0
  185. package/dist/esm/guidance/index.d.ts +8 -0
  186. package/dist/esm/guidance/index.js +14 -0
  187. package/dist/esm/guidance/index.js.map +1 -0
  188. package/dist/esm/guidance/markdown.d.ts +10 -0
  189. package/dist/esm/guidance/markdown.js +52 -0
  190. package/dist/esm/guidance/markdown.js.map +1 -0
  191. package/dist/esm/guidance/types.d.ts +92 -0
  192. package/dist/esm/guidance/types.js +17 -0
  193. package/dist/esm/guidance/types.js.map +1 -0
  194. package/dist/esm/index.d.ts +14 -5
  195. package/dist/esm/index.js +14 -2
  196. package/dist/esm/index.js.map +1 -1
  197. package/dist/esm/instance/index.d.ts +96 -2
  198. package/dist/esm/instance/index.js +98 -5
  199. package/dist/esm/instance/index.js.map +1 -1
  200. package/dist/esm/operations/bm-roles/backend.d.ts +4 -0
  201. package/dist/esm/operations/bm-roles/backend.js +11 -0
  202. package/dist/esm/operations/bm-roles/backend.js.map +1 -0
  203. package/dist/esm/operations/bm-roles/index.d.ts +6 -0
  204. package/dist/esm/operations/bm-roles/index.js +4 -0
  205. package/dist/esm/operations/bm-roles/index.js.map +1 -1
  206. package/dist/esm/operations/bm-roles/ocapi-backend.d.ts +17 -0
  207. package/dist/esm/operations/bm-roles/ocapi-backend.js +151 -0
  208. package/dist/esm/operations/bm-roles/ocapi-backend.js.map +1 -0
  209. package/dist/esm/operations/bm-roles/roles.js +13 -17
  210. package/dist/esm/operations/bm-roles/roles.js.map +1 -1
  211. package/dist/esm/operations/bm-roles/scapi-backend.d.ts +27 -0
  212. package/dist/esm/operations/bm-roles/scapi-backend.js +138 -0
  213. package/dist/esm/operations/bm-roles/scapi-backend.js.map +1 -0
  214. package/dist/esm/operations/bm-roles/types.d.ts +49 -0
  215. package/dist/esm/operations/bm-roles/types.js +2 -0
  216. package/dist/esm/operations/bm-roles/types.js.map +1 -0
  217. package/dist/esm/operations/bm-users/backend.d.ts +4 -0
  218. package/dist/esm/operations/bm-users/backend.js +11 -0
  219. package/dist/esm/operations/bm-users/backend.js.map +1 -0
  220. package/dist/esm/operations/bm-users/index.d.ts +11 -3
  221. package/dist/esm/operations/bm-users/index.js +9 -3
  222. package/dist/esm/operations/bm-users/index.js.map +1 -1
  223. package/dist/esm/operations/bm-users/ocapi-backend.d.ts +13 -0
  224. package/dist/esm/operations/bm-users/ocapi-backend.js +92 -0
  225. package/dist/esm/operations/bm-users/ocapi-backend.js.map +1 -0
  226. package/dist/esm/operations/bm-users/scapi-backend.d.ts +23 -0
  227. package/dist/esm/operations/bm-users/scapi-backend.js +199 -0
  228. package/dist/esm/operations/bm-users/scapi-backend.js.map +1 -0
  229. package/dist/esm/operations/bm-users/types.d.ts +99 -0
  230. package/dist/esm/operations/bm-users/types.js +2 -0
  231. package/dist/esm/operations/bm-users/types.js.map +1 -0
  232. package/dist/esm/operations/bm-users/users.d.ts +4 -3
  233. package/dist/esm/operations/bm-users/users.js +23 -19
  234. package/dist/esm/operations/bm-users/users.js.map +1 -1
  235. package/dist/esm/operations/cap/install.js +23 -45
  236. package/dist/esm/operations/cap/install.js.map +1 -1
  237. package/dist/esm/operations/cap/list.js +4 -8
  238. package/dist/esm/operations/cap/list.js.map +1 -1
  239. package/dist/esm/operations/cap/uninstall.js +17 -37
  240. package/dist/esm/operations/cap/uninstall.js.map +1 -1
  241. package/dist/esm/operations/catalogs/catalogs-backend.d.ts +4 -0
  242. package/dist/esm/operations/catalogs/catalogs-backend.js +16 -0
  243. package/dist/esm/operations/catalogs/catalogs-backend.js.map +1 -0
  244. package/dist/esm/operations/catalogs/catalogs-types.d.ts +14 -0
  245. package/dist/esm/operations/catalogs/catalogs-types.js +2 -0
  246. package/dist/esm/operations/catalogs/catalogs-types.js.map +1 -0
  247. package/dist/esm/operations/catalogs/index.d.ts +7 -0
  248. package/dist/esm/operations/catalogs/index.js +10 -0
  249. package/dist/esm/operations/catalogs/index.js.map +1 -0
  250. package/dist/esm/operations/catalogs/ocapi-catalogs-backend.d.ts +8 -0
  251. package/dist/esm/operations/catalogs/ocapi-catalogs-backend.js +36 -0
  252. package/dist/esm/operations/catalogs/ocapi-catalogs-backend.js.map +1 -0
  253. package/dist/esm/operations/catalogs/scapi-catalogs-backend.d.ts +15 -0
  254. package/dist/esm/operations/catalogs/scapi-catalogs-backend.js +42 -0
  255. package/dist/esm/operations/catalogs/scapi-catalogs-backend.js.map +1 -0
  256. package/dist/esm/operations/cip/index.js +10 -2
  257. package/dist/esm/operations/cip/index.js.map +1 -1
  258. package/dist/esm/operations/cip/reports.js +19 -3
  259. package/dist/esm/operations/cip/reports.js.map +1 -1
  260. package/dist/esm/operations/cip/types.d.ts +8 -4
  261. package/dist/esm/operations/code/deploy.d.ts +3 -0
  262. package/dist/esm/operations/code/deploy.js +5 -3
  263. package/dist/esm/operations/code/deploy.js.map +1 -1
  264. package/dist/esm/operations/code/download.d.ts +3 -0
  265. package/dist/esm/operations/code/download.js +5 -5
  266. package/dist/esm/operations/code/download.js.map +1 -1
  267. package/dist/esm/operations/code/index.d.ts +7 -1
  268. package/dist/esm/operations/code/index.js +5 -1
  269. package/dist/esm/operations/code/index.js.map +1 -1
  270. package/dist/esm/operations/code/ocapi-scripts-backend.d.ts +12 -0
  271. package/dist/esm/operations/code/ocapi-scripts-backend.js +40 -0
  272. package/dist/esm/operations/code/ocapi-scripts-backend.js.map +1 -0
  273. package/dist/esm/operations/code/scapi-scripts-backend.d.ts +22 -0
  274. package/dist/esm/operations/code/scapi-scripts-backend.js +94 -0
  275. package/dist/esm/operations/code/scapi-scripts-backend.js.map +1 -0
  276. package/dist/esm/operations/code/scripts-backend.d.ts +17 -0
  277. package/dist/esm/operations/code/scripts-backend.js +40 -0
  278. package/dist/esm/operations/code/scripts-backend.js.map +1 -0
  279. package/dist/esm/operations/code/scripts-types.d.ts +43 -0
  280. package/dist/esm/operations/code/scripts-types.js +2 -0
  281. package/dist/esm/operations/code/scripts-types.js.map +1 -0
  282. package/dist/esm/operations/code/upload-files.d.ts +6 -0
  283. package/dist/esm/operations/code/upload-files.js +58 -7
  284. package/dist/esm/operations/code/upload-files.js.map +1 -1
  285. package/dist/esm/operations/code/versions.d.ts +0 -20
  286. package/dist/esm/operations/code/versions.js +16 -51
  287. package/dist/esm/operations/code/versions.js.map +1 -1
  288. package/dist/esm/operations/code/watch.d.ts +3 -0
  289. package/dist/esm/operations/code/watch.js +3 -2
  290. package/dist/esm/operations/code/watch.js.map +1 -1
  291. package/dist/esm/operations/jobs/discover.d.ts +1 -1
  292. package/dist/esm/operations/jobs/discover.js +51 -21
  293. package/dist/esm/operations/jobs/discover.js.map +1 -1
  294. package/dist/esm/operations/jobs/index.d.ts +14 -57
  295. package/dist/esm/operations/jobs/index.js +15 -59
  296. package/dist/esm/operations/jobs/index.js.map +1 -1
  297. package/dist/esm/operations/jobs/ocapi-mapping.d.ts +34 -0
  298. package/dist/esm/operations/jobs/ocapi-mapping.js +100 -0
  299. package/dist/esm/operations/jobs/ocapi-mapping.js.map +1 -0
  300. package/dist/esm/operations/jobs/run-system-job.d.ts +81 -0
  301. package/dist/esm/operations/jobs/run-system-job.js +137 -0
  302. package/dist/esm/operations/jobs/run-system-job.js.map +1 -0
  303. package/dist/esm/operations/jobs/run.js +16 -4
  304. package/dist/esm/operations/jobs/run.js.map +1 -1
  305. package/dist/esm/operations/jobs/scapi-ops.d.ts +61 -0
  306. package/dist/esm/operations/jobs/scapi-ops.js +214 -0
  307. package/dist/esm/operations/jobs/scapi-ops.js.map +1 -0
  308. package/dist/esm/operations/jobs/site-archive.js +28 -66
  309. package/dist/esm/operations/jobs/site-archive.js.map +1 -1
  310. package/dist/esm/operations/jobs/types.d.ts +46 -0
  311. package/dist/esm/operations/jobs/types.js +2 -0
  312. package/dist/esm/operations/jobs/types.js.map +1 -0
  313. package/dist/esm/operations/jobs/wait-canonical.d.ts +28 -0
  314. package/dist/esm/operations/jobs/wait-canonical.js +48 -0
  315. package/dist/esm/operations/jobs/wait-canonical.js.map +1 -0
  316. package/dist/esm/operations/mrt/bundle.d.ts +164 -2
  317. package/dist/esm/operations/mrt/bundle.js +315 -9
  318. package/dist/esm/operations/mrt/bundle.js.map +1 -1
  319. package/dist/esm/operations/mrt/deployment.d.ts +221 -0
  320. package/dist/esm/operations/mrt/deployment.js +239 -0
  321. package/dist/esm/operations/mrt/deployment.js.map +1 -1
  322. package/dist/esm/operations/mrt/index.d.ts +8 -6
  323. package/dist/esm/operations/mrt/index.js +5 -3
  324. package/dist/esm/operations/mrt/index.js.map +1 -1
  325. package/dist/esm/operations/mrt/mrt-backend.d.ts +117 -0
  326. package/dist/esm/operations/mrt/mrt-backend.js +84 -0
  327. package/dist/esm/operations/mrt/mrt-backend.js.map +1 -0
  328. package/dist/esm/operations/mrt/push.d.ts +83 -1
  329. package/dist/esm/operations/mrt/push.js +102 -1
  330. package/dist/esm/operations/mrt/push.js.map +1 -1
  331. package/dist/esm/operations/sites/cartridges.d.ts +10 -8
  332. package/dist/esm/operations/sites/cartridges.js +35 -67
  333. package/dist/esm/operations/sites/cartridges.js.map +1 -1
  334. package/dist/esm/operations/sites/index.d.ts +10 -6
  335. package/dist/esm/operations/sites/index.js +9 -6
  336. package/dist/esm/operations/sites/index.js.map +1 -1
  337. package/dist/esm/operations/sites/ocapi-sites-backend.d.ts +20 -0
  338. package/dist/esm/operations/sites/ocapi-sites-backend.js +98 -0
  339. package/dist/esm/operations/sites/ocapi-sites-backend.js.map +1 -0
  340. package/dist/esm/operations/sites/scapi-sites-backend.d.ts +33 -0
  341. package/dist/esm/operations/sites/scapi-sites-backend.js +166 -0
  342. package/dist/esm/operations/sites/scapi-sites-backend.js.map +1 -0
  343. package/dist/esm/operations/sites/sites-backend.d.ts +9 -0
  344. package/dist/esm/operations/sites/sites-backend.js +16 -0
  345. package/dist/esm/operations/sites/sites-backend.js.map +1 -0
  346. package/dist/esm/operations/sites/sites-scopes.d.ts +2 -0
  347. package/dist/esm/operations/sites/sites-scopes.js +16 -0
  348. package/dist/esm/operations/sites/sites-scopes.js.map +1 -0
  349. package/dist/esm/operations/sites/sites-types.d.ts +50 -0
  350. package/dist/esm/operations/sites/sites-types.js +2 -0
  351. package/dist/esm/operations/sites/sites-types.js.map +1 -0
  352. package/dist/esm/safety/safety-middleware.d.ts +7 -3
  353. package/dist/esm/safety/safety-middleware.js +13 -9
  354. package/dist/esm/safety/safety-middleware.js.map +1 -1
  355. package/dist/esm/scaffold/sources.js +6 -9
  356. package/dist/esm/scaffold/sources.js.map +1 -1
  357. package/dist/esm/scapi/auth-primitives.d.ts +3 -0
  358. package/dist/esm/scapi/auth-primitives.js +104 -0
  359. package/dist/esm/scapi/auth-primitives.js.map +1 -0
  360. package/dist/esm/scapi/authentication.d.ts +30 -0
  361. package/dist/esm/scapi/authentication.js +136 -0
  362. package/dist/esm/scapi/authentication.js.map +1 -0
  363. package/dist/esm/scapi/catalog.d.ts +29 -0
  364. package/dist/esm/scapi/catalog.js +81 -0
  365. package/dist/esm/scapi/catalog.js.map +1 -0
  366. package/dist/esm/scapi/index.d.ts +12 -0
  367. package/dist/esm/scapi/index.js +13 -0
  368. package/dist/esm/scapi/index.js.map +1 -0
  369. package/dist/esm/scapi/request.d.ts +15 -0
  370. package/dist/esm/scapi/request.js +239 -0
  371. package/dist/esm/scapi/request.js.map +1 -0
  372. package/dist/esm/scapi/runtime.d.ts +20 -0
  373. package/dist/esm/scapi/runtime.js +131 -0
  374. package/dist/esm/scapi/runtime.js.map +1 -0
  375. package/dist/esm/scapi/snippets.d.ts +22 -0
  376. package/dist/esm/scapi/snippets.js +140 -0
  377. package/dist/esm/scapi/snippets.js.map +1 -0
  378. package/dist/esm/scapi/worker-source.d.ts +2 -0
  379. package/dist/esm/scapi/worker-source.js +101 -0
  380. package/dist/esm/scapi/worker-source.js.map +1 -0
  381. package/dist/esm/search/ranking.d.ts +12 -0
  382. package/dist/esm/search/ranking.js +28 -0
  383. package/dist/esm/search/ranking.js.map +1 -0
  384. package/dist/esm/skills/sources.d.ts +2 -2
  385. package/dist/esm/skills/sources.js +10 -2
  386. package/dist/esm/skills/sources.js.map +1 -1
  387. package/dist/esm/skills/types.d.ts +1 -1
  388. package/dist/esm/slas/token.js +33 -94
  389. package/dist/esm/slas/token.js.map +1 -1
  390. package/dist/esm/slas/types.d.ts +5 -0
  391. package/node_modules/@salesforce/b2c-api-schemas/README.md +23 -0
  392. package/node_modules/@salesforce/b2c-api-schemas/manifest.json +576 -0
  393. package/node_modules/@salesforce/b2c-api-schemas/package.json +15 -0
  394. package/node_modules/@salesforce/b2c-api-schemas/scapi/cdn/zones/v1.json +11490 -0
  395. package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/orders/v1.json +3589 -0
  396. package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-baskets/v1.json +6544 -0
  397. package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-baskets/v2.json +7148 -0
  398. package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-orders/v1.json +4411 -0
  399. package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-payments/v1.json +643 -0
  400. package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/cors/v1.json +295 -0
  401. package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/preferences/v1.json +2036 -0
  402. package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/shopper-configurations/v1.json +327 -0
  403. package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/timeouts/v1.json +234 -0
  404. package/node_modules/@salesforce/b2c-api-schemas/scapi/custom-object/custom-objects/v1.json +1542 -0
  405. package/node_modules/@salesforce/b2c-api-schemas/scapi/custom-object/shopper-custom-objects/v1.json +405 -0
  406. package/node_modules/@salesforce/b2c-api-schemas/scapi/customer/customers/v1.json +2531 -0
  407. package/node_modules/@salesforce/b2c-api-schemas/scapi/customer/shopper-customers/v1.json +7944 -0
  408. package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/custom-apis/v1.json +292 -0
  409. package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/object-definitions/v1.json +2537 -0
  410. package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/scapi-schemas/v1.json +517 -0
  411. package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/scripts/v1.json +589 -0
  412. package/node_modules/@salesforce/b2c-api-schemas/scapi/experience/experiences/v1.json +3600 -0
  413. package/node_modules/@salesforce/b2c-api-schemas/scapi/experience/shopper-experience/v1.json +2319 -0
  414. package/node_modules/@salesforce/b2c-api-schemas/scapi/intelligence/analytics/v1.json +658 -0
  415. package/node_modules/@salesforce/b2c-api-schemas/scapi/inventory/availability/v1.json +2649 -0
  416. package/node_modules/@salesforce/b2c-api-schemas/scapi/inventory/impex/v1.json +6615 -0
  417. package/node_modules/@salesforce/b2c-api-schemas/scapi/inventory/reservation/v1.json +2103 -0
  418. package/node_modules/@salesforce/b2c-api-schemas/scapi/merchant/roles/v1.json +1760 -0
  419. package/node_modules/@salesforce/b2c-api-schemas/scapi/merchant/users/v1.json +640 -0
  420. package/node_modules/@salesforce/b2c-api-schemas/scapi/observability/metrics/v1.json +1263 -0
  421. package/node_modules/@salesforce/b2c-api-schemas/scapi/operation/jobs/v1.json +1259 -0
  422. package/node_modules/@salesforce/b2c-api-schemas/scapi/operation/replications/v1.json +760 -0
  423. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/assignments/v1.json +1047 -0
  424. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/campaigns/v1.json +1929 -0
  425. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/coupons/v1.json +1542 -0
  426. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/gift-certificates/v1.json +1093 -0
  427. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/promotions/v1.json +1324 -0
  428. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/shopper-gift-certificates/v1.json +325 -0
  429. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/shopper-promotions/v1.json +631 -0
  430. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/source-code-groups/v1.json +1036 -0
  431. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/catalogs/v1.json +5175 -0
  432. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/inventory-lists/v1.json +866 -0
  433. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/price-books/v1.json +747 -0
  434. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/products/v1.json +5076 -0
  435. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/shopper-availability/v1.json +509 -0
  436. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/shopper-delivery-estimates/v1.json +517 -0
  437. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/shopper-products/v1.json +2961 -0
  438. package/node_modules/@salesforce/b2c-api-schemas/scapi/search/shopper-search/v1.json +1889 -0
  439. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/auth/v1.json +7014 -0
  440. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/auth-admin/v1.json +1898 -0
  441. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/consents/v1.json +622 -0
  442. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/shopper-agents/v1.json +192 -0
  443. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/shopper-consents/v1.json +913 -0
  444. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/shopper-context/v1.json +630 -0
  445. package/node_modules/@salesforce/b2c-api-schemas/scapi/site/seo/v1.json +223 -0
  446. package/node_modules/@salesforce/b2c-api-schemas/scapi/site/shopper-seo/v1.json +423 -0
  447. package/node_modules/@salesforce/b2c-api-schemas/scapi/site/sites/v1.json +1088 -0
  448. package/node_modules/@salesforce/b2c-api-schemas/scapi/store/shopper-stores/v1.json +798 -0
  449. package/node_modules/@salesforce/b2c-api-schemas/scapi/store/store-redirect-mappings/v1.json +607 -0
  450. package/node_modules/@salesforce/b2c-api-schemas/scapi/store/stores/v1.json +1418 -0
  451. package/package.json +24 -3
  452. package/specs/dx-scripts-v1.yaml +409 -0
  453. package/specs/merchant-roles-v1.yaml +1085 -0
  454. package/specs/merchant-users-v1.yaml +398 -0
  455. package/specs/mrt-api-v1.json +105 -0
  456. package/specs/operations-jobs-v1.yaml +793 -0
  457. package/specs/product-catalogs-v1.yaml +111 -0
  458. package/specs/site-sites-v1.yaml +667 -0
  459. package/specs/slas-shopper-v1.yaml +83 -0
  460. package/specs/storefront-deployments-v1.yaml +630 -0
@@ -0,0 +1,2103 @@
1
+ {
2
+ "openapi": "3.0.3",
3
+ "info": {
4
+ "title": "Inventory Reservation",
5
+ "version": "1.1.23",
6
+ "x-api-type": "Admin",
7
+ "x-api-family": "Inventory"
8
+ },
9
+ "servers": [
10
+ {
11
+ "url": "https://{shortCode}.api.commercecloud.salesforce.com/inventory/reservation/v1",
12
+ "variables": {
13
+ "shortCode": {
14
+ "default": "shortCode"
15
+ }
16
+ }
17
+ }
18
+ ],
19
+ "paths": {
20
+ "/organizations/{organizationId}/reservation-documents/{reservationId}": {
21
+ "put": {
22
+ "operationId": "createReservations",
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": "reservationId",
36
+ "in": "path",
37
+ "required": true,
38
+ "style": "simple",
39
+ "explode": false,
40
+ "schema": {
41
+ "type": "string",
42
+ "maxLength": 36,
43
+ "pattern": "^[0-9a-fA-F\\-]{36}$"
44
+ }
45
+ }
46
+ ],
47
+ "requestBody": {
48
+ "content": {
49
+ "application/json": {
50
+ "schema": {
51
+ "$ref": "#/components/schemas/PlaceReservationRequest"
52
+ }
53
+ }
54
+ },
55
+ "required": true
56
+ },
57
+ "responses": {
58
+ "200": {
59
+ "description": "Successfully received and processed the request. The consumer is responsible for validating the returned data to ensure that the specified quantity was reserved as requested.",
60
+ "headers": {
61
+ "Location": {
62
+ "style": "simple",
63
+ "explode": false,
64
+ "schema": {
65
+ "type": "string",
66
+ "maxLength": 255
67
+ }
68
+ },
69
+ "X-RateLimit-Limit": {
70
+ "style": "simple",
71
+ "explode": false,
72
+ "schema": {
73
+ "type": "string"
74
+ }
75
+ },
76
+ "X-RateLimit-Remaining": {
77
+ "style": "simple",
78
+ "explode": false,
79
+ "schema": {
80
+ "type": "string"
81
+ }
82
+ },
83
+ "X-RateLimit-Reset": {
84
+ "style": "simple",
85
+ "explode": false,
86
+ "schema": {
87
+ "type": "string"
88
+ }
89
+ }
90
+ },
91
+ "content": {
92
+ "application/json": {
93
+ "schema": {
94
+ "$ref": "#/components/schemas/PlaceReservationResponseBody"
95
+ }
96
+ }
97
+ }
98
+ },
99
+ "400": {
100
+ "description": "Invalid request.",
101
+ "headers": {
102
+ "X-RateLimit-Limit": {
103
+ "style": "simple",
104
+ "explode": false,
105
+ "schema": {
106
+ "type": "string"
107
+ }
108
+ },
109
+ "X-RateLimit-Remaining": {
110
+ "style": "simple",
111
+ "explode": false,
112
+ "schema": {
113
+ "type": "string"
114
+ }
115
+ },
116
+ "X-RateLimit-Reset": {
117
+ "style": "simple",
118
+ "explode": false,
119
+ "schema": {
120
+ "type": "string"
121
+ }
122
+ }
123
+ },
124
+ "content": {
125
+ "application/problem+json": {
126
+ "schema": {
127
+ "$ref": "#/components/schemas/InvalidRequestLocOrGroupDoesNotExist"
128
+ }
129
+ }
130
+ }
131
+ },
132
+ "403": {
133
+ "description": "Organization not authorized.",
134
+ "content": {
135
+ "application/problem+json": {
136
+ "schema": {
137
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
138
+ }
139
+ }
140
+ }
141
+ },
142
+ "409": {
143
+ "description": "A reservation with the specified ID is in an invalid state.",
144
+ "headers": {
145
+ "X-RateLimit-Limit": {
146
+ "style": "simple",
147
+ "explode": false,
148
+ "schema": {
149
+ "type": "string"
150
+ }
151
+ },
152
+ "X-RateLimit-Remaining": {
153
+ "style": "simple",
154
+ "explode": false,
155
+ "schema": {
156
+ "type": "string"
157
+ }
158
+ },
159
+ "X-RateLimit-Reset": {
160
+ "style": "simple",
161
+ "explode": false,
162
+ "schema": {
163
+ "type": "string"
164
+ }
165
+ }
166
+ },
167
+ "content": {
168
+ "application/problem+json": {
169
+ "schema": {
170
+ "$ref": "#/components/schemas/ReservationInvalidState"
171
+ }
172
+ }
173
+ }
174
+ },
175
+ "429": {
176
+ "description": "The user has sent too many requests in a given amount of time (\"rate limiting\")",
177
+ "headers": {
178
+ "Retry-After": {
179
+ "style": "simple",
180
+ "explode": false,
181
+ "schema": {
182
+ "type": "string"
183
+ }
184
+ }
185
+ },
186
+ "content": {
187
+ "application/problem+json": {
188
+ "schema": {
189
+ "properties": {
190
+ "title": {
191
+ "type": "string"
192
+ },
193
+ "type": {
194
+ "type": "string"
195
+ },
196
+ "detail": {
197
+ "type": "string"
198
+ },
199
+ "instance": {
200
+ "type": "string"
201
+ }
202
+ },
203
+ "required": [
204
+ "type"
205
+ ]
206
+ }
207
+ }
208
+ }
209
+ }
210
+ },
211
+ "security": [
212
+ {
213
+ "AmOAuth2": [
214
+ "sfcc.inventory.reservations.rw",
215
+ "sfcc_inventory_reservations_rw"
216
+ ]
217
+ }
218
+ ]
219
+ },
220
+ "patch": {
221
+ "operationId": "updateReservation",
222
+ "parameters": [
223
+ {
224
+ "name": "organizationId",
225
+ "in": "path",
226
+ "required": true,
227
+ "style": "simple",
228
+ "explode": false,
229
+ "schema": {
230
+ "$ref": "#/components/schemas/OrganizationId"
231
+ }
232
+ },
233
+ {
234
+ "name": "reservationId",
235
+ "in": "path",
236
+ "required": true,
237
+ "style": "simple",
238
+ "explode": false,
239
+ "schema": {
240
+ "type": "string",
241
+ "maxLength": 36,
242
+ "pattern": "^[0-9a-fA-F\\-]{36}$"
243
+ }
244
+ }
245
+ ],
246
+ "requestBody": {
247
+ "content": {
248
+ "application/json": {
249
+ "schema": {
250
+ "$ref": "#/components/schemas/UpdateReservationRequestBody"
251
+ }
252
+ }
253
+ },
254
+ "required": true
255
+ },
256
+ "responses": {
257
+ "200": {
258
+ "description": "Reservation update request was received and processed successfully.",
259
+ "headers": {
260
+ "X-RateLimit-Limit": {
261
+ "style": "simple",
262
+ "explode": false,
263
+ "schema": {
264
+ "type": "string"
265
+ }
266
+ },
267
+ "X-RateLimit-Remaining": {
268
+ "style": "simple",
269
+ "explode": false,
270
+ "schema": {
271
+ "type": "string"
272
+ }
273
+ },
274
+ "X-RateLimit-Reset": {
275
+ "style": "simple",
276
+ "explode": false,
277
+ "schema": {
278
+ "type": "string"
279
+ }
280
+ }
281
+ },
282
+ "content": {
283
+ "application/json": {
284
+ "schema": {
285
+ "$ref": "#/components/schemas/UpdateReservationResponse"
286
+ }
287
+ }
288
+ }
289
+ },
290
+ "202": {
291
+ "description": "Reservation marked as cancelled. Inventory levels updated asynchronously.",
292
+ "headers": {
293
+ "X-RateLimit-Limit": {
294
+ "style": "simple",
295
+ "explode": false,
296
+ "schema": {
297
+ "type": "string"
298
+ }
299
+ },
300
+ "X-RateLimit-Remaining": {
301
+ "style": "simple",
302
+ "explode": false,
303
+ "schema": {
304
+ "type": "string"
305
+ }
306
+ },
307
+ "X-RateLimit-Reset": {
308
+ "style": "simple",
309
+ "explode": false,
310
+ "schema": {
311
+ "type": "string"
312
+ }
313
+ }
314
+ }
315
+ },
316
+ "204": {
317
+ "description": "Reservation cancelled successfully.",
318
+ "headers": {
319
+ "X-RateLimit-Limit": {
320
+ "style": "simple",
321
+ "explode": false,
322
+ "schema": {
323
+ "type": "string"
324
+ }
325
+ },
326
+ "X-RateLimit-Remaining": {
327
+ "style": "simple",
328
+ "explode": false,
329
+ "schema": {
330
+ "type": "string"
331
+ }
332
+ },
333
+ "X-RateLimit-Reset": {
334
+ "style": "simple",
335
+ "explode": false,
336
+ "schema": {
337
+ "type": "string"
338
+ }
339
+ }
340
+ }
341
+ },
342
+ "400": {
343
+ "description": "Invalid request.",
344
+ "headers": {
345
+ "X-RateLimit-Limit": {
346
+ "style": "simple",
347
+ "explode": false,
348
+ "schema": {
349
+ "type": "string"
350
+ }
351
+ },
352
+ "X-RateLimit-Remaining": {
353
+ "style": "simple",
354
+ "explode": false,
355
+ "schema": {
356
+ "type": "string"
357
+ }
358
+ },
359
+ "X-RateLimit-Reset": {
360
+ "style": "simple",
361
+ "explode": false,
362
+ "schema": {
363
+ "type": "string"
364
+ }
365
+ }
366
+ },
367
+ "content": {
368
+ "application/problem+json": {
369
+ "schema": {
370
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
371
+ }
372
+ }
373
+ }
374
+ },
375
+ "403": {
376
+ "description": "Organization not authorized.",
377
+ "content": {
378
+ "application/problem+json": {
379
+ "schema": {
380
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
381
+ }
382
+ }
383
+ }
384
+ },
385
+ "404": {
386
+ "description": "Entity not found.",
387
+ "headers": {
388
+ "X-RateLimit-Limit": {
389
+ "style": "simple",
390
+ "explode": false,
391
+ "schema": {
392
+ "type": "string"
393
+ }
394
+ },
395
+ "X-RateLimit-Remaining": {
396
+ "style": "simple",
397
+ "explode": false,
398
+ "schema": {
399
+ "type": "string"
400
+ }
401
+ },
402
+ "X-RateLimit-Reset": {
403
+ "style": "simple",
404
+ "explode": false,
405
+ "schema": {
406
+ "type": "string"
407
+ }
408
+ }
409
+ },
410
+ "content": {
411
+ "application/problem+json": {
412
+ "schema": {
413
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
414
+ }
415
+ }
416
+ }
417
+ },
418
+ "409": {
419
+ "description": "A reservation with the specified ID is in an invalid state.",
420
+ "headers": {
421
+ "X-RateLimit-Limit": {
422
+ "style": "simple",
423
+ "explode": false,
424
+ "schema": {
425
+ "type": "string"
426
+ }
427
+ },
428
+ "X-RateLimit-Remaining": {
429
+ "style": "simple",
430
+ "explode": false,
431
+ "schema": {
432
+ "type": "string"
433
+ }
434
+ },
435
+ "X-RateLimit-Reset": {
436
+ "style": "simple",
437
+ "explode": false,
438
+ "schema": {
439
+ "type": "string"
440
+ }
441
+ }
442
+ },
443
+ "content": {
444
+ "application/problem+json": {
445
+ "schema": {
446
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
447
+ }
448
+ }
449
+ }
450
+ },
451
+ "429": {
452
+ "description": "The user has sent too many requests in a given amount of time (\"rate limiting\")",
453
+ "headers": {
454
+ "Retry-After": {
455
+ "style": "simple",
456
+ "explode": false,
457
+ "schema": {
458
+ "type": "string"
459
+ }
460
+ }
461
+ },
462
+ "content": {
463
+ "application/problem+json": {
464
+ "schema": {
465
+ "properties": {
466
+ "title": {
467
+ "type": "string"
468
+ },
469
+ "type": {
470
+ "type": "string"
471
+ },
472
+ "detail": {
473
+ "type": "string"
474
+ },
475
+ "instance": {
476
+ "type": "string"
477
+ }
478
+ },
479
+ "required": [
480
+ "type"
481
+ ]
482
+ }
483
+ }
484
+ }
485
+ }
486
+ },
487
+ "security": [
488
+ {
489
+ "AmOAuth2": [
490
+ "sfcc.inventory.reservations.rw",
491
+ "sfcc_inventory_reservations_rw"
492
+ ]
493
+ }
494
+ ]
495
+ }
496
+ },
497
+ "/organizations/{organizationId}/transfers": {
498
+ "post": {
499
+ "operationId": "moveReservationQuantity",
500
+ "parameters": [
501
+ {
502
+ "name": "organizationId",
503
+ "in": "path",
504
+ "required": true,
505
+ "style": "simple",
506
+ "explode": false,
507
+ "schema": {
508
+ "$ref": "#/components/schemas/OrganizationId"
509
+ }
510
+ }
511
+ ],
512
+ "requestBody": {
513
+ "content": {
514
+ "application/json": {
515
+ "schema": {
516
+ "$ref": "#/components/schemas/MoveReservationBatchPostBody"
517
+ }
518
+ }
519
+ },
520
+ "required": true
521
+ },
522
+ "responses": {
523
+ "200": {
524
+ "description": "Batch reservation transfer partially succeeded with errors reported.",
525
+ "headers": {
526
+ "X-RateLimit-Limit": {
527
+ "style": "simple",
528
+ "explode": false,
529
+ "schema": {
530
+ "type": "string"
531
+ }
532
+ },
533
+ "X-RateLimit-Remaining": {
534
+ "style": "simple",
535
+ "explode": false,
536
+ "schema": {
537
+ "type": "string"
538
+ }
539
+ },
540
+ "X-RateLimit-Reset": {
541
+ "style": "simple",
542
+ "explode": false,
543
+ "schema": {
544
+ "type": "string"
545
+ }
546
+ }
547
+ },
548
+ "content": {
549
+ "application/json": {
550
+ "schema": {
551
+ "$ref": "#/components/schemas/MoveReservationErrorsResponse"
552
+ }
553
+ }
554
+ }
555
+ },
556
+ "204": {
557
+ "description": "Reservation quantities moved successfully.",
558
+ "headers": {
559
+ "X-RateLimit-Limit": {
560
+ "style": "simple",
561
+ "explode": false,
562
+ "schema": {
563
+ "type": "string"
564
+ }
565
+ },
566
+ "X-RateLimit-Remaining": {
567
+ "style": "simple",
568
+ "explode": false,
569
+ "schema": {
570
+ "type": "string"
571
+ }
572
+ },
573
+ "X-RateLimit-Reset": {
574
+ "style": "simple",
575
+ "explode": false,
576
+ "schema": {
577
+ "type": "string"
578
+ }
579
+ }
580
+ }
581
+ },
582
+ "400": {
583
+ "description": "Invalid request.",
584
+ "headers": {
585
+ "X-RateLimit-Limit": {
586
+ "style": "simple",
587
+ "explode": false,
588
+ "schema": {
589
+ "type": "string"
590
+ }
591
+ },
592
+ "X-RateLimit-Remaining": {
593
+ "style": "simple",
594
+ "explode": false,
595
+ "schema": {
596
+ "type": "string"
597
+ }
598
+ },
599
+ "X-RateLimit-Reset": {
600
+ "style": "simple",
601
+ "explode": false,
602
+ "schema": {
603
+ "type": "string"
604
+ }
605
+ }
606
+ },
607
+ "content": {
608
+ "application/problem+json": {
609
+ "schema": {
610
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
611
+ }
612
+ }
613
+ }
614
+ },
615
+ "403": {
616
+ "description": "Organization not authorized.",
617
+ "content": {
618
+ "application/problem+json": {
619
+ "schema": {
620
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
621
+ }
622
+ }
623
+ }
624
+ },
625
+ "429": {
626
+ "description": "The user has sent too many requests in a given amount of time (\"rate limiting\")",
627
+ "headers": {
628
+ "Retry-After": {
629
+ "style": "simple",
630
+ "explode": false,
631
+ "schema": {
632
+ "type": "string"
633
+ }
634
+ }
635
+ },
636
+ "content": {
637
+ "application/problem+json": {
638
+ "schema": {
639
+ "properties": {
640
+ "title": {
641
+ "type": "string"
642
+ },
643
+ "type": {
644
+ "type": "string"
645
+ },
646
+ "detail": {
647
+ "type": "string"
648
+ },
649
+ "instance": {
650
+ "type": "string"
651
+ }
652
+ },
653
+ "required": [
654
+ "type"
655
+ ]
656
+ }
657
+ }
658
+ }
659
+ }
660
+ },
661
+ "security": [
662
+ {
663
+ "AmOAuth2": [
664
+ "sfcc.inventory.reservations.rw",
665
+ "sfcc_inventory_reservations_rw"
666
+ ]
667
+ }
668
+ ]
669
+ }
670
+ },
671
+ "/organizations/{organizationId}/releases": {
672
+ "post": {
673
+ "operationId": "unreserveReservations",
674
+ "parameters": [
675
+ {
676
+ "name": "organizationId",
677
+ "in": "path",
678
+ "required": true,
679
+ "style": "simple",
680
+ "explode": false,
681
+ "schema": {
682
+ "$ref": "#/components/schemas/OrganizationId"
683
+ }
684
+ }
685
+ ],
686
+ "requestBody": {
687
+ "content": {
688
+ "application/json": {
689
+ "schema": {
690
+ "$ref": "#/components/schemas/UnreserveRequestBody"
691
+ }
692
+ }
693
+ },
694
+ "required": true
695
+ },
696
+ "responses": {
697
+ "200": {
698
+ "description": "The request was received and processed successfully. The consumer is responsible for validating the returned data to ensure that the specified quantity was released as requested.",
699
+ "headers": {
700
+ "X-RateLimit-Limit": {
701
+ "style": "simple",
702
+ "explode": false,
703
+ "schema": {
704
+ "type": "string"
705
+ }
706
+ },
707
+ "X-RateLimit-Remaining": {
708
+ "style": "simple",
709
+ "explode": false,
710
+ "schema": {
711
+ "type": "string"
712
+ }
713
+ },
714
+ "X-RateLimit-Reset": {
715
+ "style": "simple",
716
+ "explode": false,
717
+ "schema": {
718
+ "type": "string"
719
+ }
720
+ }
721
+ },
722
+ "content": {
723
+ "application/json": {
724
+ "schema": {
725
+ "$ref": "#/components/schemas/UnreserveResponseBody"
726
+ }
727
+ }
728
+ }
729
+ },
730
+ "204": {
731
+ "description": "Reservations for specified items removed successfully.",
732
+ "headers": {
733
+ "X-RateLimit-Limit": {
734
+ "style": "simple",
735
+ "explode": false,
736
+ "schema": {
737
+ "type": "string"
738
+ }
739
+ },
740
+ "X-RateLimit-Remaining": {
741
+ "style": "simple",
742
+ "explode": false,
743
+ "schema": {
744
+ "type": "string"
745
+ }
746
+ },
747
+ "X-RateLimit-Reset": {
748
+ "style": "simple",
749
+ "explode": false,
750
+ "schema": {
751
+ "type": "string"
752
+ }
753
+ }
754
+ }
755
+ },
756
+ "400": {
757
+ "description": "Invalid request.",
758
+ "headers": {
759
+ "X-RateLimit-Limit": {
760
+ "style": "simple",
761
+ "explode": false,
762
+ "schema": {
763
+ "type": "string"
764
+ }
765
+ },
766
+ "X-RateLimit-Remaining": {
767
+ "style": "simple",
768
+ "explode": false,
769
+ "schema": {
770
+ "type": "string"
771
+ }
772
+ },
773
+ "X-RateLimit-Reset": {
774
+ "style": "simple",
775
+ "explode": false,
776
+ "schema": {
777
+ "type": "string"
778
+ }
779
+ }
780
+ },
781
+ "content": {
782
+ "application/problem+json": {
783
+ "schema": {
784
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
785
+ }
786
+ }
787
+ }
788
+ },
789
+ "403": {
790
+ "description": "Organization not authorized.",
791
+ "content": {
792
+ "application/problem+json": {
793
+ "schema": {
794
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
795
+ }
796
+ }
797
+ }
798
+ },
799
+ "429": {
800
+ "description": "The user has sent too many requests in a given amount of time (\"rate limiting\")",
801
+ "headers": {
802
+ "Retry-After": {
803
+ "style": "simple",
804
+ "explode": false,
805
+ "schema": {
806
+ "type": "string"
807
+ }
808
+ }
809
+ },
810
+ "content": {
811
+ "application/problem+json": {
812
+ "schema": {
813
+ "properties": {
814
+ "title": {
815
+ "type": "string"
816
+ },
817
+ "type": {
818
+ "type": "string"
819
+ },
820
+ "detail": {
821
+ "type": "string"
822
+ },
823
+ "instance": {
824
+ "type": "string"
825
+ }
826
+ },
827
+ "required": [
828
+ "type"
829
+ ]
830
+ }
831
+ }
832
+ }
833
+ }
834
+ },
835
+ "security": [
836
+ {
837
+ "AmOAuth2": [
838
+ "sfcc.inventory.reservations.rw",
839
+ "sfcc_inventory_reservations_rw"
840
+ ]
841
+ }
842
+ ]
843
+ }
844
+ },
845
+ "/organizations/{organizationId}/fulfillments": {
846
+ "post": {
847
+ "operationId": "fulfillQuantity",
848
+ "parameters": [
849
+ {
850
+ "name": "organizationId",
851
+ "in": "path",
852
+ "required": true,
853
+ "style": "simple",
854
+ "explode": false,
855
+ "schema": {
856
+ "$ref": "#/components/schemas/OrganizationId"
857
+ }
858
+ }
859
+ ],
860
+ "requestBody": {
861
+ "content": {
862
+ "application/json": {
863
+ "schema": {
864
+ "$ref": "#/components/schemas/FulfillQuantityRequestBody"
865
+ }
866
+ }
867
+ },
868
+ "required": true
869
+ },
870
+ "responses": {
871
+ "200": {
872
+ "description": "Fulfillment partially succeeded with errors reported.",
873
+ "headers": {
874
+ "X-RateLimit-Limit": {
875
+ "style": "simple",
876
+ "explode": false,
877
+ "schema": {
878
+ "type": "string"
879
+ }
880
+ },
881
+ "X-RateLimit-Remaining": {
882
+ "style": "simple",
883
+ "explode": false,
884
+ "schema": {
885
+ "type": "string"
886
+ }
887
+ },
888
+ "X-RateLimit-Reset": {
889
+ "style": "simple",
890
+ "explode": false,
891
+ "schema": {
892
+ "type": "string"
893
+ }
894
+ }
895
+ },
896
+ "content": {
897
+ "application/json": {
898
+ "schema": {
899
+ "$ref": "#/components/schemas/FulfillQuantityResponseErrors"
900
+ }
901
+ }
902
+ }
903
+ },
904
+ "204": {
905
+ "description": "Quantity adjusted successfully.",
906
+ "headers": {
907
+ "X-RateLimit-Limit": {
908
+ "style": "simple",
909
+ "explode": false,
910
+ "schema": {
911
+ "type": "string"
912
+ }
913
+ },
914
+ "X-RateLimit-Remaining": {
915
+ "style": "simple",
916
+ "explode": false,
917
+ "schema": {
918
+ "type": "string"
919
+ }
920
+ },
921
+ "X-RateLimit-Reset": {
922
+ "style": "simple",
923
+ "explode": false,
924
+ "schema": {
925
+ "type": "string"
926
+ }
927
+ }
928
+ }
929
+ },
930
+ "400": {
931
+ "description": "Invalid request.",
932
+ "headers": {
933
+ "X-RateLimit-Limit": {
934
+ "style": "simple",
935
+ "explode": false,
936
+ "schema": {
937
+ "type": "string"
938
+ }
939
+ },
940
+ "X-RateLimit-Remaining": {
941
+ "style": "simple",
942
+ "explode": false,
943
+ "schema": {
944
+ "type": "string"
945
+ }
946
+ },
947
+ "X-RateLimit-Reset": {
948
+ "style": "simple",
949
+ "explode": false,
950
+ "schema": {
951
+ "type": "string"
952
+ }
953
+ }
954
+ },
955
+ "content": {
956
+ "application/problem+json": {
957
+ "schema": {
958
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
959
+ }
960
+ }
961
+ }
962
+ },
963
+ "403": {
964
+ "description": "Organization not authorized.",
965
+ "content": {
966
+ "application/problem+json": {
967
+ "schema": {
968
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
969
+ }
970
+ }
971
+ }
972
+ },
973
+ "409": {
974
+ "description": "Reservation ID invalid.",
975
+ "headers": {
976
+ "X-RateLimit-Limit": {
977
+ "style": "simple",
978
+ "explode": false,
979
+ "schema": {
980
+ "type": "string"
981
+ }
982
+ },
983
+ "X-RateLimit-Remaining": {
984
+ "style": "simple",
985
+ "explode": false,
986
+ "schema": {
987
+ "type": "string"
988
+ }
989
+ },
990
+ "X-RateLimit-Reset": {
991
+ "style": "simple",
992
+ "explode": false,
993
+ "schema": {
994
+ "type": "string"
995
+ }
996
+ }
997
+ },
998
+ "content": {
999
+ "application/json": {
1000
+ "schema": {
1001
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
1002
+ }
1003
+ }
1004
+ }
1005
+ },
1006
+ "429": {
1007
+ "description": "The user has sent too many requests in a given amount of time (\"rate limiting\")",
1008
+ "headers": {
1009
+ "Retry-After": {
1010
+ "style": "simple",
1011
+ "explode": false,
1012
+ "schema": {
1013
+ "type": "string"
1014
+ }
1015
+ }
1016
+ },
1017
+ "content": {
1018
+ "application/problem+json": {
1019
+ "schema": {
1020
+ "properties": {
1021
+ "title": {
1022
+ "type": "string"
1023
+ },
1024
+ "type": {
1025
+ "type": "string"
1026
+ },
1027
+ "detail": {
1028
+ "type": "string"
1029
+ },
1030
+ "instance": {
1031
+ "type": "string"
1032
+ }
1033
+ },
1034
+ "required": [
1035
+ "type"
1036
+ ]
1037
+ }
1038
+ }
1039
+ }
1040
+ }
1041
+ },
1042
+ "security": [
1043
+ {
1044
+ "AmOAuth2": [
1045
+ "sfcc.inventory.reservations.rw",
1046
+ "sfcc_inventory_reservations_rw"
1047
+ ]
1048
+ }
1049
+ ]
1050
+ }
1051
+ }
1052
+ },
1053
+ "components": {
1054
+ "schemas": {
1055
+ "OrganizationId": {
1056
+ "type": "string",
1057
+ "maxLength": 32,
1058
+ "minLength": 1
1059
+ },
1060
+ "ExternalRefId": {
1061
+ "type": "string",
1062
+ "maxLength": 128,
1063
+ "pattern": "^[a-zA-Z0-9\\-]*$"
1064
+ },
1065
+ "ExpirationSeconds": {
1066
+ "type": "integer",
1067
+ "maximum": 14400,
1068
+ "minimum": 1
1069
+ },
1070
+ "AllowPartialReservations": {
1071
+ "type": "boolean"
1072
+ },
1073
+ "FulfillOnlyReservations": {
1074
+ "type": "boolean"
1075
+ },
1076
+ "ReservationTime": {
1077
+ "type": "string",
1078
+ "format": "date-time",
1079
+ "maxLength": 30
1080
+ },
1081
+ "GroupId": {
1082
+ "type": "string",
1083
+ "maxLength": 128,
1084
+ "minLength": 2,
1085
+ "pattern": "^[a-zA-Z0-9-_]*$"
1086
+ },
1087
+ "SkuId": {
1088
+ "type": "string",
1089
+ "maxLength": 250,
1090
+ "minLength": 1,
1091
+ "pattern": "^[^\\\\<>;%/\\s]*$"
1092
+ },
1093
+ "ReservedQuantity": {
1094
+ "type": "number",
1095
+ "format": "double",
1096
+ "minimum": 0.001,
1097
+ "multipleOf": 0.001
1098
+ },
1099
+ "ReservationRequestRecord": {
1100
+ "type": "object",
1101
+ "properties": {
1102
+ "sku": {
1103
+ "$ref": "#/components/schemas/SkuId"
1104
+ },
1105
+ "quantity": {
1106
+ "$ref": "#/components/schemas/ReservedQuantity"
1107
+ }
1108
+ },
1109
+ "required": [
1110
+ "quantity",
1111
+ "sku"
1112
+ ]
1113
+ },
1114
+ "ReservationRequestGroup": {
1115
+ "type": "object",
1116
+ "properties": {
1117
+ "id": {
1118
+ "$ref": "#/components/schemas/GroupId"
1119
+ },
1120
+ "reservations": {
1121
+ "type": "array",
1122
+ "items": {
1123
+ "$ref": "#/components/schemas/ReservationRequestRecord"
1124
+ }
1125
+ }
1126
+ },
1127
+ "required": [
1128
+ "id",
1129
+ "reservations"
1130
+ ]
1131
+ },
1132
+ "LocationId": {
1133
+ "type": "string",
1134
+ "maxLength": 128,
1135
+ "minLength": 2,
1136
+ "pattern": "^[a-zA-Z0-9-_]*$"
1137
+ },
1138
+ "AllOrNothingId": {
1139
+ "type": "string",
1140
+ "maxLength": 128,
1141
+ "minLength": 1,
1142
+ "pattern": "^[a-zA-Z0-9-_]*$"
1143
+ },
1144
+ "ReservationRequestLocation": {
1145
+ "type": "object",
1146
+ "properties": {
1147
+ "id": {
1148
+ "$ref": "#/components/schemas/LocationId"
1149
+ },
1150
+ "reservations": {
1151
+ "type": "array",
1152
+ "items": {
1153
+ "$ref": "#/components/schemas/ReservationRequestRecord"
1154
+ }
1155
+ },
1156
+ "allOrNothingReservations": {
1157
+ "type": "array",
1158
+ "items": {
1159
+ "type": "object",
1160
+ "properties": {
1161
+ "id": {
1162
+ "$ref": "#/components/schemas/AllOrNothingId"
1163
+ },
1164
+ "reservations": {
1165
+ "type": "array",
1166
+ "items": {
1167
+ "$ref": "#/components/schemas/ReservationRequestRecord"
1168
+ }
1169
+ }
1170
+ },
1171
+ "required": [
1172
+ "id",
1173
+ "reservations"
1174
+ ]
1175
+ }
1176
+ }
1177
+ },
1178
+ "required": [
1179
+ "id",
1180
+ "reservations"
1181
+ ]
1182
+ },
1183
+ "PlaceReservationRequest": {
1184
+ "type": "object",
1185
+ "additionalProperties": false,
1186
+ "properties": {
1187
+ "externalRefId": {
1188
+ "$ref": "#/components/schemas/ExternalRefId"
1189
+ },
1190
+ "expirationSeconds": {
1191
+ "$ref": "#/components/schemas/ExpirationSeconds"
1192
+ },
1193
+ "allowPartialReservations": {
1194
+ "$ref": "#/components/schemas/AllowPartialReservations"
1195
+ },
1196
+ "fulfillOnly": {
1197
+ "$ref": "#/components/schemas/FulfillOnlyReservations"
1198
+ },
1199
+ "reservationTime": {
1200
+ "$ref": "#/components/schemas/ReservationTime"
1201
+ },
1202
+ "groups": {
1203
+ "type": "array",
1204
+ "items": {
1205
+ "$ref": "#/components/schemas/ReservationRequestGroup"
1206
+ }
1207
+ },
1208
+ "locations": {
1209
+ "type": "array",
1210
+ "items": {
1211
+ "$ref": "#/components/schemas/ReservationRequestLocation"
1212
+ }
1213
+ }
1214
+ }
1215
+ },
1216
+ "ExpirationTime": {
1217
+ "type": "string",
1218
+ "format": "date-time",
1219
+ "maxLength": 30
1220
+ },
1221
+ "ErrorCode": {
1222
+ "type": "string",
1223
+ "enum": [
1224
+ "InsufficientQuantity",
1225
+ "Unknown"
1226
+ ],
1227
+ "maxLength": 128,
1228
+ "pattern": "^[a-zA-Z0-9\\-]*$"
1229
+ },
1230
+ "ReservationResponseErrorRecord2": {
1231
+ "maxLength": 250,
1232
+ "properties": {
1233
+ "sku": {
1234
+ "$ref": "#/components/schemas/SkuId"
1235
+ },
1236
+ "errorCode": {
1237
+ "$ref": "#/components/schemas/ErrorCode"
1238
+ }
1239
+ },
1240
+ "required": [
1241
+ "errorCode",
1242
+ "sku"
1243
+ ]
1244
+ },
1245
+ "ReservedReservationRecord": {
1246
+ "type": "object",
1247
+ "properties": {
1248
+ "sku": {
1249
+ "$ref": "#/components/schemas/SkuId"
1250
+ },
1251
+ "quantity": {
1252
+ "$ref": "#/components/schemas/ReservedQuantity"
1253
+ }
1254
+ },
1255
+ "required": [
1256
+ "quantity",
1257
+ "sku"
1258
+ ]
1259
+ },
1260
+ "PlaceReservationResponseBody": {
1261
+ "type": "object",
1262
+ "properties": {
1263
+ "reservationTime": {
1264
+ "type": "string",
1265
+ "format": "date-time",
1266
+ "maxLength": 30
1267
+ },
1268
+ "expirationTime": {
1269
+ "$ref": "#/components/schemas/ExpirationTime"
1270
+ },
1271
+ "success": {
1272
+ "type": "boolean"
1273
+ },
1274
+ "groups": {
1275
+ "type": "array",
1276
+ "items": {
1277
+ "type": "object",
1278
+ "properties": {
1279
+ "id": {
1280
+ "$ref": "#/components/schemas/GroupId"
1281
+ },
1282
+ "errors": {
1283
+ "type": "array",
1284
+ "items": {
1285
+ "$ref": "#/components/schemas/ReservationResponseErrorRecord2"
1286
+ }
1287
+ },
1288
+ "details": {
1289
+ "type": "array",
1290
+ "items": {
1291
+ "$ref": "#/components/schemas/ReservedReservationRecord"
1292
+ }
1293
+ }
1294
+ },
1295
+ "required": [
1296
+ "id"
1297
+ ]
1298
+ }
1299
+ },
1300
+ "locations": {
1301
+ "type": "array",
1302
+ "items": {
1303
+ "type": "object",
1304
+ "properties": {
1305
+ "id": {
1306
+ "$ref": "#/components/schemas/LocationId"
1307
+ },
1308
+ "errors": {
1309
+ "type": "array",
1310
+ "items": {
1311
+ "$ref": "#/components/schemas/ReservationResponseErrorRecord2"
1312
+ }
1313
+ },
1314
+ "details": {
1315
+ "type": "array",
1316
+ "items": {
1317
+ "$ref": "#/components/schemas/ReservedReservationRecord"
1318
+ }
1319
+ }
1320
+ },
1321
+ "required": [
1322
+ "id"
1323
+ ]
1324
+ }
1325
+ }
1326
+ },
1327
+ "required": [
1328
+ "reservationTime",
1329
+ "success"
1330
+ ]
1331
+ },
1332
+ "InvalidRequestLocOrGroupDoesNotExistEnum": {
1333
+ "type": "string",
1334
+ "enum": [
1335
+ "InvalidRequest",
1336
+ "LocationDoesNotExist",
1337
+ "GroupDoesNotExist"
1338
+ ]
1339
+ },
1340
+ "InvalidRequestLocOrGroupDoesNotExist": {
1341
+ "type": "object",
1342
+ "properties": {
1343
+ "errorCode": {
1344
+ "$ref": "#/components/schemas/InvalidRequestLocOrGroupDoesNotExistEnum"
1345
+ },
1346
+ "message": {
1347
+ "type": "string",
1348
+ "maxLength": 250
1349
+ },
1350
+ "type": {
1351
+ "type": "string",
1352
+ "maxLength": 250
1353
+ },
1354
+ "parameterName": {
1355
+ "type": "string",
1356
+ "maxLength": 250
1357
+ },
1358
+ "group": {
1359
+ "type": "string",
1360
+ "maxLength": 250
1361
+ },
1362
+ "location": {
1363
+ "type": "string",
1364
+ "maxLength": 250
1365
+ }
1366
+ },
1367
+ "required": [
1368
+ "errorCode",
1369
+ "message",
1370
+ "type"
1371
+ ]
1372
+ },
1373
+ "InventoryResponseErrorSchema": {
1374
+ "type": "object",
1375
+ "properties": {
1376
+ "errorCode": {
1377
+ "type": "string",
1378
+ "maxLength": 32
1379
+ },
1380
+ "message": {
1381
+ "type": "string",
1382
+ "maxLength": 250
1383
+ },
1384
+ "type": {
1385
+ "type": "string",
1386
+ "maxLength": 250
1387
+ },
1388
+ "parameterName": {
1389
+ "type": "string",
1390
+ "maxLength": 250
1391
+ }
1392
+ },
1393
+ "required": [
1394
+ "errorCode",
1395
+ "message",
1396
+ "type"
1397
+ ]
1398
+ },
1399
+ "ReservationInvalidState": {
1400
+ "maxLength": 1,
1401
+ "properties": {
1402
+ "errorCode": {
1403
+ "type": "string",
1404
+ "enum": [
1405
+ "ReservationInvalidState",
1406
+ "ReservationAlreadyFinalized",
1407
+ "ReservationCancelled",
1408
+ "ReservationOperationInProcess",
1409
+ "EntityExists",
1410
+ "ConcurrentModification",
1411
+ "PreviousRequestAborted",
1412
+ "PreviousRequestCancelled"
1413
+ ],
1414
+ "maxLength": 32
1415
+ },
1416
+ "message": {
1417
+ "type": "string",
1418
+ "maxLength": 250
1419
+ },
1420
+ "type": {
1421
+ "type": "string",
1422
+ "maxLength": 250
1423
+ },
1424
+ "parameterName": {
1425
+ "type": "string",
1426
+ "maxLength": 250
1427
+ }
1428
+ },
1429
+ "required": [
1430
+ "errorCode",
1431
+ "message",
1432
+ "type"
1433
+ ]
1434
+ },
1435
+ "IdempotenceId": {
1436
+ "type": "string",
1437
+ "maxLength": 128,
1438
+ "pattern": "^[a-zA-Z0-9\\-]*$"
1439
+ },
1440
+ "Reservations": {
1441
+ "type": "array",
1442
+ "items": {
1443
+ "type": "object",
1444
+ "properties": {
1445
+ "sku": {
1446
+ "$ref": "#/components/schemas/SkuId"
1447
+ },
1448
+ "quantity": {
1449
+ "$ref": "#/components/schemas/ReservedQuantity"
1450
+ }
1451
+ },
1452
+ "required": [
1453
+ "quantity",
1454
+ "sku"
1455
+ ]
1456
+ }
1457
+ },
1458
+ "UpdateReservationLocationType": {
1459
+ "type": "array",
1460
+ "items": {
1461
+ "type": "object",
1462
+ "properties": {
1463
+ "id": {
1464
+ "$ref": "#/components/schemas/LocationId"
1465
+ },
1466
+ "reservations": {
1467
+ "$ref": "#/components/schemas/Reservations"
1468
+ },
1469
+ "allOrNothingReservations": {
1470
+ "type": "object",
1471
+ "properties": {
1472
+ "id": {
1473
+ "type": "string",
1474
+ "maxLength": 32
1475
+ },
1476
+ "reservations": {
1477
+ "$ref": "#/components/schemas/Reservations"
1478
+ }
1479
+ },
1480
+ "required": [
1481
+ "id",
1482
+ "reservations"
1483
+ ]
1484
+ }
1485
+ },
1486
+ "required": [
1487
+ "allOrNothingReservations",
1488
+ "id",
1489
+ "reservations"
1490
+ ]
1491
+ }
1492
+ },
1493
+ "UpdateReservationGroupType": {
1494
+ "type": "array",
1495
+ "items": {
1496
+ "type": "object",
1497
+ "properties": {
1498
+ "id": {
1499
+ "$ref": "#/components/schemas/GroupId"
1500
+ },
1501
+ "reservations": {
1502
+ "$ref": "#/components/schemas/Reservations"
1503
+ },
1504
+ "allOrNothingReservations": {
1505
+ "type": "object",
1506
+ "properties": {
1507
+ "id": {
1508
+ "type": "string",
1509
+ "maxLength": 32
1510
+ },
1511
+ "reservations": {
1512
+ "$ref": "#/components/schemas/Reservations"
1513
+ }
1514
+ },
1515
+ "required": [
1516
+ "id",
1517
+ "reservations"
1518
+ ]
1519
+ }
1520
+ },
1521
+ "required": [
1522
+ "allOrNothingReservations",
1523
+ "id",
1524
+ "reservations"
1525
+ ]
1526
+ }
1527
+ },
1528
+ "UpdateReservationRequestBody": {
1529
+ "type": "object",
1530
+ "properties": {
1531
+ "status": {
1532
+ "type": "string",
1533
+ "enum": [
1534
+ "CANCELLED"
1535
+ ]
1536
+ },
1537
+ "externalRefId": {
1538
+ "$ref": "#/components/schemas/ExternalRefId"
1539
+ },
1540
+ "allowPartialReservations": {
1541
+ "type": "boolean"
1542
+ },
1543
+ "reservationTime": {
1544
+ "$ref": "#/components/schemas/ReservationTime"
1545
+ },
1546
+ "id": {
1547
+ "$ref": "#/components/schemas/IdempotenceId"
1548
+ },
1549
+ "locations": {
1550
+ "$ref": "#/components/schemas/UpdateReservationLocationType"
1551
+ },
1552
+ "groups": {
1553
+ "$ref": "#/components/schemas/UpdateReservationGroupType"
1554
+ }
1555
+ }
1556
+ },
1557
+ "GenericErrorsArray": {
1558
+ "type": "array",
1559
+ "items": {
1560
+ "type": "object",
1561
+ "properties": {
1562
+ "sku": {
1563
+ "$ref": "#/components/schemas/SkuId"
1564
+ },
1565
+ "errorCode": {
1566
+ "type": "string",
1567
+ "maxLength": 32
1568
+ }
1569
+ }
1570
+ }
1571
+ },
1572
+ "UpdateReservationResponse": {
1573
+ "type": "object",
1574
+ "properties": {
1575
+ "reservationTime": {
1576
+ "$ref": "#/components/schemas/ReservationTime"
1577
+ },
1578
+ "expirationTime": {
1579
+ "$ref": "#/components/schemas/ExpirationTime"
1580
+ },
1581
+ "success": {
1582
+ "type": "boolean"
1583
+ },
1584
+ "groups": {
1585
+ "type": "array",
1586
+ "items": {
1587
+ "type": "object",
1588
+ "properties": {
1589
+ "id": {
1590
+ "$ref": "#/components/schemas/GroupId"
1591
+ },
1592
+ "errors": {
1593
+ "$ref": "#/components/schemas/GenericErrorsArray"
1594
+ },
1595
+ "details": {
1596
+ "type": "array",
1597
+ "items": {
1598
+ "type": "object",
1599
+ "properties": {
1600
+ "sku": {
1601
+ "$ref": "#/components/schemas/SkuId"
1602
+ },
1603
+ "quantity": {
1604
+ "type": "number",
1605
+ "format": "float"
1606
+ },
1607
+ "adjustment": {
1608
+ "type": "number",
1609
+ "format": "float"
1610
+ }
1611
+ }
1612
+ }
1613
+ }
1614
+ }
1615
+ }
1616
+ },
1617
+ "locations": {
1618
+ "type": "array",
1619
+ "items": {
1620
+ "type": "object",
1621
+ "properties": {
1622
+ "id": {
1623
+ "$ref": "#/components/schemas/LocationId"
1624
+ },
1625
+ "errors": {
1626
+ "$ref": "#/components/schemas/GenericErrorsArray"
1627
+ },
1628
+ "details": {
1629
+ "type": "array",
1630
+ "items": {
1631
+ "type": "object",
1632
+ "properties": {
1633
+ "sku": {
1634
+ "$ref": "#/components/schemas/SkuId"
1635
+ },
1636
+ "quantity": {
1637
+ "type": "number",
1638
+ "format": "float"
1639
+ },
1640
+ "adjustment": {
1641
+ "type": "number",
1642
+ "format": "float"
1643
+ }
1644
+ }
1645
+ }
1646
+ }
1647
+ }
1648
+ }
1649
+ }
1650
+ }
1651
+ },
1652
+ "MoveReservationFromLocation": {
1653
+ "type": "object",
1654
+ "properties": {
1655
+ "location": {
1656
+ "$ref": "#/components/schemas/LocationId"
1657
+ }
1658
+ },
1659
+ "required": [
1660
+ "location"
1661
+ ]
1662
+ },
1663
+ "MoveReservationFromGroup": {
1664
+ "type": "object",
1665
+ "properties": {
1666
+ "group": {
1667
+ "$ref": "#/components/schemas/GroupId"
1668
+ }
1669
+ },
1670
+ "required": [
1671
+ "group"
1672
+ ]
1673
+ },
1674
+ "MoveReservationToLocation": {
1675
+ "type": "object",
1676
+ "properties": {
1677
+ "location": {
1678
+ "$ref": "#/components/schemas/LocationId"
1679
+ }
1680
+ },
1681
+ "required": [
1682
+ "location"
1683
+ ]
1684
+ },
1685
+ "MoveReservationToGroup": {
1686
+ "type": "object",
1687
+ "properties": {
1688
+ "group": {
1689
+ "$ref": "#/components/schemas/GroupId"
1690
+ }
1691
+ },
1692
+ "required": [
1693
+ "group"
1694
+ ]
1695
+ },
1696
+ "MoveReservationBodyRecords": {
1697
+ "type": "object",
1698
+ "properties": {
1699
+ "id": {
1700
+ "$ref": "#/components/schemas/IdempotenceId"
1701
+ },
1702
+ "externalRefId": {
1703
+ "$ref": "#/components/schemas/ExternalRefId"
1704
+ },
1705
+ "from": {
1706
+ "oneOf": [
1707
+ {
1708
+ "$ref": "#/components/schemas/MoveReservationFromLocation"
1709
+ },
1710
+ {
1711
+ "$ref": "#/components/schemas/MoveReservationFromGroup"
1712
+ }
1713
+ ]
1714
+ },
1715
+ "to": {
1716
+ "oneOf": [
1717
+ {
1718
+ "$ref": "#/components/schemas/MoveReservationToLocation"
1719
+ },
1720
+ {
1721
+ "$ref": "#/components/schemas/MoveReservationToGroup"
1722
+ }
1723
+ ]
1724
+ },
1725
+ "sku": {
1726
+ "$ref": "#/components/schemas/SkuId"
1727
+ },
1728
+ "quantity": {
1729
+ "type": "number",
1730
+ "format": "double",
1731
+ "minimum": 0.001,
1732
+ "multipleOf": 0.001
1733
+ },
1734
+ "ignoreAvailabilityCheck": {
1735
+ "type": "boolean",
1736
+ "default": false
1737
+ }
1738
+ },
1739
+ "required": [
1740
+ "from",
1741
+ "id",
1742
+ "quantity",
1743
+ "sku",
1744
+ "to"
1745
+ ]
1746
+ },
1747
+ "MoveReservationBatchPostBody": {
1748
+ "type": "object",
1749
+ "properties": {
1750
+ "allOrNothingTransferId": {
1751
+ "$ref": "#/components/schemas/AllOrNothingId"
1752
+ },
1753
+ "records": {
1754
+ "type": "array",
1755
+ "items": {
1756
+ "$ref": "#/components/schemas/MoveReservationBodyRecords"
1757
+ }
1758
+ }
1759
+ },
1760
+ "required": [
1761
+ "allOrNothingTransferId",
1762
+ "records"
1763
+ ]
1764
+ },
1765
+ "MoveReservationErrorDetail": {
1766
+ "type": "object",
1767
+ "properties": {
1768
+ "id": {
1769
+ "$ref": "#/components/schemas/IdempotenceId"
1770
+ },
1771
+ "externalRefId": {
1772
+ "$ref": "#/components/schemas/ExternalRefId"
1773
+ },
1774
+ "from": {
1775
+ "oneOf": [
1776
+ {
1777
+ "$ref": "#/components/schemas/MoveReservationFromGroup"
1778
+ },
1779
+ {
1780
+ "$ref": "#/components/schemas/MoveReservationFromLocation"
1781
+ }
1782
+ ]
1783
+ },
1784
+ "to": {
1785
+ "oneOf": [
1786
+ {
1787
+ "$ref": "#/components/schemas/MoveReservationToGroup"
1788
+ },
1789
+ {
1790
+ "$ref": "#/components/schemas/MoveReservationToLocation"
1791
+ }
1792
+ ]
1793
+ },
1794
+ "sku": {
1795
+ "$ref": "#/components/schemas/SkuId"
1796
+ },
1797
+ "quantity": {
1798
+ "type": "number",
1799
+ "format": "double",
1800
+ "minimum": 0.001,
1801
+ "multipleOf": 0.001
1802
+ }
1803
+ },
1804
+ "required": [
1805
+ "externalRefId",
1806
+ "from",
1807
+ "id",
1808
+ "quantity",
1809
+ "sku",
1810
+ "to"
1811
+ ]
1812
+ },
1813
+ "Message": {
1814
+ "type": "string",
1815
+ "maxLength": 128,
1816
+ "pattern": "^[a-zA-Z0-9\\- ]*$"
1817
+ },
1818
+ "MoveReservationError": {
1819
+ "type": "object",
1820
+ "properties": {
1821
+ "details": {
1822
+ "$ref": "#/components/schemas/MoveReservationErrorDetail"
1823
+ },
1824
+ "message": {
1825
+ "$ref": "#/components/schemas/Message"
1826
+ },
1827
+ "errorCode": {
1828
+ "$ref": "#/components/schemas/ErrorCode"
1829
+ }
1830
+ },
1831
+ "required": [
1832
+ "details",
1833
+ "errorCode",
1834
+ "message"
1835
+ ]
1836
+ },
1837
+ "MoveReservationErrorsResponse": {
1838
+ "type": "object",
1839
+ "additionalProperties": false,
1840
+ "properties": {
1841
+ "errors": {
1842
+ "type": "array",
1843
+ "items": {
1844
+ "$ref": "#/components/schemas/MoveReservationError"
1845
+ }
1846
+ }
1847
+ },
1848
+ "required": [
1849
+ "errors"
1850
+ ]
1851
+ },
1852
+ "QuantityOnHand": {
1853
+ "type": "number",
1854
+ "format": "double",
1855
+ "minimum": 0,
1856
+ "multipleOf": 0.001
1857
+ },
1858
+ "UnreserveRequestBody": {
1859
+ "type": "object",
1860
+ "properties": {
1861
+ "records": {
1862
+ "type": "array",
1863
+ "items": {
1864
+ "type": "object",
1865
+ "properties": {
1866
+ "id": {
1867
+ "$ref": "#/components/schemas/IdempotenceId"
1868
+ },
1869
+ "externalRefId": {
1870
+ "$ref": "#/components/schemas/ExternalRefId"
1871
+ },
1872
+ "location": {
1873
+ "$ref": "#/components/schemas/LocationId"
1874
+ },
1875
+ "group": {
1876
+ "$ref": "#/components/schemas/GroupId"
1877
+ },
1878
+ "sku": {
1879
+ "$ref": "#/components/schemas/SkuId"
1880
+ },
1881
+ "quantity": {
1882
+ "$ref": "#/components/schemas/QuantityOnHand"
1883
+ }
1884
+ },
1885
+ "required": [
1886
+ "id",
1887
+ "quantity",
1888
+ "sku"
1889
+ ]
1890
+ }
1891
+ }
1892
+ },
1893
+ "required": [
1894
+ "records"
1895
+ ]
1896
+ },
1897
+ "UnreservedDetail": {
1898
+ "type": "object",
1899
+ "properties": {
1900
+ "id": {
1901
+ "$ref": "#/components/schemas/IdempotenceId"
1902
+ },
1903
+ "externalRefId": {
1904
+ "$ref": "#/components/schemas/ExternalRefId"
1905
+ },
1906
+ "location": {
1907
+ "$ref": "#/components/schemas/LocationId"
1908
+ },
1909
+ "group": {
1910
+ "$ref": "#/components/schemas/GroupId"
1911
+ },
1912
+ "sku": {
1913
+ "$ref": "#/components/schemas/SkuId"
1914
+ },
1915
+ "quantity": {
1916
+ "type": "number"
1917
+ }
1918
+ },
1919
+ "required": [
1920
+ "externalRefId",
1921
+ "id",
1922
+ "quantity",
1923
+ "sku"
1924
+ ]
1925
+ },
1926
+ "UnreserveResponseBody": {
1927
+ "type": "object",
1928
+ "properties": {
1929
+ "errors": {
1930
+ "type": "array",
1931
+ "items": {
1932
+ "type": "object",
1933
+ "properties": {
1934
+ "details": {
1935
+ "$ref": "#/components/schemas/UnreservedDetail"
1936
+ },
1937
+ "errorCode": {
1938
+ "$ref": "#/components/schemas/ErrorCode"
1939
+ },
1940
+ "message": {
1941
+ "$ref": "#/components/schemas/Message"
1942
+ }
1943
+ },
1944
+ "required": [
1945
+ "details"
1946
+ ]
1947
+ }
1948
+ }
1949
+ },
1950
+ "required": [
1951
+ "errors"
1952
+ ]
1953
+ },
1954
+ "FulfillmentTime": {
1955
+ "type": "string",
1956
+ "format": "date-time",
1957
+ "maxLength": 30
1958
+ },
1959
+ "FulfillQuantityRequestBody": {
1960
+ "type": "object",
1961
+ "additionalProperties": false,
1962
+ "properties": {
1963
+ "records": {
1964
+ "type": "array",
1965
+ "items": {
1966
+ "type": "object",
1967
+ "properties": {
1968
+ "id": {
1969
+ "$ref": "#/components/schemas/IdempotenceId"
1970
+ },
1971
+ "externalRefId": {
1972
+ "$ref": "#/components/schemas/ExternalRefId"
1973
+ },
1974
+ "location": {
1975
+ "$ref": "#/components/schemas/LocationId"
1976
+ },
1977
+ "sku": {
1978
+ "$ref": "#/components/schemas/SkuId"
1979
+ },
1980
+ "quantity": {
1981
+ "$ref": "#/components/schemas/QuantityOnHand"
1982
+ },
1983
+ "fulfillmentTime": {
1984
+ "$ref": "#/components/schemas/FulfillmentTime"
1985
+ }
1986
+ },
1987
+ "required": [
1988
+ "id",
1989
+ "location",
1990
+ "quantity",
1991
+ "sku"
1992
+ ]
1993
+ }
1994
+ }
1995
+ },
1996
+ "required": [
1997
+ "records"
1998
+ ]
1999
+ },
2000
+ "FulfillQuantityResponseErrors": {
2001
+ "type": "object",
2002
+ "additionalProperties": false,
2003
+ "properties": {
2004
+ "errors": {
2005
+ "type": "array",
2006
+ "items": {
2007
+ "type": "object",
2008
+ "properties": {
2009
+ "details": {
2010
+ "type": "object",
2011
+ "properties": {
2012
+ "id": {
2013
+ "$ref": "#/components/schemas/IdempotenceId"
2014
+ },
2015
+ "externalRefId": {
2016
+ "$ref": "#/components/schemas/ExternalRefId"
2017
+ },
2018
+ "location": {
2019
+ "$ref": "#/components/schemas/LocationId"
2020
+ },
2021
+ "sku": {
2022
+ "$ref": "#/components/schemas/SkuId"
2023
+ },
2024
+ "quantity": {
2025
+ "$ref": "#/components/schemas/QuantityOnHand"
2026
+ }
2027
+ },
2028
+ "required": [
2029
+ "id",
2030
+ "location",
2031
+ "quantity",
2032
+ "sku"
2033
+ ]
2034
+ },
2035
+ "message": {
2036
+ "type": "string",
2037
+ "maxLength": 128
2038
+ },
2039
+ "errorCode": {
2040
+ "$ref": "#/components/schemas/ErrorCode"
2041
+ }
2042
+ },
2043
+ "required": [
2044
+ "details",
2045
+ "errorCode",
2046
+ "message"
2047
+ ]
2048
+ }
2049
+ }
2050
+ },
2051
+ "required": [
2052
+ "errors"
2053
+ ]
2054
+ }
2055
+ },
2056
+ "parameters": {
2057
+ "organizationId": {
2058
+ "name": "organizationId",
2059
+ "in": "path",
2060
+ "required": true,
2061
+ "style": "simple",
2062
+ "explode": false,
2063
+ "schema": {
2064
+ "$ref": "#/components/schemas/OrganizationId"
2065
+ }
2066
+ },
2067
+ "reservationId": {
2068
+ "name": "reservationId",
2069
+ "in": "path",
2070
+ "required": true,
2071
+ "style": "simple",
2072
+ "explode": false,
2073
+ "schema": {
2074
+ "type": "string",
2075
+ "maxLength": 36,
2076
+ "pattern": "^[0-9a-fA-F\\-]{36}$"
2077
+ }
2078
+ }
2079
+ },
2080
+ "securitySchemes": {
2081
+ "AmOAuth2": {
2082
+ "type": "oauth2",
2083
+ "flows": {
2084
+ "clientCredentials": {
2085
+ "tokenUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
2086
+ "scopes": {
2087
+ "sfcc.inventory.reservations.rw": "Inventory Reservation scope",
2088
+ "sfcc_inventory_reservations_rw": "Inventory Reservation scope"
2089
+ }
2090
+ },
2091
+ "authorizationCode": {
2092
+ "authorizationUrl": "https://account.demandware.com/dwsso/oauth2/authorize",
2093
+ "tokenUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
2094
+ "scopes": {
2095
+ "sfcc.inventory.reservations.rw": "Inventory Reservation scope",
2096
+ "sfcc_inventory_reservations_rw": "Inventory Reservation scope"
2097
+ }
2098
+ }
2099
+ }
2100
+ }
2101
+ }
2102
+ }
2103
+ }