@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,2649 @@
1
+ {
2
+ "openapi": "3.0.3",
3
+ "info": {
4
+ "title": "Inventory Availability",
5
+ "version": "1.1.31",
6
+ "x-api-type": "Admin",
7
+ "x-api-family": "Inventory"
8
+ },
9
+ "servers": [
10
+ {
11
+ "url": "https://{shortCode}.api.commercecloud.salesforce.com/inventory/availability/v1",
12
+ "variables": {
13
+ "shortCode": {
14
+ "default": "shortCode"
15
+ }
16
+ }
17
+ }
18
+ ],
19
+ "paths": {
20
+ "/organizations/{organizationId}/availability-records/delta-token": {
21
+ "post": {
22
+ "operationId": "createNewDeltaToken",
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
+ "requestBody": {
36
+ "content": {
37
+ "application/json": {
38
+ "schema": {
39
+ "$ref": "#/components/schemas/CreateNewDeltaTokenBody"
40
+ }
41
+ }
42
+ },
43
+ "required": true
44
+ },
45
+ "responses": {
46
+ "200": {
47
+ "description": "New Delta Token was created successfully.",
48
+ "headers": {
49
+ "X-RateLimit-Limit": {
50
+ "style": "simple",
51
+ "explode": false,
52
+ "schema": {
53
+ "type": "string"
54
+ }
55
+ },
56
+ "X-RateLimit-Remaining": {
57
+ "style": "simple",
58
+ "explode": false,
59
+ "schema": {
60
+ "type": "string"
61
+ }
62
+ },
63
+ "X-RateLimit-Reset": {
64
+ "style": "simple",
65
+ "explode": false,
66
+ "schema": {
67
+ "type": "string"
68
+ }
69
+ }
70
+ },
71
+ "content": {
72
+ "application/json": {
73
+ "schema": {
74
+ "$ref": "#/components/schemas/CreateNewDeltaTokenResponse"
75
+ }
76
+ }
77
+ }
78
+ },
79
+ "400": {
80
+ "description": "Invalid request.",
81
+ "headers": {
82
+ "X-RateLimit-Limit": {
83
+ "style": "simple",
84
+ "explode": false,
85
+ "schema": {
86
+ "type": "string"
87
+ }
88
+ },
89
+ "X-RateLimit-Remaining": {
90
+ "style": "simple",
91
+ "explode": false,
92
+ "schema": {
93
+ "type": "string"
94
+ }
95
+ },
96
+ "X-RateLimit-Reset": {
97
+ "style": "simple",
98
+ "explode": false,
99
+ "schema": {
100
+ "type": "string"
101
+ }
102
+ }
103
+ },
104
+ "content": {
105
+ "application/problem+json": {
106
+ "schema": {
107
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
108
+ }
109
+ }
110
+ }
111
+ },
112
+ "429": {
113
+ "description": "The user has sent too many requests in a given amount of time (\"rate limiting\")",
114
+ "headers": {
115
+ "Retry-After": {
116
+ "style": "simple",
117
+ "explode": false,
118
+ "schema": {
119
+ "type": "string"
120
+ }
121
+ }
122
+ },
123
+ "content": {
124
+ "application/problem+json": {
125
+ "schema": {
126
+ "properties": {
127
+ "title": {
128
+ "type": "string"
129
+ },
130
+ "type": {
131
+ "type": "string"
132
+ },
133
+ "detail": {
134
+ "type": "string"
135
+ },
136
+ "instance": {
137
+ "type": "string"
138
+ }
139
+ },
140
+ "required": [
141
+ "type"
142
+ ]
143
+ }
144
+ }
145
+ }
146
+ }
147
+ },
148
+ "security": [
149
+ {
150
+ "AmOAuth2": [
151
+ "sfcc.inventory.availability.rw",
152
+ "sfcc_inventory_availability_rw"
153
+ ]
154
+ }
155
+ ]
156
+ }
157
+ },
158
+ "/organizations/{organizationId}/availability-records/delta-token/actions/update": {
159
+ "post": {
160
+ "operationId": "updateDeltaToken",
161
+ "parameters": [
162
+ {
163
+ "name": "organizationId",
164
+ "in": "path",
165
+ "required": true,
166
+ "style": "simple",
167
+ "explode": false,
168
+ "schema": {
169
+ "$ref": "#/components/schemas/OrganizationId"
170
+ }
171
+ }
172
+ ],
173
+ "requestBody": {
174
+ "content": {
175
+ "application/json": {
176
+ "schema": {
177
+ "$ref": "#/components/schemas/UpdateDeltaTokenBody"
178
+ }
179
+ }
180
+ },
181
+ "required": true
182
+ },
183
+ "responses": {
184
+ "200": {
185
+ "description": "Delta Token stream updated successfully.",
186
+ "headers": {
187
+ "X-RateLimit-Limit": {
188
+ "style": "simple",
189
+ "explode": false,
190
+ "schema": {
191
+ "type": "string"
192
+ }
193
+ },
194
+ "X-RateLimit-Remaining": {
195
+ "style": "simple",
196
+ "explode": false,
197
+ "schema": {
198
+ "type": "string"
199
+ }
200
+ },
201
+ "X-RateLimit-Reset": {
202
+ "style": "simple",
203
+ "explode": false,
204
+ "schema": {
205
+ "type": "string"
206
+ }
207
+ }
208
+ },
209
+ "content": {
210
+ "application/json": {
211
+ "schema": {
212
+ "$ref": "#/components/schemas/UpdateDeltaTokenResponse"
213
+ }
214
+ }
215
+ }
216
+ },
217
+ "400": {
218
+ "description": "Invalid request.",
219
+ "headers": {
220
+ "X-RateLimit-Limit": {
221
+ "style": "simple",
222
+ "explode": false,
223
+ "schema": {
224
+ "type": "string"
225
+ }
226
+ },
227
+ "X-RateLimit-Remaining": {
228
+ "style": "simple",
229
+ "explode": false,
230
+ "schema": {
231
+ "type": "string"
232
+ }
233
+ },
234
+ "X-RateLimit-Reset": {
235
+ "style": "simple",
236
+ "explode": false,
237
+ "schema": {
238
+ "type": "string"
239
+ }
240
+ }
241
+ },
242
+ "content": {
243
+ "application/problem+json": {
244
+ "schema": {
245
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
246
+ }
247
+ }
248
+ }
249
+ },
250
+ "403": {
251
+ "description": "Organization not authorized.",
252
+ "content": {
253
+ "application/problem+json": {
254
+ "schema": {
255
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
256
+ }
257
+ }
258
+ }
259
+ },
260
+ "410": {
261
+ "description": "Delta Token link expired.",
262
+ "headers": {
263
+ "X-RateLimit-Limit": {
264
+ "style": "simple",
265
+ "explode": false,
266
+ "schema": {
267
+ "type": "string"
268
+ }
269
+ },
270
+ "X-RateLimit-Remaining": {
271
+ "style": "simple",
272
+ "explode": false,
273
+ "schema": {
274
+ "type": "string"
275
+ }
276
+ },
277
+ "X-RateLimit-Reset": {
278
+ "style": "simple",
279
+ "explode": false,
280
+ "schema": {
281
+ "type": "string"
282
+ }
283
+ }
284
+ },
285
+ "content": {
286
+ "application/problem+json": {
287
+ "schema": {
288
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
289
+ }
290
+ }
291
+ }
292
+ },
293
+ "429": {
294
+ "description": "The user has sent too many requests in a given amount of time (\"rate limiting\")",
295
+ "headers": {
296
+ "Retry-After": {
297
+ "style": "simple",
298
+ "explode": false,
299
+ "schema": {
300
+ "type": "string"
301
+ }
302
+ }
303
+ },
304
+ "content": {
305
+ "application/problem+json": {
306
+ "schema": {
307
+ "properties": {
308
+ "title": {
309
+ "type": "string"
310
+ },
311
+ "type": {
312
+ "type": "string"
313
+ },
314
+ "detail": {
315
+ "type": "string"
316
+ },
317
+ "instance": {
318
+ "type": "string"
319
+ }
320
+ },
321
+ "required": [
322
+ "type"
323
+ ]
324
+ }
325
+ }
326
+ }
327
+ }
328
+ },
329
+ "security": [
330
+ {
331
+ "AmOAuth2": [
332
+ "sfcc.inventory.availability.rw",
333
+ "sfcc_inventory_availability_rw"
334
+ ]
335
+ }
336
+ ]
337
+ }
338
+ },
339
+ "/organizations/{organizationId}/availability-records/actions/batch-update": {
340
+ "post": {
341
+ "operationId": "batchInventoryUpdate",
342
+ "parameters": [
343
+ {
344
+ "name": "organizationId",
345
+ "in": "path",
346
+ "required": true,
347
+ "style": "simple",
348
+ "explode": false,
349
+ "schema": {
350
+ "$ref": "#/components/schemas/OrganizationId"
351
+ }
352
+ }
353
+ ],
354
+ "requestBody": {
355
+ "content": {
356
+ "application/json": {
357
+ "schema": {
358
+ "$ref": "#/components/schemas/BatchInventoryUpdateRequest"
359
+ }
360
+ }
361
+ },
362
+ "required": true
363
+ },
364
+ "responses": {
365
+ "200": {
366
+ "description": "Batch inventory updated successfully.",
367
+ "headers": {
368
+ "X-RateLimit-Limit": {
369
+ "style": "simple",
370
+ "explode": false,
371
+ "schema": {
372
+ "type": "string"
373
+ }
374
+ },
375
+ "X-RateLimit-Remaining": {
376
+ "style": "simple",
377
+ "explode": false,
378
+ "schema": {
379
+ "type": "string"
380
+ }
381
+ },
382
+ "X-RateLimit-Reset": {
383
+ "style": "simple",
384
+ "explode": false,
385
+ "schema": {
386
+ "type": "string"
387
+ }
388
+ }
389
+ },
390
+ "content": {
391
+ "application/json": {
392
+ "schema": {
393
+ "$ref": "#/components/schemas/BatchInventoryUpdateErrors"
394
+ }
395
+ }
396
+ }
397
+ },
398
+ "204": {
399
+ "description": "Batch inventory updated successfully.",
400
+ "headers": {
401
+ "X-RateLimit-Limit": {
402
+ "style": "simple",
403
+ "explode": false,
404
+ "schema": {
405
+ "type": "string"
406
+ }
407
+ },
408
+ "X-RateLimit-Remaining": {
409
+ "style": "simple",
410
+ "explode": false,
411
+ "schema": {
412
+ "type": "string"
413
+ }
414
+ },
415
+ "X-RateLimit-Reset": {
416
+ "style": "simple",
417
+ "explode": false,
418
+ "schema": {
419
+ "type": "string"
420
+ }
421
+ }
422
+ }
423
+ },
424
+ "400": {
425
+ "description": "Invalid request.",
426
+ "headers": {
427
+ "X-RateLimit-Limit": {
428
+ "style": "simple",
429
+ "explode": false,
430
+ "schema": {
431
+ "type": "string"
432
+ }
433
+ },
434
+ "X-RateLimit-Remaining": {
435
+ "style": "simple",
436
+ "explode": false,
437
+ "schema": {
438
+ "type": "string"
439
+ }
440
+ },
441
+ "X-RateLimit-Reset": {
442
+ "style": "simple",
443
+ "explode": false,
444
+ "schema": {
445
+ "type": "string"
446
+ }
447
+ }
448
+ },
449
+ "content": {
450
+ "application/problem+json": {
451
+ "schema": {
452
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
453
+ }
454
+ }
455
+ }
456
+ },
457
+ "403": {
458
+ "description": "Organization not authorized.",
459
+ "content": {
460
+ "application/problem+json": {
461
+ "schema": {
462
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
463
+ }
464
+ }
465
+ }
466
+ },
467
+ "429": {
468
+ "description": "The user has sent too many requests in a given amount of time (\"rate limiting\")",
469
+ "headers": {
470
+ "Retry-After": {
471
+ "style": "simple",
472
+ "explode": false,
473
+ "schema": {
474
+ "type": "string"
475
+ }
476
+ }
477
+ },
478
+ "content": {
479
+ "application/problem+json": {
480
+ "schema": {
481
+ "properties": {
482
+ "title": {
483
+ "type": "string"
484
+ },
485
+ "type": {
486
+ "type": "string"
487
+ },
488
+ "detail": {
489
+ "type": "string"
490
+ },
491
+ "instance": {
492
+ "type": "string"
493
+ }
494
+ },
495
+ "required": [
496
+ "type"
497
+ ]
498
+ }
499
+ }
500
+ }
501
+ }
502
+ },
503
+ "security": [
504
+ {
505
+ "AmOAuth2": [
506
+ "sfcc.inventory.availability.rw",
507
+ "sfcc_inventory_availability_rw"
508
+ ]
509
+ }
510
+ ]
511
+ },
512
+ "patch": {
513
+ "operationId": "batchInventoryPatch",
514
+ "parameters": [
515
+ {
516
+ "name": "organizationId",
517
+ "in": "path",
518
+ "required": true,
519
+ "style": "simple",
520
+ "explode": false,
521
+ "schema": {
522
+ "$ref": "#/components/schemas/OrganizationId"
523
+ }
524
+ }
525
+ ],
526
+ "requestBody": {
527
+ "content": {
528
+ "application/json": {
529
+ "schema": {
530
+ "$ref": "#/components/schemas/BatchInventoryUpdateRequest"
531
+ }
532
+ }
533
+ },
534
+ "required": true
535
+ },
536
+ "responses": {
537
+ "200": {
538
+ "description": "Batch inventory partially updated with potentially some errors reported.",
539
+ "headers": {
540
+ "X-RateLimit-Limit": {
541
+ "style": "simple",
542
+ "explode": false,
543
+ "schema": {
544
+ "type": "string"
545
+ }
546
+ },
547
+ "X-RateLimit-Remaining": {
548
+ "style": "simple",
549
+ "explode": false,
550
+ "schema": {
551
+ "type": "string"
552
+ }
553
+ },
554
+ "X-RateLimit-Reset": {
555
+ "style": "simple",
556
+ "explode": false,
557
+ "schema": {
558
+ "type": "string"
559
+ }
560
+ }
561
+ },
562
+ "content": {
563
+ "application/json": {
564
+ "schema": {
565
+ "$ref": "#/components/schemas/BatchInventoryUpdateErrors"
566
+ }
567
+ }
568
+ }
569
+ },
570
+ "204": {
571
+ "description": "All batch inventory items updated successfully.",
572
+ "headers": {
573
+ "X-RateLimit-Limit": {
574
+ "style": "simple",
575
+ "explode": false,
576
+ "schema": {
577
+ "type": "string"
578
+ }
579
+ },
580
+ "X-RateLimit-Remaining": {
581
+ "style": "simple",
582
+ "explode": false,
583
+ "schema": {
584
+ "type": "string"
585
+ }
586
+ },
587
+ "X-RateLimit-Reset": {
588
+ "style": "simple",
589
+ "explode": false,
590
+ "schema": {
591
+ "type": "string"
592
+ }
593
+ }
594
+ }
595
+ },
596
+ "400": {
597
+ "description": "Invalid request.",
598
+ "headers": {
599
+ "X-RateLimit-Limit": {
600
+ "style": "simple",
601
+ "explode": false,
602
+ "schema": {
603
+ "type": "string"
604
+ }
605
+ },
606
+ "X-RateLimit-Remaining": {
607
+ "style": "simple",
608
+ "explode": false,
609
+ "schema": {
610
+ "type": "string"
611
+ }
612
+ },
613
+ "X-RateLimit-Reset": {
614
+ "style": "simple",
615
+ "explode": false,
616
+ "schema": {
617
+ "type": "string"
618
+ }
619
+ }
620
+ },
621
+ "content": {
622
+ "application/problem+json": {
623
+ "schema": {
624
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
625
+ }
626
+ }
627
+ }
628
+ },
629
+ "403": {
630
+ "description": "Organization not authorized.",
631
+ "content": {
632
+ "application/problem+json": {
633
+ "schema": {
634
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
635
+ }
636
+ }
637
+ }
638
+ },
639
+ "429": {
640
+ "description": "The user has sent too many requests in a given amount of time (\"rate limiting\")",
641
+ "headers": {
642
+ "Retry-After": {
643
+ "style": "simple",
644
+ "explode": false,
645
+ "schema": {
646
+ "type": "string"
647
+ }
648
+ }
649
+ },
650
+ "content": {
651
+ "application/problem+json": {
652
+ "schema": {
653
+ "properties": {
654
+ "title": {
655
+ "type": "string"
656
+ },
657
+ "type": {
658
+ "type": "string"
659
+ },
660
+ "detail": {
661
+ "type": "string"
662
+ },
663
+ "instance": {
664
+ "type": "string"
665
+ }
666
+ },
667
+ "required": [
668
+ "type"
669
+ ]
670
+ }
671
+ }
672
+ }
673
+ }
674
+ },
675
+ "security": [
676
+ {
677
+ "AmOAuth2": [
678
+ "sfcc.inventory.availability.rw",
679
+ "sfcc_inventory_availability_rw"
680
+ ]
681
+ }
682
+ ]
683
+ }
684
+ },
685
+ "/organizations/{organizationId}/availability-records/actions/get-deltas": {
686
+ "post": {
687
+ "operationId": "getAvailabilityDeltas",
688
+ "parameters": [
689
+ {
690
+ "name": "organizationId",
691
+ "in": "path",
692
+ "required": true,
693
+ "style": "simple",
694
+ "explode": false,
695
+ "schema": {
696
+ "$ref": "#/components/schemas/OrganizationId"
697
+ }
698
+ }
699
+ ],
700
+ "requestBody": {
701
+ "content": {
702
+ "application/json": {
703
+ "schema": {
704
+ "$ref": "#/components/schemas/GetAvailabilityDeltasPostBody"
705
+ }
706
+ }
707
+ },
708
+ "required": true
709
+ },
710
+ "responses": {
711
+ "200": {
712
+ "description": "Changes are returned in the body with a new Delta Token to use for the next call.",
713
+ "headers": {
714
+ "X-RateLimit-Limit": {
715
+ "style": "simple",
716
+ "explode": false,
717
+ "schema": {
718
+ "type": "string"
719
+ }
720
+ },
721
+ "X-RateLimit-Remaining": {
722
+ "style": "simple",
723
+ "explode": false,
724
+ "schema": {
725
+ "type": "string"
726
+ }
727
+ },
728
+ "X-RateLimit-Reset": {
729
+ "style": "simple",
730
+ "explode": false,
731
+ "schema": {
732
+ "type": "string"
733
+ }
734
+ }
735
+ },
736
+ "content": {
737
+ "application/json": {
738
+ "schema": {
739
+ "$ref": "#/components/schemas/GetAvailabilityDeltasResponse200"
740
+ }
741
+ }
742
+ }
743
+ },
744
+ "400": {
745
+ "description": "Invalid request.",
746
+ "headers": {
747
+ "X-RateLimit-Limit": {
748
+ "style": "simple",
749
+ "explode": false,
750
+ "schema": {
751
+ "type": "string"
752
+ }
753
+ },
754
+ "X-RateLimit-Remaining": {
755
+ "style": "simple",
756
+ "explode": false,
757
+ "schema": {
758
+ "type": "string"
759
+ }
760
+ },
761
+ "X-RateLimit-Reset": {
762
+ "style": "simple",
763
+ "explode": false,
764
+ "schema": {
765
+ "type": "string"
766
+ }
767
+ }
768
+ },
769
+ "content": {
770
+ "application/problem+json": {
771
+ "schema": {
772
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
773
+ }
774
+ }
775
+ }
776
+ },
777
+ "403": {
778
+ "description": "Organization not authorized.",
779
+ "content": {
780
+ "application/problem+json": {
781
+ "schema": {
782
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
783
+ }
784
+ }
785
+ }
786
+ },
787
+ "410": {
788
+ "description": "Delta Token link expired.",
789
+ "headers": {
790
+ "X-RateLimit-Limit": {
791
+ "style": "simple",
792
+ "explode": false,
793
+ "schema": {
794
+ "type": "string"
795
+ }
796
+ },
797
+ "X-RateLimit-Remaining": {
798
+ "style": "simple",
799
+ "explode": false,
800
+ "schema": {
801
+ "type": "string"
802
+ }
803
+ },
804
+ "X-RateLimit-Reset": {
805
+ "style": "simple",
806
+ "explode": false,
807
+ "schema": {
808
+ "type": "string"
809
+ }
810
+ }
811
+ },
812
+ "content": {
813
+ "application/problem+json": {
814
+ "schema": {
815
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
816
+ }
817
+ }
818
+ }
819
+ },
820
+ "429": {
821
+ "description": "The user has sent too many requests in a given amount of time (\"rate limiting\")",
822
+ "headers": {
823
+ "Retry-After": {
824
+ "style": "simple",
825
+ "explode": false,
826
+ "schema": {
827
+ "type": "string"
828
+ }
829
+ }
830
+ },
831
+ "content": {
832
+ "application/problem+json": {
833
+ "schema": {
834
+ "properties": {
835
+ "title": {
836
+ "type": "string"
837
+ },
838
+ "type": {
839
+ "type": "string"
840
+ },
841
+ "detail": {
842
+ "type": "string"
843
+ },
844
+ "instance": {
845
+ "type": "string"
846
+ }
847
+ },
848
+ "required": [
849
+ "type"
850
+ ]
851
+ }
852
+ }
853
+ }
854
+ }
855
+ },
856
+ "security": [
857
+ {
858
+ "AmOAuth2": [
859
+ "sfcc.inventory.availability",
860
+ "sfcc_inventory_availability"
861
+ ]
862
+ }
863
+ ]
864
+ }
865
+ },
866
+ "/organizations/{organizationId}/availability-records/actions/get-availability": {
867
+ "post": {
868
+ "operationId": "skuAvailabilityByLocationAndOrGroup",
869
+ "parameters": [
870
+ {
871
+ "name": "organizationId",
872
+ "in": "path",
873
+ "required": true,
874
+ "style": "simple",
875
+ "explode": false,
876
+ "schema": {
877
+ "$ref": "#/components/schemas/OrganizationId"
878
+ }
879
+ }
880
+ ],
881
+ "requestBody": {
882
+ "content": {
883
+ "application/json": {
884
+ "schema": {
885
+ "$ref": "#/components/schemas/InventoryAvailabilityRequestBody"
886
+ }
887
+ }
888
+ },
889
+ "required": true
890
+ },
891
+ "responses": {
892
+ "200": {
893
+ "description": "Availability information successfully returned.",
894
+ "headers": {
895
+ "X-RateLimit-Limit": {
896
+ "style": "simple",
897
+ "explode": false,
898
+ "schema": {
899
+ "type": "string"
900
+ }
901
+ },
902
+ "X-RateLimit-Remaining": {
903
+ "style": "simple",
904
+ "explode": false,
905
+ "schema": {
906
+ "type": "string"
907
+ }
908
+ },
909
+ "X-RateLimit-Reset": {
910
+ "style": "simple",
911
+ "explode": false,
912
+ "schema": {
913
+ "type": "string"
914
+ }
915
+ }
916
+ },
917
+ "content": {
918
+ "application/json": {
919
+ "schema": {
920
+ "$ref": "#/components/schemas/Response200"
921
+ }
922
+ }
923
+ }
924
+ },
925
+ "400": {
926
+ "description": "Invalid request.",
927
+ "headers": {
928
+ "X-RateLimit-Limit": {
929
+ "style": "simple",
930
+ "explode": false,
931
+ "schema": {
932
+ "type": "string"
933
+ }
934
+ },
935
+ "X-RateLimit-Remaining": {
936
+ "style": "simple",
937
+ "explode": false,
938
+ "schema": {
939
+ "type": "string"
940
+ }
941
+ },
942
+ "X-RateLimit-Reset": {
943
+ "style": "simple",
944
+ "explode": false,
945
+ "schema": {
946
+ "type": "string"
947
+ }
948
+ }
949
+ },
950
+ "content": {
951
+ "application/problem+json": {
952
+ "schema": {
953
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
954
+ }
955
+ }
956
+ }
957
+ },
958
+ "403": {
959
+ "description": "Organization not authorized.",
960
+ "content": {
961
+ "application/problem+json": {
962
+ "schema": {
963
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
964
+ }
965
+ }
966
+ }
967
+ },
968
+ "429": {
969
+ "description": "The user has sent too many requests in a given amount of time (\"rate limiting\")",
970
+ "headers": {
971
+ "Retry-After": {
972
+ "style": "simple",
973
+ "explode": false,
974
+ "schema": {
975
+ "type": "string"
976
+ }
977
+ }
978
+ },
979
+ "content": {
980
+ "application/problem+json": {
981
+ "schema": {
982
+ "properties": {
983
+ "title": {
984
+ "type": "string"
985
+ },
986
+ "type": {
987
+ "type": "string"
988
+ },
989
+ "detail": {
990
+ "type": "string"
991
+ },
992
+ "instance": {
993
+ "type": "string"
994
+ }
995
+ },
996
+ "required": [
997
+ "type"
998
+ ]
999
+ }
1000
+ }
1001
+ }
1002
+ }
1003
+ },
1004
+ "security": [
1005
+ {
1006
+ "AmOAuth2": [
1007
+ "sfcc.inventory.availability",
1008
+ "sfcc_inventory_availability"
1009
+ ]
1010
+ }
1011
+ ]
1012
+ }
1013
+ },
1014
+ "/organizations/{organizationId}/product-segmentation/actions/batch-update": {
1015
+ "post": {
1016
+ "operationId": "batchProductSegmentationRequest",
1017
+ "parameters": [
1018
+ {
1019
+ "name": "organizationId",
1020
+ "in": "path",
1021
+ "required": true,
1022
+ "style": "simple",
1023
+ "explode": false,
1024
+ "schema": {
1025
+ "$ref": "#/components/schemas/OrganizationId"
1026
+ }
1027
+ }
1028
+ ],
1029
+ "requestBody": {
1030
+ "content": {
1031
+ "application/json": {
1032
+ "schema": {
1033
+ "oneOf": [
1034
+ {
1035
+ "$ref": "#/components/schemas/ProductSegmentationAppendRequestBody"
1036
+ },
1037
+ {
1038
+ "$ref": "#/components/schemas/ProductSegmentationDeleteRequestBody"
1039
+ }
1040
+ ]
1041
+ }
1042
+ }
1043
+ },
1044
+ "required": true
1045
+ },
1046
+ "responses": {
1047
+ "200": {
1048
+ "description": "Some product segmentations could not be fully processed.",
1049
+ "headers": {
1050
+ "X-RateLimit-Limit": {
1051
+ "style": "simple",
1052
+ "explode": false,
1053
+ "schema": {
1054
+ "type": "string"
1055
+ }
1056
+ },
1057
+ "X-RateLimit-Remaining": {
1058
+ "style": "simple",
1059
+ "explode": false,
1060
+ "schema": {
1061
+ "type": "string"
1062
+ }
1063
+ },
1064
+ "X-RateLimit-Reset": {
1065
+ "style": "simple",
1066
+ "explode": false,
1067
+ "schema": {
1068
+ "type": "string"
1069
+ }
1070
+ }
1071
+ },
1072
+ "content": {
1073
+ "application/json": {
1074
+ "schema": {
1075
+ "$ref": "#/components/schemas/Errors"
1076
+ }
1077
+ }
1078
+ }
1079
+ },
1080
+ "204": {
1081
+ "description": "Successfully processed all product segmentations.",
1082
+ "headers": {
1083
+ "X-RateLimit-Limit": {
1084
+ "style": "simple",
1085
+ "explode": false,
1086
+ "schema": {
1087
+ "type": "string"
1088
+ }
1089
+ },
1090
+ "X-RateLimit-Remaining": {
1091
+ "style": "simple",
1092
+ "explode": false,
1093
+ "schema": {
1094
+ "type": "string"
1095
+ }
1096
+ },
1097
+ "X-RateLimit-Reset": {
1098
+ "style": "simple",
1099
+ "explode": false,
1100
+ "schema": {
1101
+ "type": "string"
1102
+ }
1103
+ }
1104
+ }
1105
+ },
1106
+ "400": {
1107
+ "description": "Invalid request.",
1108
+ "headers": {
1109
+ "X-RateLimit-Limit": {
1110
+ "style": "simple",
1111
+ "explode": false,
1112
+ "schema": {
1113
+ "type": "string"
1114
+ }
1115
+ },
1116
+ "X-RateLimit-Remaining": {
1117
+ "style": "simple",
1118
+ "explode": false,
1119
+ "schema": {
1120
+ "type": "string"
1121
+ }
1122
+ },
1123
+ "X-RateLimit-Reset": {
1124
+ "style": "simple",
1125
+ "explode": false,
1126
+ "schema": {
1127
+ "type": "string"
1128
+ }
1129
+ }
1130
+ },
1131
+ "content": {
1132
+ "application/problem+json": {
1133
+ "schema": {
1134
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
1135
+ }
1136
+ }
1137
+ }
1138
+ },
1139
+ "429": {
1140
+ "description": "The user has sent too many requests in a given amount of time (\"rate limiting\")",
1141
+ "headers": {
1142
+ "Retry-After": {
1143
+ "style": "simple",
1144
+ "explode": false,
1145
+ "schema": {
1146
+ "type": "string"
1147
+ }
1148
+ }
1149
+ },
1150
+ "content": {
1151
+ "application/problem+json": {
1152
+ "schema": {
1153
+ "properties": {
1154
+ "title": {
1155
+ "type": "string"
1156
+ },
1157
+ "type": {
1158
+ "type": "string"
1159
+ },
1160
+ "detail": {
1161
+ "type": "string"
1162
+ },
1163
+ "instance": {
1164
+ "type": "string"
1165
+ }
1166
+ },
1167
+ "required": [
1168
+ "type"
1169
+ ]
1170
+ }
1171
+ }
1172
+ }
1173
+ }
1174
+ },
1175
+ "security": [
1176
+ {
1177
+ "AmOAuth2": [
1178
+ "sfcc.inventory.impex-inventory.rw",
1179
+ "sfcc_inventory_impex_inventory_rw"
1180
+ ]
1181
+ }
1182
+ ]
1183
+ }
1184
+ },
1185
+ "/organizations/{organizationId}/locations/{locationId}/availability-records/skus/{sku}/{requestId}": {
1186
+ "put": {
1187
+ "operationId": "replaceSkuLocation",
1188
+ "parameters": [
1189
+ {
1190
+ "name": "locationId",
1191
+ "in": "path",
1192
+ "required": true,
1193
+ "style": "simple",
1194
+ "explode": false,
1195
+ "schema": {
1196
+ "$ref": "#/components/schemas/LocationId"
1197
+ }
1198
+ },
1199
+ {
1200
+ "name": "sku",
1201
+ "in": "path",
1202
+ "required": true,
1203
+ "style": "simple",
1204
+ "explode": false,
1205
+ "schema": {
1206
+ "$ref": "#/components/schemas/SkuId"
1207
+ }
1208
+ },
1209
+ {
1210
+ "name": "requestId",
1211
+ "in": "path",
1212
+ "required": true,
1213
+ "style": "simple",
1214
+ "explode": false,
1215
+ "schema": {
1216
+ "type": "string",
1217
+ "maxLength": 128
1218
+ }
1219
+ },
1220
+ {
1221
+ "name": "organizationId",
1222
+ "in": "path",
1223
+ "required": true,
1224
+ "style": "simple",
1225
+ "explode": false,
1226
+ "schema": {
1227
+ "$ref": "#/components/schemas/OrganizationId"
1228
+ }
1229
+ }
1230
+ ],
1231
+ "requestBody": {
1232
+ "content": {
1233
+ "application/json": {
1234
+ "schema": {
1235
+ "$ref": "#/components/schemas/InventoryUpdateRequestBodyPut"
1236
+ }
1237
+ }
1238
+ },
1239
+ "required": true
1240
+ },
1241
+ "responses": {
1242
+ "204": {
1243
+ "description": "Data updated successfully.",
1244
+ "headers": {
1245
+ "X-RateLimit-Limit": {
1246
+ "style": "simple",
1247
+ "explode": false,
1248
+ "schema": {
1249
+ "type": "string"
1250
+ }
1251
+ },
1252
+ "X-RateLimit-Remaining": {
1253
+ "style": "simple",
1254
+ "explode": false,
1255
+ "schema": {
1256
+ "type": "string"
1257
+ }
1258
+ },
1259
+ "X-RateLimit-Reset": {
1260
+ "style": "simple",
1261
+ "explode": false,
1262
+ "schema": {
1263
+ "type": "string"
1264
+ }
1265
+ }
1266
+ }
1267
+ },
1268
+ "400": {
1269
+ "description": "Invalid request.",
1270
+ "headers": {
1271
+ "X-RateLimit-Limit": {
1272
+ "style": "simple",
1273
+ "explode": false,
1274
+ "schema": {
1275
+ "type": "string"
1276
+ }
1277
+ },
1278
+ "X-RateLimit-Remaining": {
1279
+ "style": "simple",
1280
+ "explode": false,
1281
+ "schema": {
1282
+ "type": "string"
1283
+ }
1284
+ },
1285
+ "X-RateLimit-Reset": {
1286
+ "style": "simple",
1287
+ "explode": false,
1288
+ "schema": {
1289
+ "type": "string"
1290
+ }
1291
+ }
1292
+ },
1293
+ "content": {
1294
+ "application/problem+json": {
1295
+ "schema": {
1296
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
1297
+ }
1298
+ }
1299
+ }
1300
+ },
1301
+ "403": {
1302
+ "description": "Organization not authorized.",
1303
+ "content": {
1304
+ "application/problem+json": {
1305
+ "schema": {
1306
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
1307
+ }
1308
+ }
1309
+ }
1310
+ },
1311
+ "404": {
1312
+ "description": "Entity not found.",
1313
+ "headers": {
1314
+ "X-RateLimit-Limit": {
1315
+ "style": "simple",
1316
+ "explode": false,
1317
+ "schema": {
1318
+ "type": "string"
1319
+ }
1320
+ },
1321
+ "X-RateLimit-Remaining": {
1322
+ "style": "simple",
1323
+ "explode": false,
1324
+ "schema": {
1325
+ "type": "string"
1326
+ }
1327
+ },
1328
+ "X-RateLimit-Reset": {
1329
+ "style": "simple",
1330
+ "explode": false,
1331
+ "schema": {
1332
+ "type": "string"
1333
+ }
1334
+ }
1335
+ },
1336
+ "content": {
1337
+ "application/problem+json": {
1338
+ "schema": {
1339
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
1340
+ }
1341
+ }
1342
+ }
1343
+ },
1344
+ "429": {
1345
+ "description": "The user has sent too many requests in a given amount of time (\"rate limiting\")",
1346
+ "headers": {
1347
+ "Retry-After": {
1348
+ "style": "simple",
1349
+ "explode": false,
1350
+ "schema": {
1351
+ "type": "string"
1352
+ }
1353
+ }
1354
+ },
1355
+ "content": {
1356
+ "application/problem+json": {
1357
+ "schema": {
1358
+ "properties": {
1359
+ "title": {
1360
+ "type": "string"
1361
+ },
1362
+ "type": {
1363
+ "type": "string"
1364
+ },
1365
+ "detail": {
1366
+ "type": "string"
1367
+ },
1368
+ "instance": {
1369
+ "type": "string"
1370
+ }
1371
+ },
1372
+ "required": [
1373
+ "type"
1374
+ ]
1375
+ }
1376
+ }
1377
+ }
1378
+ }
1379
+ },
1380
+ "security": [
1381
+ {
1382
+ "AmOAuth2": [
1383
+ "sfcc.inventory.availability.rw",
1384
+ "sfcc_inventory_availability_rw"
1385
+ ]
1386
+ }
1387
+ ]
1388
+ },
1389
+ "delete": {
1390
+ "operationId": "deleteLocationSku",
1391
+ "parameters": [
1392
+ {
1393
+ "name": "locationId",
1394
+ "in": "path",
1395
+ "required": true,
1396
+ "style": "simple",
1397
+ "explode": false,
1398
+ "schema": {
1399
+ "$ref": "#/components/schemas/LocationId"
1400
+ }
1401
+ },
1402
+ {
1403
+ "name": "sku",
1404
+ "in": "path",
1405
+ "required": true,
1406
+ "style": "simple",
1407
+ "explode": false,
1408
+ "schema": {
1409
+ "$ref": "#/components/schemas/SkuId"
1410
+ }
1411
+ },
1412
+ {
1413
+ "name": "requestId",
1414
+ "in": "path",
1415
+ "required": true,
1416
+ "style": "simple",
1417
+ "explode": false,
1418
+ "schema": {
1419
+ "type": "string",
1420
+ "maxLength": 128
1421
+ }
1422
+ },
1423
+ {
1424
+ "name": "organizationId",
1425
+ "in": "path",
1426
+ "required": true,
1427
+ "style": "simple",
1428
+ "explode": false,
1429
+ "schema": {
1430
+ "$ref": "#/components/schemas/OrganizationId"
1431
+ }
1432
+ }
1433
+ ],
1434
+ "responses": {
1435
+ "204": {
1436
+ "description": "Location SKU successfully deleted from the system.",
1437
+ "headers": {
1438
+ "X-RateLimit-Limit": {
1439
+ "style": "simple",
1440
+ "explode": false,
1441
+ "schema": {
1442
+ "type": "string"
1443
+ }
1444
+ },
1445
+ "X-RateLimit-Remaining": {
1446
+ "style": "simple",
1447
+ "explode": false,
1448
+ "schema": {
1449
+ "type": "string"
1450
+ }
1451
+ },
1452
+ "X-RateLimit-Reset": {
1453
+ "style": "simple",
1454
+ "explode": false,
1455
+ "schema": {
1456
+ "type": "string"
1457
+ }
1458
+ }
1459
+ }
1460
+ },
1461
+ "404": {
1462
+ "description": "Location SKU not found.",
1463
+ "headers": {
1464
+ "X-RateLimit-Limit": {
1465
+ "style": "simple",
1466
+ "explode": false,
1467
+ "schema": {
1468
+ "type": "string"
1469
+ }
1470
+ },
1471
+ "X-RateLimit-Remaining": {
1472
+ "style": "simple",
1473
+ "explode": false,
1474
+ "schema": {
1475
+ "type": "string"
1476
+ }
1477
+ },
1478
+ "X-RateLimit-Reset": {
1479
+ "style": "simple",
1480
+ "explode": false,
1481
+ "schema": {
1482
+ "type": "string"
1483
+ }
1484
+ }
1485
+ },
1486
+ "content": {
1487
+ "application/problem+json": {
1488
+ "schema": {
1489
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
1490
+ }
1491
+ }
1492
+ }
1493
+ },
1494
+ "409": {
1495
+ "description": "There is an inventory export in progress, deletion is not allowed.",
1496
+ "headers": {
1497
+ "X-RateLimit-Limit": {
1498
+ "style": "simple",
1499
+ "explode": false,
1500
+ "schema": {
1501
+ "type": "string"
1502
+ }
1503
+ },
1504
+ "X-RateLimit-Remaining": {
1505
+ "style": "simple",
1506
+ "explode": false,
1507
+ "schema": {
1508
+ "type": "string"
1509
+ }
1510
+ },
1511
+ "X-RateLimit-Reset": {
1512
+ "style": "simple",
1513
+ "explode": false,
1514
+ "schema": {
1515
+ "type": "string"
1516
+ }
1517
+ }
1518
+ },
1519
+ "content": {
1520
+ "application/problem+json": {
1521
+ "schema": {
1522
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
1523
+ }
1524
+ }
1525
+ }
1526
+ },
1527
+ "429": {
1528
+ "description": "The user has sent too many requests in a given amount of time (\"rate limiting\")",
1529
+ "headers": {
1530
+ "Retry-After": {
1531
+ "style": "simple",
1532
+ "explode": false,
1533
+ "schema": {
1534
+ "type": "string"
1535
+ }
1536
+ }
1537
+ },
1538
+ "content": {
1539
+ "application/problem+json": {
1540
+ "schema": {
1541
+ "properties": {
1542
+ "title": {
1543
+ "type": "string"
1544
+ },
1545
+ "type": {
1546
+ "type": "string"
1547
+ },
1548
+ "detail": {
1549
+ "type": "string"
1550
+ },
1551
+ "instance": {
1552
+ "type": "string"
1553
+ }
1554
+ },
1555
+ "required": [
1556
+ "type"
1557
+ ]
1558
+ }
1559
+ }
1560
+ }
1561
+ }
1562
+ },
1563
+ "security": [
1564
+ {
1565
+ "AmOAuth2": [
1566
+ "sfcc.inventory.availability.rw",
1567
+ "sfcc_inventory_availability_rw"
1568
+ ]
1569
+ }
1570
+ ]
1571
+ },
1572
+ "patch": {
1573
+ "operationId": "updateSkuLocation",
1574
+ "parameters": [
1575
+ {
1576
+ "name": "locationId",
1577
+ "in": "path",
1578
+ "required": true,
1579
+ "style": "simple",
1580
+ "explode": false,
1581
+ "schema": {
1582
+ "$ref": "#/components/schemas/LocationId"
1583
+ }
1584
+ },
1585
+ {
1586
+ "name": "sku",
1587
+ "in": "path",
1588
+ "required": true,
1589
+ "style": "simple",
1590
+ "explode": false,
1591
+ "schema": {
1592
+ "$ref": "#/components/schemas/SkuId"
1593
+ }
1594
+ },
1595
+ {
1596
+ "name": "requestId",
1597
+ "in": "path",
1598
+ "required": true,
1599
+ "style": "simple",
1600
+ "explode": false,
1601
+ "schema": {
1602
+ "type": "string",
1603
+ "maxLength": 128
1604
+ }
1605
+ },
1606
+ {
1607
+ "name": "organizationId",
1608
+ "in": "path",
1609
+ "required": true,
1610
+ "style": "simple",
1611
+ "explode": false,
1612
+ "schema": {
1613
+ "$ref": "#/components/schemas/OrganizationId"
1614
+ }
1615
+ }
1616
+ ],
1617
+ "requestBody": {
1618
+ "content": {
1619
+ "application/json": {
1620
+ "schema": {
1621
+ "$ref": "#/components/schemas/InventoryUpdateRequestBodyPatch"
1622
+ }
1623
+ }
1624
+ },
1625
+ "required": true
1626
+ },
1627
+ "responses": {
1628
+ "204": {
1629
+ "description": "Data updated successfully.",
1630
+ "headers": {
1631
+ "X-RateLimit-Limit": {
1632
+ "style": "simple",
1633
+ "explode": false,
1634
+ "schema": {
1635
+ "type": "string"
1636
+ }
1637
+ },
1638
+ "X-RateLimit-Remaining": {
1639
+ "style": "simple",
1640
+ "explode": false,
1641
+ "schema": {
1642
+ "type": "string"
1643
+ }
1644
+ },
1645
+ "X-RateLimit-Reset": {
1646
+ "style": "simple",
1647
+ "explode": false,
1648
+ "schema": {
1649
+ "type": "string"
1650
+ }
1651
+ }
1652
+ }
1653
+ },
1654
+ "400": {
1655
+ "description": "Invalid request.",
1656
+ "headers": {
1657
+ "X-RateLimit-Limit": {
1658
+ "style": "simple",
1659
+ "explode": false,
1660
+ "schema": {
1661
+ "type": "string"
1662
+ }
1663
+ },
1664
+ "X-RateLimit-Remaining": {
1665
+ "style": "simple",
1666
+ "explode": false,
1667
+ "schema": {
1668
+ "type": "string"
1669
+ }
1670
+ },
1671
+ "X-RateLimit-Reset": {
1672
+ "style": "simple",
1673
+ "explode": false,
1674
+ "schema": {
1675
+ "type": "string"
1676
+ }
1677
+ }
1678
+ },
1679
+ "content": {
1680
+ "application/problem+json": {
1681
+ "schema": {
1682
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
1683
+ }
1684
+ }
1685
+ }
1686
+ },
1687
+ "403": {
1688
+ "description": "Organization not authorized.",
1689
+ "content": {
1690
+ "application/problem+json": {
1691
+ "schema": {
1692
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
1693
+ }
1694
+ }
1695
+ }
1696
+ },
1697
+ "404": {
1698
+ "description": "Entity not found.",
1699
+ "headers": {
1700
+ "X-RateLimit-Limit": {
1701
+ "style": "simple",
1702
+ "explode": false,
1703
+ "schema": {
1704
+ "type": "string"
1705
+ }
1706
+ },
1707
+ "X-RateLimit-Remaining": {
1708
+ "style": "simple",
1709
+ "explode": false,
1710
+ "schema": {
1711
+ "type": "string"
1712
+ }
1713
+ },
1714
+ "X-RateLimit-Reset": {
1715
+ "style": "simple",
1716
+ "explode": false,
1717
+ "schema": {
1718
+ "type": "string"
1719
+ }
1720
+ }
1721
+ },
1722
+ "content": {
1723
+ "application/problem+json": {
1724
+ "schema": {
1725
+ "$ref": "#/components/schemas/InventoryResponseErrorSchema"
1726
+ }
1727
+ }
1728
+ }
1729
+ },
1730
+ "429": {
1731
+ "description": "The user has sent too many requests in a given amount of time (\"rate limiting\")",
1732
+ "headers": {
1733
+ "Retry-After": {
1734
+ "style": "simple",
1735
+ "explode": false,
1736
+ "schema": {
1737
+ "type": "string"
1738
+ }
1739
+ }
1740
+ },
1741
+ "content": {
1742
+ "application/problem+json": {
1743
+ "schema": {
1744
+ "properties": {
1745
+ "title": {
1746
+ "type": "string"
1747
+ },
1748
+ "type": {
1749
+ "type": "string"
1750
+ },
1751
+ "detail": {
1752
+ "type": "string"
1753
+ },
1754
+ "instance": {
1755
+ "type": "string"
1756
+ }
1757
+ },
1758
+ "required": [
1759
+ "type"
1760
+ ]
1761
+ }
1762
+ }
1763
+ }
1764
+ }
1765
+ },
1766
+ "security": [
1767
+ {
1768
+ "AmOAuth2": [
1769
+ "sfcc.inventory.availability.rw",
1770
+ "sfcc_inventory_availability_rw"
1771
+ ]
1772
+ }
1773
+ ]
1774
+ }
1775
+ }
1776
+ },
1777
+ "components": {
1778
+ "schemas": {
1779
+ "OrganizationId": {
1780
+ "type": "string",
1781
+ "maxLength": 32,
1782
+ "minLength": 1
1783
+ },
1784
+ "PlaceType": {
1785
+ "type": "string",
1786
+ "maxLength": 256
1787
+ },
1788
+ "GroupId": {
1789
+ "type": "string",
1790
+ "maxLength": 128,
1791
+ "minLength": 1,
1792
+ "pattern": "^[a-zA-Z0-9-_]*$"
1793
+ },
1794
+ "LocationId": {
1795
+ "type": "string",
1796
+ "maxLength": 128,
1797
+ "minLength": 2,
1798
+ "pattern": "^[a-zA-Z0-9-_]*$"
1799
+ },
1800
+ "Places": {
1801
+ "type": "array",
1802
+ "items": {
1803
+ "allOf": [
1804
+ {
1805
+ "$ref": "#/components/schemas/GroupId"
1806
+ },
1807
+ {
1808
+ "$ref": "#/components/schemas/LocationId"
1809
+ }
1810
+ ]
1811
+ },
1812
+ "maxItems": 100
1813
+ },
1814
+ "CreateNewDeltaTokenBody": {
1815
+ "type": "object",
1816
+ "properties": {
1817
+ "placeType": {
1818
+ "$ref": "#/components/schemas/PlaceType"
1819
+ },
1820
+ "places": {
1821
+ "$ref": "#/components/schemas/Places"
1822
+ }
1823
+ },
1824
+ "required": [
1825
+ "placeType",
1826
+ "places"
1827
+ ]
1828
+ },
1829
+ "DeltaToken": {
1830
+ "type": "string",
1831
+ "maxLength": 256
1832
+ },
1833
+ "CreateNewDeltaTokenResponse": {
1834
+ "type": "object",
1835
+ "properties": {
1836
+ "deltaToken": {
1837
+ "$ref": "#/components/schemas/DeltaToken"
1838
+ }
1839
+ },
1840
+ "required": [
1841
+ "deltaToken"
1842
+ ]
1843
+ },
1844
+ "InventoryResponseErrorSchema": {
1845
+ "type": "object",
1846
+ "properties": {
1847
+ "errorCode": {
1848
+ "type": "string",
1849
+ "maxLength": 256
1850
+ },
1851
+ "message": {
1852
+ "type": "string",
1853
+ "maxLength": 256
1854
+ },
1855
+ "type": {
1856
+ "type": "string",
1857
+ "maxLength": 256
1858
+ },
1859
+ "parameterName": {
1860
+ "type": "string",
1861
+ "maxLength": 256
1862
+ }
1863
+ },
1864
+ "required": [
1865
+ "errorCode",
1866
+ "message",
1867
+ "type"
1868
+ ]
1869
+ },
1870
+ "UpdateDeltaTokenBody": {
1871
+ "type": "object",
1872
+ "properties": {
1873
+ "deltaToken": {
1874
+ "$ref": "#/components/schemas/DeltaToken"
1875
+ },
1876
+ "places": {
1877
+ "$ref": "#/components/schemas/Places"
1878
+ }
1879
+ },
1880
+ "required": [
1881
+ "deltaToken",
1882
+ "places"
1883
+ ]
1884
+ },
1885
+ "UpdateDeltaTokenResponse": {
1886
+ "type": "object",
1887
+ "properties": {
1888
+ "deltaToken": {
1889
+ "$ref": "#/components/schemas/DeltaToken"
1890
+ },
1891
+ "places": {
1892
+ "$ref": "#/components/schemas/Places"
1893
+ }
1894
+ },
1895
+ "required": [
1896
+ "deltaToken"
1897
+ ]
1898
+ },
1899
+ "ExternalRefId": {
1900
+ "type": "string",
1901
+ "maxLength": 250
1902
+ },
1903
+ "Date": {
1904
+ "type": "string",
1905
+ "format": "date-time"
1906
+ },
1907
+ "Quantity": {
1908
+ "type": "number",
1909
+ "minimum": 0.001,
1910
+ "multipleOf": 0.001
1911
+ },
1912
+ "Future": {
1913
+ "type": "object",
1914
+ "properties": {
1915
+ "expectedDate": {
1916
+ "$ref": "#/components/schemas/Date"
1917
+ },
1918
+ "quantity": {
1919
+ "$ref": "#/components/schemas/Quantity"
1920
+ }
1921
+ },
1922
+ "required": [
1923
+ "expectedDate",
1924
+ "quantity"
1925
+ ]
1926
+ },
1927
+ "GroupEligibilityExclusion": {
1928
+ "type": "string",
1929
+ "maxLength": 128,
1930
+ "minLength": 2
1931
+ },
1932
+ "AttributeSet": {
1933
+ "type": "object",
1934
+ "properties": {
1935
+ "groupEligibilityExclusion": {
1936
+ "type": "array",
1937
+ "items": {
1938
+ "$ref": "#/components/schemas/GroupEligibilityExclusion"
1939
+ }
1940
+ }
1941
+ },
1942
+ "required": [
1943
+ "groupEligibilityExclusion"
1944
+ ]
1945
+ },
1946
+ "QOH": {
1947
+ "type": "number",
1948
+ "format": "double",
1949
+ "minimum": 0,
1950
+ "multipleOf": 0.001
1951
+ },
1952
+ "SafetyStock": {
1953
+ "type": "number",
1954
+ "format": "double",
1955
+ "minimum": 0
1956
+ },
1957
+ "SkuId": {
1958
+ "type": "string",
1959
+ "maxLength": 250,
1960
+ "minLength": 2,
1961
+ "pattern": "^[^\\\\<>;%/\\s]*$"
1962
+ },
1963
+ "IdempotenceId": {
1964
+ "type": "string",
1965
+ "maxLength": 250
1966
+ },
1967
+ "BatchInventoryUpdateRequestRecord": {
1968
+ "type": "object",
1969
+ "properties": {
1970
+ "externalRefId": {
1971
+ "$ref": "#/components/schemas/ExternalRefId"
1972
+ },
1973
+ "futureStock": {
1974
+ "type": "array",
1975
+ "items": {
1976
+ "$ref": "#/components/schemas/Future"
1977
+ }
1978
+ },
1979
+ "attributeSet": {
1980
+ "$ref": "#/components/schemas/AttributeSet"
1981
+ },
1982
+ "location": {
1983
+ "$ref": "#/components/schemas/LocationId"
1984
+ },
1985
+ "onHand": {
1986
+ "$ref": "#/components/schemas/QOH"
1987
+ },
1988
+ "safetyStockCount": {
1989
+ "$ref": "#/components/schemas/SafetyStock"
1990
+ },
1991
+ "sku": {
1992
+ "$ref": "#/components/schemas/SkuId"
1993
+ },
1994
+ "id": {
1995
+ "$ref": "#/components/schemas/IdempotenceId"
1996
+ },
1997
+ "effectiveDate": {
1998
+ "$ref": "#/components/schemas/Date"
1999
+ }
2000
+ },
2001
+ "required": [
2002
+ "id",
2003
+ "location",
2004
+ "sku"
2005
+ ]
2006
+ },
2007
+ "BatchInventoryUpdateRequest": {
2008
+ "type": "object",
2009
+ "properties": {
2010
+ "records": {
2011
+ "type": "array",
2012
+ "items": {
2013
+ "$ref": "#/components/schemas/BatchInventoryUpdateRequestRecord"
2014
+ },
2015
+ "maxItems": 100
2016
+ }
2017
+ },
2018
+ "required": [
2019
+ "records"
2020
+ ]
2021
+ },
2022
+ "BatchInventoryUpdateErrorDetail": {
2023
+ "type": "object",
2024
+ "properties": {
2025
+ "externalRefId": {
2026
+ "$ref": "#/components/schemas/ExternalRefId"
2027
+ },
2028
+ "locationId": {
2029
+ "$ref": "#/components/schemas/LocationId"
2030
+ },
2031
+ "sku": {
2032
+ "$ref": "#/components/schemas/SkuId"
2033
+ },
2034
+ "id": {
2035
+ "$ref": "#/components/schemas/IdempotenceId"
2036
+ }
2037
+ },
2038
+ "required": [
2039
+ "id",
2040
+ "locationId",
2041
+ "sku"
2042
+ ]
2043
+ },
2044
+ "BatchInventoryUpdateSingleError": {
2045
+ "type": "object",
2046
+ "properties": {
2047
+ "details": {
2048
+ "$ref": "#/components/schemas/BatchInventoryUpdateErrorDetail"
2049
+ },
2050
+ "message": {
2051
+ "type": "string",
2052
+ "maxLength": 255
2053
+ },
2054
+ "errorCode": {
2055
+ "type": "string",
2056
+ "maxLength": 255
2057
+ }
2058
+ },
2059
+ "required": [
2060
+ "details",
2061
+ "errorCode",
2062
+ "message"
2063
+ ]
2064
+ },
2065
+ "BatchInventoryUpdateErrors": {
2066
+ "type": "object",
2067
+ "properties": {
2068
+ "errors": {
2069
+ "type": "array",
2070
+ "items": {
2071
+ "$ref": "#/components/schemas/BatchInventoryUpdateSingleError"
2072
+ }
2073
+ }
2074
+ },
2075
+ "required": [
2076
+ "errors"
2077
+ ]
2078
+ },
2079
+ "GetAvailabilityDeltasPostBody": {
2080
+ "type": "object",
2081
+ "properties": {
2082
+ "deltaToken": {
2083
+ "$ref": "#/components/schemas/DeltaToken"
2084
+ }
2085
+ },
2086
+ "required": [
2087
+ "deltaToken"
2088
+ ]
2089
+ },
2090
+ "ShouldQueryAgain": {
2091
+ "type": "boolean"
2092
+ },
2093
+ "PlaceId": {
2094
+ "type": "string",
2095
+ "maxLength": 128
2096
+ },
2097
+ "ATF": {
2098
+ "type": "number",
2099
+ "format": "double",
2100
+ "minimum": 0,
2101
+ "multipleOf": 0.001
2102
+ },
2103
+ "ATO": {
2104
+ "type": "number",
2105
+ "format": "double",
2106
+ "minimum": 0,
2107
+ "multipleOf": 0.001
2108
+ },
2109
+ "QuantityReserved": {
2110
+ "type": "number",
2111
+ "format": "double",
2112
+ "minimum": 0,
2113
+ "multipleOf": 0.001
2114
+ },
2115
+ "DeltaRecordType": {
2116
+ "type": "object",
2117
+ "properties": {
2118
+ "sku": {
2119
+ "$ref": "#/components/schemas/SkuId"
2120
+ },
2121
+ "deltaType": {
2122
+ "type": "string",
2123
+ "enum": [
2124
+ "Change",
2125
+ "Delete"
2126
+ ]
2127
+ },
2128
+ "id": {
2129
+ "$ref": "#/components/schemas/PlaceId"
2130
+ },
2131
+ "effectiveDate": {
2132
+ "allOf": [
2133
+ {
2134
+ "$ref": "#/components/schemas/Date"
2135
+ }
2136
+ ]
2137
+ },
2138
+ "sequenceNumber": {
2139
+ "type": "number"
2140
+ },
2141
+ "onHand": {
2142
+ "$ref": "#/components/schemas/QOH"
2143
+ },
2144
+ "atf": {
2145
+ "$ref": "#/components/schemas/ATF"
2146
+ },
2147
+ "ato": {
2148
+ "$ref": "#/components/schemas/ATO"
2149
+ },
2150
+ "reserved": {
2151
+ "$ref": "#/components/schemas/QuantityReserved"
2152
+ },
2153
+ "safetyStockCount": {
2154
+ "$ref": "#/components/schemas/SafetyStock"
2155
+ },
2156
+ "futures": {
2157
+ "type": "array",
2158
+ "items": {
2159
+ "$ref": "#/components/schemas/Future"
2160
+ }
2161
+ }
2162
+ },
2163
+ "required": [
2164
+ "atf",
2165
+ "ato",
2166
+ "deltaType",
2167
+ "futures",
2168
+ "id",
2169
+ "onHand",
2170
+ "reserved",
2171
+ "safetyStockCount",
2172
+ "sequenceNumber",
2173
+ "sku"
2174
+ ]
2175
+ },
2176
+ "GetAvailabilityDeltasResponse200": {
2177
+ "type": "object",
2178
+ "properties": {
2179
+ "nextDeltaToken": {
2180
+ "$ref": "#/components/schemas/DeltaToken"
2181
+ },
2182
+ "shouldQueryAgain": {
2183
+ "$ref": "#/components/schemas/ShouldQueryAgain"
2184
+ },
2185
+ "records": {
2186
+ "type": "array",
2187
+ "items": {
2188
+ "$ref": "#/components/schemas/DeltaRecordType"
2189
+ }
2190
+ }
2191
+ },
2192
+ "required": [
2193
+ "nextDeltaToken",
2194
+ "records",
2195
+ "shouldQueryAgain"
2196
+ ]
2197
+ },
2198
+ "InventoryAvailabilityRequestBody": {
2199
+ "type": "object",
2200
+ "properties": {
2201
+ "sku": {
2202
+ "allOf": [
2203
+ {
2204
+ "$ref": "#/components/schemas/SkuId"
2205
+ }
2206
+ ]
2207
+ },
2208
+ "group": {
2209
+ "allOf": [
2210
+ {
2211
+ "$ref": "#/components/schemas/GroupId"
2212
+ }
2213
+ ]
2214
+ },
2215
+ "skus": {
2216
+ "type": "array",
2217
+ "items": {
2218
+ "$ref": "#/components/schemas/SkuId"
2219
+ }
2220
+ },
2221
+ "locations": {
2222
+ "type": "array",
2223
+ "items": {
2224
+ "$ref": "#/components/schemas/LocationId"
2225
+ }
2226
+ },
2227
+ "groups": {
2228
+ "type": "array",
2229
+ "items": {
2230
+ "$ref": "#/components/schemas/GroupId"
2231
+ }
2232
+ }
2233
+ }
2234
+ },
2235
+ "Reserved": {
2236
+ "type": "number",
2237
+ "format": "double",
2238
+ "minimum": 0,
2239
+ "multipleOf": 0.001
2240
+ },
2241
+ "Exists": {
2242
+ "type": "boolean"
2243
+ },
2244
+ "ItemLocationInfo": {
2245
+ "type": "object",
2246
+ "properties": {
2247
+ "id": {
2248
+ "$ref": "#/components/schemas/LocationId"
2249
+ },
2250
+ "records": {
2251
+ "type": "array",
2252
+ "items": {
2253
+ "type": "object",
2254
+ "properties": {
2255
+ "sku": {
2256
+ "$ref": "#/components/schemas/SkuId"
2257
+ },
2258
+ "atf": {
2259
+ "$ref": "#/components/schemas/ATF"
2260
+ },
2261
+ "ato": {
2262
+ "$ref": "#/components/schemas/ATO"
2263
+ },
2264
+ "onHand": {
2265
+ "$ref": "#/components/schemas/QOH"
2266
+ },
2267
+ "reserved": {
2268
+ "$ref": "#/components/schemas/Reserved"
2269
+ },
2270
+ "safetyStockCount": {
2271
+ "$ref": "#/components/schemas/SafetyStock"
2272
+ },
2273
+ "effectiveDate": {
2274
+ "$ref": "#/components/schemas/Date"
2275
+ },
2276
+ "futures": {
2277
+ "type": "array",
2278
+ "items": {
2279
+ "$ref": "#/components/schemas/Future"
2280
+ }
2281
+ },
2282
+ "attributeSet": {
2283
+ "$ref": "#/components/schemas/AttributeSet"
2284
+ },
2285
+ "exists": {
2286
+ "$ref": "#/components/schemas/Exists"
2287
+ }
2288
+ },
2289
+ "required": [
2290
+ "atf",
2291
+ "ato",
2292
+ "onHand",
2293
+ "reserved",
2294
+ "safetyStockCount",
2295
+ "sku"
2296
+ ]
2297
+ }
2298
+ }
2299
+ },
2300
+ "required": [
2301
+ "id",
2302
+ "records"
2303
+ ]
2304
+ },
2305
+ "DateGroup": {
2306
+ "allOf": [
2307
+ {
2308
+ "$ref": "#/components/schemas/Date"
2309
+ }
2310
+ ]
2311
+ },
2312
+ "FutureGroup": {
2313
+ "type": "object",
2314
+ "properties": {
2315
+ "expectedDate": {
2316
+ "$ref": "#/components/schemas/DateGroup"
2317
+ },
2318
+ "quantity": {
2319
+ "$ref": "#/components/schemas/Quantity"
2320
+ }
2321
+ },
2322
+ "required": [
2323
+ "expectedDate",
2324
+ "quantity"
2325
+ ]
2326
+ },
2327
+ "ItemGroupInfo": {
2328
+ "type": "object",
2329
+ "properties": {
2330
+ "id": {
2331
+ "$ref": "#/components/schemas/GroupId"
2332
+ },
2333
+ "records": {
2334
+ "type": "array",
2335
+ "items": {
2336
+ "type": "object",
2337
+ "properties": {
2338
+ "sku": {
2339
+ "$ref": "#/components/schemas/SkuId"
2340
+ },
2341
+ "atf": {
2342
+ "allOf": [
2343
+ {
2344
+ "$ref": "#/components/schemas/ATF"
2345
+ }
2346
+ ]
2347
+ },
2348
+ "ato": {
2349
+ "allOf": [
2350
+ {
2351
+ "$ref": "#/components/schemas/ATO"
2352
+ }
2353
+ ]
2354
+ },
2355
+ "onHand": {
2356
+ "allOf": [
2357
+ {
2358
+ "$ref": "#/components/schemas/QOH"
2359
+ }
2360
+ ]
2361
+ },
2362
+ "reserved": {
2363
+ "allOf": [
2364
+ {
2365
+ "$ref": "#/components/schemas/Reserved"
2366
+ }
2367
+ ]
2368
+ },
2369
+ "safetyStockCount": {
2370
+ "$ref": "#/components/schemas/SafetyStock"
2371
+ },
2372
+ "groupReserved": {
2373
+ "allOf": [
2374
+ {
2375
+ "$ref": "#/components/schemas/Reserved"
2376
+ }
2377
+ ]
2378
+ },
2379
+ "sharedGroupReserved": {
2380
+ "allOf": [
2381
+ {
2382
+ "$ref": "#/components/schemas/Reserved"
2383
+ }
2384
+ ]
2385
+ },
2386
+ "effectiveDate": {
2387
+ "$ref": "#/components/schemas/Date"
2388
+ },
2389
+ "futures": {
2390
+ "type": "array",
2391
+ "items": {
2392
+ "$ref": "#/components/schemas/FutureGroup"
2393
+ }
2394
+ },
2395
+ "exists": {
2396
+ "$ref": "#/components/schemas/Exists"
2397
+ }
2398
+ },
2399
+ "required": [
2400
+ "atf",
2401
+ "ato",
2402
+ "onHand",
2403
+ "reserved",
2404
+ "safetyStockCount",
2405
+ "sku"
2406
+ ]
2407
+ }
2408
+ }
2409
+ },
2410
+ "required": [
2411
+ "id",
2412
+ "records"
2413
+ ]
2414
+ },
2415
+ "Response200": {
2416
+ "type": "object",
2417
+ "properties": {
2418
+ "locations": {
2419
+ "type": "array",
2420
+ "items": {
2421
+ "$ref": "#/components/schemas/ItemLocationInfo"
2422
+ }
2423
+ },
2424
+ "groups": {
2425
+ "type": "array",
2426
+ "items": {
2427
+ "$ref": "#/components/schemas/ItemGroupInfo"
2428
+ }
2429
+ }
2430
+ },
2431
+ "required": [
2432
+ "locations"
2433
+ ]
2434
+ },
2435
+ "ProductSegmentationAppendRequestBody": {
2436
+ "type": "object",
2437
+ "properties": {
2438
+ "groups": {
2439
+ "type": "array",
2440
+ "items": {
2441
+ "type": "object",
2442
+ "properties": {
2443
+ "groupId": {
2444
+ "$ref": "#/components/schemas/GroupId"
2445
+ },
2446
+ "mode": {
2447
+ "type": "string",
2448
+ "enum": [
2449
+ "APPEND"
2450
+ ]
2451
+ },
2452
+ "skus": {
2453
+ "type": "array",
2454
+ "items": {
2455
+ "$ref": "#/components/schemas/SkuId"
2456
+ }
2457
+ }
2458
+ },
2459
+ "required": [
2460
+ "groupId",
2461
+ "mode",
2462
+ "skus"
2463
+ ]
2464
+ }
2465
+ }
2466
+ },
2467
+ "required": [
2468
+ "groups"
2469
+ ]
2470
+ },
2471
+ "ProductSegmentationDeleteRequestBody": {
2472
+ "type": "object",
2473
+ "properties": {
2474
+ "groups": {
2475
+ "type": "array",
2476
+ "items": {
2477
+ "type": "object",
2478
+ "properties": {
2479
+ "groupId": {
2480
+ "$ref": "#/components/schemas/GroupId"
2481
+ },
2482
+ "mode": {
2483
+ "type": "string",
2484
+ "enum": [
2485
+ "DELETE"
2486
+ ]
2487
+ },
2488
+ "skus": {
2489
+ "type": "array",
2490
+ "items": {
2491
+ "$ref": "#/components/schemas/SkuId"
2492
+ }
2493
+ }
2494
+ },
2495
+ "required": [
2496
+ "groupId",
2497
+ "mode",
2498
+ "skus"
2499
+ ]
2500
+ }
2501
+ }
2502
+ },
2503
+ "required": [
2504
+ "groups"
2505
+ ]
2506
+ },
2507
+ "Errors": {
2508
+ "type": "array",
2509
+ "items": {
2510
+ "type": "object",
2511
+ "properties": {
2512
+ "error": {
2513
+ "type": "string",
2514
+ "maxLength": 256
2515
+ }
2516
+ },
2517
+ "required": [
2518
+ "error"
2519
+ ]
2520
+ }
2521
+ },
2522
+ "InventoryUpdateRequestBodyPut": {
2523
+ "type": "object",
2524
+ "properties": {
2525
+ "externalRefId": {
2526
+ "$ref": "#/components/schemas/ExternalRefId"
2527
+ },
2528
+ "onHand": {
2529
+ "$ref": "#/components/schemas/QOH"
2530
+ },
2531
+ "safetyStockCount": {
2532
+ "$ref": "#/components/schemas/SafetyStock"
2533
+ },
2534
+ "effectiveDate": {
2535
+ "$ref": "#/components/schemas/Date"
2536
+ },
2537
+ "futureStock": {
2538
+ "type": "array",
2539
+ "items": {
2540
+ "$ref": "#/components/schemas/Future"
2541
+ }
2542
+ },
2543
+ "attributeSet": {
2544
+ "$ref": "#/components/schemas/AttributeSet"
2545
+ }
2546
+ }
2547
+ },
2548
+ "InventoryUpdateRequestBodyPatch": {
2549
+ "type": "object",
2550
+ "properties": {
2551
+ "externalRefId": {
2552
+ "$ref": "#/components/schemas/ExternalRefId"
2553
+ },
2554
+ "onHand": {
2555
+ "$ref": "#/components/schemas/QOH"
2556
+ },
2557
+ "safetyStockCount": {
2558
+ "$ref": "#/components/schemas/SafetyStock"
2559
+ },
2560
+ "effectiveDate": {
2561
+ "$ref": "#/components/schemas/Date"
2562
+ },
2563
+ "futureStock": {
2564
+ "type": "array",
2565
+ "items": {
2566
+ "$ref": "#/components/schemas/Future"
2567
+ }
2568
+ },
2569
+ "attributeSet": {
2570
+ "$ref": "#/components/schemas/AttributeSet"
2571
+ }
2572
+ }
2573
+ }
2574
+ },
2575
+ "parameters": {
2576
+ "organizationId": {
2577
+ "name": "organizationId",
2578
+ "in": "path",
2579
+ "required": true,
2580
+ "style": "simple",
2581
+ "explode": false,
2582
+ "schema": {
2583
+ "$ref": "#/components/schemas/OrganizationId"
2584
+ }
2585
+ },
2586
+ "locationId": {
2587
+ "name": "locationId",
2588
+ "in": "path",
2589
+ "required": true,
2590
+ "style": "simple",
2591
+ "explode": false,
2592
+ "schema": {
2593
+ "$ref": "#/components/schemas/LocationId"
2594
+ }
2595
+ },
2596
+ "sku": {
2597
+ "name": "sku",
2598
+ "in": "path",
2599
+ "required": true,
2600
+ "style": "simple",
2601
+ "explode": false,
2602
+ "schema": {
2603
+ "$ref": "#/components/schemas/SkuId"
2604
+ }
2605
+ },
2606
+ "requestId": {
2607
+ "name": "requestId",
2608
+ "in": "path",
2609
+ "required": true,
2610
+ "style": "simple",
2611
+ "explode": false,
2612
+ "schema": {
2613
+ "type": "string",
2614
+ "maxLength": 128
2615
+ }
2616
+ }
2617
+ },
2618
+ "securitySchemes": {
2619
+ "AmOAuth2": {
2620
+ "type": "oauth2",
2621
+ "flows": {
2622
+ "clientCredentials": {
2623
+ "tokenUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
2624
+ "scopes": {
2625
+ "sfcc.inventory.availability.rw": "Inventory Availability scope",
2626
+ "sfcc_inventory_availability_rw": "Inventory Availability scope",
2627
+ "sfcc.inventory.availability": "Inventory Availability scope READONLY",
2628
+ "sfcc_inventory_availability": "Inventory Availability scope READONLY",
2629
+ "sfcc.inventory.impex-inventory.rw": "Inventory Impex Inventory scope",
2630
+ "sfcc_inventory_impex_inventory_rw": "Inventory Impex Inventory scope"
2631
+ }
2632
+ },
2633
+ "authorizationCode": {
2634
+ "authorizationUrl": "https://account.demandware.com/dwsso/oauth2/authorize",
2635
+ "tokenUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
2636
+ "scopes": {
2637
+ "sfcc.inventory.availability.rw": "Inventory Availability scope",
2638
+ "sfcc_inventory_availability_rw": "Inventory Availability scope",
2639
+ "sfcc.inventory.availability": "Inventory Availability scope READONLY",
2640
+ "sfcc_inventory_availability": "Inventory Availability scope READONLY",
2641
+ "sfcc.inventory.impex-inventory.rw": "Inventory Impex Inventory scope",
2642
+ "sfcc_inventory_impex_inventory_rw": "Inventory Impex Inventory scope"
2643
+ }
2644
+ }
2645
+ }
2646
+ }
2647
+ }
2648
+ }
2649
+ }