@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,2961 @@
1
+ {
2
+ "openapi": "3.0.3",
3
+ "info": {
4
+ "title": "Shopper Products",
5
+ "version": "1.12.0",
6
+ "x-api-type": "Shopper",
7
+ "x-api-family": "Product"
8
+ },
9
+ "servers": [
10
+ {
11
+ "url": "https://{shortCode}.api.commercecloud.salesforce.com/product/shopper-products/v1",
12
+ "variables": {
13
+ "shortCode": {
14
+ "default": "shortCode"
15
+ }
16
+ }
17
+ }
18
+ ],
19
+ "paths": {
20
+ "/organizations/{organizationId}/products": {
21
+ "get": {
22
+ "operationId": "getProducts",
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": "ids",
36
+ "in": "query",
37
+ "required": true,
38
+ "style": "form",
39
+ "explode": false,
40
+ "schema": {
41
+ "type": "array",
42
+ "items": {
43
+ "allOf": [
44
+ {
45
+ "$ref": "#/components/schemas/ProductId"
46
+ }
47
+ ]
48
+ },
49
+ "maxItems": 100
50
+ }
51
+ },
52
+ {
53
+ "name": "inventoryIds",
54
+ "in": "query",
55
+ "required": false,
56
+ "style": "form",
57
+ "explode": false,
58
+ "schema": {
59
+ "type": "array",
60
+ "items": {
61
+ "allOf": [
62
+ {
63
+ "$ref": "#/components/schemas/InventoryId"
64
+ }
65
+ ]
66
+ },
67
+ "maxItems": 5
68
+ }
69
+ },
70
+ {
71
+ "name": "expand",
72
+ "in": "query",
73
+ "required": false,
74
+ "style": "form",
75
+ "explode": false,
76
+ "schema": {
77
+ "type": "array",
78
+ "items": {
79
+ "type": "string",
80
+ "enum": [
81
+ "none",
82
+ "availability",
83
+ "bundled_products",
84
+ "links",
85
+ "promotions",
86
+ "options",
87
+ "images",
88
+ "prices",
89
+ "variations",
90
+ "set_products",
91
+ "recommendations",
92
+ "shipping_methods",
93
+ "page_meta_tags",
94
+ "primary_category"
95
+ ]
96
+ }
97
+ }
98
+ },
99
+ {
100
+ "name": "allImages",
101
+ "in": "query",
102
+ "required": false,
103
+ "style": "form",
104
+ "explode": true,
105
+ "schema": {
106
+ "type": "boolean"
107
+ }
108
+ },
109
+ {
110
+ "name": "imgTypes",
111
+ "in": "query",
112
+ "required": false,
113
+ "style": "form",
114
+ "explode": true,
115
+ "schema": {
116
+ "type": "string",
117
+ "maxLength": 50
118
+ }
119
+ },
120
+ {
121
+ "name": "perPricebook",
122
+ "in": "query",
123
+ "required": false,
124
+ "style": "form",
125
+ "explode": true,
126
+ "schema": {
127
+ "type": "boolean"
128
+ }
129
+ },
130
+ {
131
+ "name": "siteId",
132
+ "in": "query",
133
+ "required": true,
134
+ "style": "form",
135
+ "explode": true,
136
+ "schema": {
137
+ "$ref": "#/components/schemas/SiteId"
138
+ }
139
+ },
140
+ {
141
+ "name": "select",
142
+ "in": "query",
143
+ "required": false,
144
+ "style": "form",
145
+ "explode": true,
146
+ "schema": {
147
+ "$ref": "#/components/schemas/Select"
148
+ }
149
+ },
150
+ {
151
+ "name": "locale",
152
+ "in": "query",
153
+ "required": false,
154
+ "style": "form",
155
+ "explode": true,
156
+ "schema": {
157
+ "$ref": "#/components/schemas/LocaleCode"
158
+ }
159
+ },
160
+ {
161
+ "name": "currency",
162
+ "in": "query",
163
+ "required": false,
164
+ "style": "form",
165
+ "explode": true,
166
+ "schema": {
167
+ "$ref": "#/components/schemas/CurrencyCode"
168
+ }
169
+ },
170
+ {
171
+ "name": "sfdc_usid",
172
+ "in": "header",
173
+ "required": false,
174
+ "style": "simple",
175
+ "explode": false,
176
+ "schema": {
177
+ "type": "string",
178
+ "format": "uuid"
179
+ }
180
+ },
181
+ {
182
+ "name": "sfdc_dw_dnt",
183
+ "in": "header",
184
+ "required": false,
185
+ "style": "simple",
186
+ "explode": false,
187
+ "schema": {
188
+ "type": "string",
189
+ "enum": [
190
+ "0",
191
+ "1"
192
+ ]
193
+ }
194
+ },
195
+ {
196
+ "name": "personalized",
197
+ "in": "query",
198
+ "required": false,
199
+ "style": "form",
200
+ "explode": true,
201
+ "schema": {
202
+ "type": "string",
203
+ "enum": [
204
+ "none"
205
+ ]
206
+ }
207
+ },
208
+ {
209
+ "name": "sfdc_shopper_context",
210
+ "in": "header",
211
+ "required": false,
212
+ "style": "simple",
213
+ "explode": false,
214
+ "schema": {
215
+ "type": "string"
216
+ }
217
+ }
218
+ ],
219
+ "responses": {
220
+ "200": {
221
+ "description": "Success.",
222
+ "content": {
223
+ "application/json": {
224
+ "schema": {
225
+ "$ref": "#/components/schemas/ProductResult"
226
+ }
227
+ }
228
+ }
229
+ },
230
+ "400": {
231
+ "description": "Bad Request",
232
+ "content": {
233
+ "application/problem+json": {
234
+ "schema": {
235
+ "$ref": "#/components/schemas/ErrorResponse"
236
+ }
237
+ }
238
+ }
239
+ },
240
+ "401": {
241
+ "$ref": "#/components/responses/401unauthorized"
242
+ }
243
+ },
244
+ "security": [
245
+ {
246
+ "ShopperToken": [
247
+ "sfcc.shopper-products",
248
+ "sfcc.shopper-standard"
249
+ ]
250
+ },
251
+ {
252
+ "ShopperClientContextToken": [
253
+ "sfcc.shopper-products",
254
+ "sfcc.shopper-standard"
255
+ ]
256
+ }
257
+ ]
258
+ }
259
+ },
260
+ "/organizations/{organizationId}/products/{id}": {
261
+ "get": {
262
+ "operationId": "getProduct",
263
+ "parameters": [
264
+ {
265
+ "name": "organizationId",
266
+ "in": "path",
267
+ "required": true,
268
+ "style": "simple",
269
+ "explode": false,
270
+ "schema": {
271
+ "$ref": "#/components/schemas/OrganizationId"
272
+ }
273
+ },
274
+ {
275
+ "name": "id",
276
+ "in": "path",
277
+ "required": true,
278
+ "style": "simple",
279
+ "explode": false,
280
+ "schema": {
281
+ "$ref": "#/components/schemas/ProductId"
282
+ }
283
+ },
284
+ {
285
+ "name": "inventoryIds",
286
+ "in": "query",
287
+ "required": false,
288
+ "style": "form",
289
+ "explode": false,
290
+ "schema": {
291
+ "type": "array",
292
+ "items": {
293
+ "allOf": [
294
+ {
295
+ "$ref": "#/components/schemas/InventoryId"
296
+ }
297
+ ]
298
+ },
299
+ "maxItems": 5
300
+ }
301
+ },
302
+ {
303
+ "name": "expand",
304
+ "in": "query",
305
+ "required": false,
306
+ "style": "form",
307
+ "explode": false,
308
+ "schema": {
309
+ "type": "array",
310
+ "items": {
311
+ "type": "string",
312
+ "enum": [
313
+ "none",
314
+ "availability",
315
+ "bundled_products",
316
+ "links",
317
+ "promotions",
318
+ "options",
319
+ "images",
320
+ "prices",
321
+ "variations",
322
+ "set_products",
323
+ "recommendations",
324
+ "shipping_methods",
325
+ "page_meta_tags",
326
+ "primary_category"
327
+ ]
328
+ }
329
+ }
330
+ },
331
+ {
332
+ "name": "allImages",
333
+ "in": "query",
334
+ "required": false,
335
+ "style": "form",
336
+ "explode": true,
337
+ "schema": {
338
+ "type": "boolean"
339
+ }
340
+ },
341
+ {
342
+ "name": "imgTypes",
343
+ "in": "query",
344
+ "required": false,
345
+ "style": "form",
346
+ "explode": true,
347
+ "schema": {
348
+ "type": "string",
349
+ "maxLength": 50
350
+ }
351
+ },
352
+ {
353
+ "name": "perPricebook",
354
+ "in": "query",
355
+ "required": false,
356
+ "style": "form",
357
+ "explode": true,
358
+ "schema": {
359
+ "type": "boolean"
360
+ }
361
+ },
362
+ {
363
+ "name": "select",
364
+ "in": "query",
365
+ "required": false,
366
+ "style": "form",
367
+ "explode": true,
368
+ "schema": {
369
+ "$ref": "#/components/schemas/Select"
370
+ }
371
+ },
372
+ {
373
+ "name": "currency",
374
+ "in": "query",
375
+ "required": false,
376
+ "style": "form",
377
+ "explode": true,
378
+ "schema": {
379
+ "$ref": "#/components/schemas/CurrencyCode"
380
+ }
381
+ },
382
+ {
383
+ "name": "locale",
384
+ "in": "query",
385
+ "required": false,
386
+ "style": "form",
387
+ "explode": true,
388
+ "schema": {
389
+ "$ref": "#/components/schemas/LocaleCode"
390
+ }
391
+ },
392
+ {
393
+ "name": "siteId",
394
+ "in": "query",
395
+ "required": true,
396
+ "style": "form",
397
+ "explode": true,
398
+ "schema": {
399
+ "$ref": "#/components/schemas/SiteId"
400
+ }
401
+ },
402
+ {
403
+ "name": "sfdc_usid",
404
+ "in": "header",
405
+ "required": false,
406
+ "style": "simple",
407
+ "explode": false,
408
+ "schema": {
409
+ "type": "string",
410
+ "format": "uuid"
411
+ }
412
+ },
413
+ {
414
+ "name": "sfdc_dw_dnt",
415
+ "in": "header",
416
+ "required": false,
417
+ "style": "simple",
418
+ "explode": false,
419
+ "schema": {
420
+ "type": "string",
421
+ "enum": [
422
+ "0",
423
+ "1"
424
+ ]
425
+ }
426
+ },
427
+ {
428
+ "name": "personalized",
429
+ "in": "query",
430
+ "required": false,
431
+ "style": "form",
432
+ "explode": true,
433
+ "schema": {
434
+ "type": "string",
435
+ "enum": [
436
+ "none"
437
+ ]
438
+ }
439
+ },
440
+ {
441
+ "name": "sfdc_shopper_context",
442
+ "in": "header",
443
+ "required": false,
444
+ "style": "simple",
445
+ "explode": false,
446
+ "schema": {
447
+ "type": "string"
448
+ }
449
+ }
450
+ ],
451
+ "responses": {
452
+ "200": {
453
+ "description": "Success.",
454
+ "content": {
455
+ "application/json": {
456
+ "schema": {
457
+ "$ref": "#/components/schemas/Product"
458
+ }
459
+ }
460
+ }
461
+ },
462
+ "400": {
463
+ "description": "Bad Request.",
464
+ "content": {
465
+ "application/problem+json": {
466
+ "schema": {
467
+ "$ref": "#/components/schemas/ErrorResponse"
468
+ }
469
+ }
470
+ }
471
+ },
472
+ "401": {
473
+ "$ref": "#/components/responses/401unauthorized"
474
+ },
475
+ "404": {
476
+ "description": "Product Not Found.",
477
+ "content": {
478
+ "application/problem+json": {
479
+ "schema": {
480
+ "$ref": "#/components/schemas/ErrorResponse"
481
+ }
482
+ }
483
+ }
484
+ }
485
+ },
486
+ "security": [
487
+ {
488
+ "ShopperToken": [
489
+ "sfcc.shopper-products",
490
+ "sfcc.shopper-standard"
491
+ ]
492
+ },
493
+ {
494
+ "ShopperClientContextToken": [
495
+ "sfcc.shopper-products",
496
+ "sfcc.shopper-standard"
497
+ ]
498
+ }
499
+ ]
500
+ }
501
+ },
502
+ "/organizations/{organizationId}/products/{productId}/images": {
503
+ "get": {
504
+ "operationId": "getProductImages",
505
+ "parameters": [
506
+ {
507
+ "name": "organizationId",
508
+ "in": "path",
509
+ "required": true,
510
+ "style": "simple",
511
+ "explode": false,
512
+ "schema": {
513
+ "$ref": "#/components/schemas/OrganizationId"
514
+ }
515
+ },
516
+ {
517
+ "name": "productId",
518
+ "in": "path",
519
+ "required": true,
520
+ "style": "simple",
521
+ "explode": false,
522
+ "schema": {
523
+ "$ref": "#/components/schemas/ProductId"
524
+ }
525
+ },
526
+ {
527
+ "name": "imgTypes",
528
+ "in": "query",
529
+ "required": false,
530
+ "style": "form",
531
+ "explode": true,
532
+ "schema": {
533
+ "type": "string",
534
+ "maxLength": 50
535
+ }
536
+ },
537
+ {
538
+ "name": "allImages",
539
+ "in": "query",
540
+ "required": false,
541
+ "style": "form",
542
+ "explode": true,
543
+ "schema": {
544
+ "type": "boolean",
545
+ "default": false
546
+ }
547
+ },
548
+ {
549
+ "name": "variationAttribute",
550
+ "in": "query",
551
+ "required": false,
552
+ "style": "form",
553
+ "explode": false,
554
+ "schema": {
555
+ "type": "array",
556
+ "items": {
557
+ "type": "string",
558
+ "maxLength": 256,
559
+ "minLength": 1
560
+ }
561
+ }
562
+ },
563
+ {
564
+ "name": "siteId",
565
+ "in": "query",
566
+ "required": true,
567
+ "style": "form",
568
+ "explode": true,
569
+ "schema": {
570
+ "$ref": "#/components/schemas/SiteId"
571
+ }
572
+ },
573
+ {
574
+ "name": "locale",
575
+ "in": "query",
576
+ "required": false,
577
+ "style": "form",
578
+ "explode": true,
579
+ "schema": {
580
+ "$ref": "#/components/schemas/LocaleCode"
581
+ }
582
+ },
583
+ {
584
+ "name": "sfdc_usid",
585
+ "in": "header",
586
+ "required": false,
587
+ "style": "simple",
588
+ "explode": false,
589
+ "schema": {
590
+ "type": "string",
591
+ "format": "uuid"
592
+ }
593
+ },
594
+ {
595
+ "name": "sfdc_dw_dnt",
596
+ "in": "header",
597
+ "required": false,
598
+ "style": "simple",
599
+ "explode": false,
600
+ "schema": {
601
+ "type": "string",
602
+ "enum": [
603
+ "0",
604
+ "1"
605
+ ]
606
+ }
607
+ },
608
+ {
609
+ "name": "personalized",
610
+ "in": "query",
611
+ "required": false,
612
+ "style": "form",
613
+ "explode": true,
614
+ "schema": {
615
+ "type": "string",
616
+ "enum": [
617
+ "none"
618
+ ]
619
+ }
620
+ },
621
+ {
622
+ "name": "sfdc_shopper_context",
623
+ "in": "header",
624
+ "required": false,
625
+ "style": "simple",
626
+ "explode": false,
627
+ "schema": {
628
+ "type": "string"
629
+ }
630
+ }
631
+ ],
632
+ "responses": {
633
+ "200": {
634
+ "description": "Success.",
635
+ "content": {
636
+ "application/json": {
637
+ "schema": {
638
+ "$ref": "#/components/schemas/ProductImages"
639
+ }
640
+ }
641
+ }
642
+ },
643
+ "400": {
644
+ "description": "Bad Request.",
645
+ "content": {
646
+ "application/problem+json": {
647
+ "schema": {
648
+ "$ref": "#/components/schemas/ErrorResponse"
649
+ }
650
+ }
651
+ }
652
+ },
653
+ "401": {
654
+ "$ref": "#/components/responses/401unauthorized"
655
+ },
656
+ "404": {
657
+ "description": "Product Not Found.",
658
+ "content": {
659
+ "application/problem+json": {
660
+ "schema": {
661
+ "$ref": "#/components/schemas/ErrorResponse"
662
+ }
663
+ }
664
+ }
665
+ }
666
+ },
667
+ "security": [
668
+ {
669
+ "ShopperToken": [
670
+ "sfcc.shopper-products"
671
+ ]
672
+ },
673
+ {
674
+ "ShopperClientContextToken": [
675
+ "sfcc.shopper-products"
676
+ ]
677
+ }
678
+ ],
679
+ "x-extensionPoints": [
680
+ {
681
+ "phase": "before",
682
+ "name": "sfcc.product.shopper-products.v1.products.productId.images.beforeGET",
683
+ "description": "Called before retrieving product images.",
684
+ "arguments": [
685
+ {
686
+ "$ref": "#/components/parameters/productId"
687
+ },
688
+ {
689
+ "$ref": "#/components/parameters/imgTypes"
690
+ },
691
+ {
692
+ "$ref": "#/components/parameters/allImages"
693
+ },
694
+ {
695
+ "$ref": "#/components/parameters/variationAttribute"
696
+ }
697
+ ]
698
+ },
699
+ {
700
+ "phase": "modifyResponse",
701
+ "name": "sfcc.product.shopper-products.v1.products.productId.images.modifyGETResponse",
702
+ "description": "Called to modify the product images response.",
703
+ "arguments": [
704
+ {
705
+ "$ref": "#/components/schemas/ProductImages"
706
+ }
707
+ ]
708
+ }
709
+ ]
710
+ }
711
+ },
712
+ "/organizations/{organizationId}/products/{productId}/prices": {
713
+ "get": {
714
+ "operationId": "getProductPrices",
715
+ "parameters": [
716
+ {
717
+ "name": "organizationId",
718
+ "in": "path",
719
+ "required": true,
720
+ "style": "simple",
721
+ "explode": false,
722
+ "schema": {
723
+ "$ref": "#/components/schemas/OrganizationId"
724
+ }
725
+ },
726
+ {
727
+ "name": "productId",
728
+ "in": "path",
729
+ "required": true,
730
+ "style": "simple",
731
+ "explode": false,
732
+ "schema": {
733
+ "$ref": "#/components/schemas/ProductId"
734
+ }
735
+ },
736
+ {
737
+ "name": "siteId",
738
+ "in": "query",
739
+ "required": true,
740
+ "style": "form",
741
+ "explode": true,
742
+ "schema": {
743
+ "$ref": "#/components/schemas/SiteId"
744
+ }
745
+ },
746
+ {
747
+ "name": "locale",
748
+ "in": "query",
749
+ "required": false,
750
+ "style": "form",
751
+ "explode": true,
752
+ "schema": {
753
+ "$ref": "#/components/schemas/LocaleCode"
754
+ }
755
+ },
756
+ {
757
+ "name": "currency",
758
+ "in": "query",
759
+ "required": false,
760
+ "style": "form",
761
+ "explode": true,
762
+ "schema": {
763
+ "$ref": "#/components/schemas/CurrencyCode"
764
+ }
765
+ },
766
+ {
767
+ "name": "sfdc_usid",
768
+ "in": "header",
769
+ "required": false,
770
+ "style": "simple",
771
+ "explode": false,
772
+ "schema": {
773
+ "type": "string",
774
+ "format": "uuid"
775
+ }
776
+ },
777
+ {
778
+ "name": "sfdc_dw_dnt",
779
+ "in": "header",
780
+ "required": false,
781
+ "style": "simple",
782
+ "explode": false,
783
+ "schema": {
784
+ "type": "string",
785
+ "enum": [
786
+ "0",
787
+ "1"
788
+ ]
789
+ }
790
+ },
791
+ {
792
+ "name": "personalized",
793
+ "in": "query",
794
+ "required": false,
795
+ "style": "form",
796
+ "explode": true,
797
+ "schema": {
798
+ "type": "string",
799
+ "enum": [
800
+ "none"
801
+ ]
802
+ }
803
+ },
804
+ {
805
+ "name": "sfdc_shopper_context",
806
+ "in": "header",
807
+ "required": false,
808
+ "style": "simple",
809
+ "explode": false,
810
+ "schema": {
811
+ "type": "string"
812
+ }
813
+ }
814
+ ],
815
+ "responses": {
816
+ "200": {
817
+ "description": "Success.",
818
+ "content": {
819
+ "application/json": {
820
+ "schema": {
821
+ "$ref": "#/components/schemas/PricesResult"
822
+ }
823
+ }
824
+ }
825
+ },
826
+ "400": {
827
+ "description": "Bad Request.",
828
+ "content": {
829
+ "application/problem+json": {
830
+ "schema": {
831
+ "$ref": "#/components/schemas/ErrorResponse"
832
+ }
833
+ }
834
+ }
835
+ },
836
+ "401": {
837
+ "$ref": "#/components/responses/401unauthorized"
838
+ },
839
+ "404": {
840
+ "description": "Product Not Found.",
841
+ "content": {
842
+ "application/problem+json": {
843
+ "schema": {
844
+ "$ref": "#/components/schemas/ErrorResponse"
845
+ }
846
+ }
847
+ }
848
+ }
849
+ },
850
+ "security": [
851
+ {
852
+ "ShopperToken": [
853
+ "sfcc.shopper-products"
854
+ ]
855
+ },
856
+ {
857
+ "ShopperClientContextToken": [
858
+ "sfcc.shopper-products"
859
+ ]
860
+ }
861
+ ],
862
+ "x-extensionPoints": [
863
+ {
864
+ "phase": "before",
865
+ "name": "sfcc.product.shopper-products.v1.products.productId.prices.beforeGET",
866
+ "description": "called before retrieving product price details.",
867
+ "arguments": [
868
+ {
869
+ "$ref": "#/components/parameters/productId"
870
+ },
871
+ {
872
+ "$ref": "#/components/parameters/siteId"
873
+ },
874
+ {
875
+ "$ref": "#/components/parameters/locale"
876
+ },
877
+ {
878
+ "$ref": "#/components/parameters/currency"
879
+ }
880
+ ]
881
+ },
882
+ {
883
+ "phase": "modifyResponse",
884
+ "name": "sfcc.product.shopper-products.v1.products.productId.prices.modifyGETResponse",
885
+ "description": "called to modify the product price details response.",
886
+ "arguments": [
887
+ {
888
+ "$ref": "#/components/schemas/PricesResult"
889
+ }
890
+ ]
891
+ }
892
+ ]
893
+ }
894
+ },
895
+ "/organizations/{organizationId}/products/{productId}/promotions": {
896
+ "get": {
897
+ "operationId": "getProductPromotions",
898
+ "parameters": [
899
+ {
900
+ "name": "organizationId",
901
+ "in": "path",
902
+ "required": true,
903
+ "style": "simple",
904
+ "explode": false,
905
+ "schema": {
906
+ "$ref": "#/components/schemas/OrganizationId"
907
+ }
908
+ },
909
+ {
910
+ "name": "productId",
911
+ "in": "path",
912
+ "required": true,
913
+ "style": "simple",
914
+ "explode": false,
915
+ "schema": {
916
+ "$ref": "#/components/schemas/ProductId"
917
+ }
918
+ },
919
+ {
920
+ "name": "siteId",
921
+ "in": "query",
922
+ "required": true,
923
+ "style": "form",
924
+ "explode": true,
925
+ "schema": {
926
+ "$ref": "#/components/schemas/SiteId"
927
+ }
928
+ },
929
+ {
930
+ "name": "locale",
931
+ "in": "query",
932
+ "required": false,
933
+ "style": "form",
934
+ "explode": true,
935
+ "schema": {
936
+ "$ref": "#/components/schemas/LocaleCode"
937
+ }
938
+ },
939
+ {
940
+ "name": "currency",
941
+ "in": "query",
942
+ "required": false,
943
+ "style": "form",
944
+ "explode": true,
945
+ "schema": {
946
+ "$ref": "#/components/schemas/CurrencyCode"
947
+ }
948
+ },
949
+ {
950
+ "name": "sfdc_usid",
951
+ "in": "header",
952
+ "required": false,
953
+ "style": "simple",
954
+ "explode": false,
955
+ "schema": {
956
+ "type": "string",
957
+ "format": "uuid"
958
+ }
959
+ },
960
+ {
961
+ "name": "sfdc_dw_dnt",
962
+ "in": "header",
963
+ "required": false,
964
+ "style": "simple",
965
+ "explode": false,
966
+ "schema": {
967
+ "type": "string",
968
+ "enum": [
969
+ "0",
970
+ "1"
971
+ ]
972
+ }
973
+ },
974
+ {
975
+ "name": "personalized",
976
+ "in": "query",
977
+ "required": false,
978
+ "style": "form",
979
+ "explode": true,
980
+ "schema": {
981
+ "type": "string",
982
+ "enum": [
983
+ "none"
984
+ ]
985
+ }
986
+ },
987
+ {
988
+ "name": "sfdc_shopper_context",
989
+ "in": "header",
990
+ "required": false,
991
+ "style": "simple",
992
+ "explode": false,
993
+ "schema": {
994
+ "type": "string"
995
+ }
996
+ }
997
+ ],
998
+ "responses": {
999
+ "200": {
1000
+ "description": "Success.",
1001
+ "content": {
1002
+ "application/json": {
1003
+ "schema": {
1004
+ "$ref": "#/components/schemas/PromotionsResult"
1005
+ }
1006
+ }
1007
+ }
1008
+ },
1009
+ "400": {
1010
+ "description": "Bad Request.",
1011
+ "content": {
1012
+ "application/problem+json": {
1013
+ "schema": {
1014
+ "$ref": "#/components/schemas/ErrorResponse"
1015
+ }
1016
+ }
1017
+ }
1018
+ },
1019
+ "401": {
1020
+ "$ref": "#/components/responses/401unauthorized"
1021
+ },
1022
+ "404": {
1023
+ "description": "Product Not Found.",
1024
+ "content": {
1025
+ "application/problem+json": {
1026
+ "schema": {
1027
+ "$ref": "#/components/schemas/ErrorResponse"
1028
+ }
1029
+ }
1030
+ }
1031
+ }
1032
+ },
1033
+ "security": [
1034
+ {
1035
+ "ShopperToken": [
1036
+ "sfcc.shopper-products"
1037
+ ]
1038
+ },
1039
+ {
1040
+ "ShopperClientContextToken": [
1041
+ "sfcc.shopper-products"
1042
+ ]
1043
+ }
1044
+ ],
1045
+ "x-extensionPoints": [
1046
+ {
1047
+ "phase": "before",
1048
+ "name": "sfcc.product.shopper-products.v1.products.productId.promotions.beforeGET",
1049
+ "description": "called before retrieving product promotion details.",
1050
+ "arguments": [
1051
+ {
1052
+ "$ref": "#/components/parameters/productId"
1053
+ },
1054
+ {
1055
+ "$ref": "#/components/parameters/siteId"
1056
+ },
1057
+ {
1058
+ "$ref": "#/components/parameters/locale"
1059
+ },
1060
+ {
1061
+ "$ref": "#/components/parameters/currency"
1062
+ }
1063
+ ]
1064
+ },
1065
+ {
1066
+ "phase": "modifyResponse",
1067
+ "name": "sfcc.product.shopper-products.v1.products.productId.promotions.modifyGETResponse",
1068
+ "description": "called to modify the product promotions response.",
1069
+ "arguments": [
1070
+ {
1071
+ "$ref": "#/components/schemas/PromotionsResult"
1072
+ }
1073
+ ]
1074
+ }
1075
+ ]
1076
+ }
1077
+ },
1078
+ "/organizations/{organizationId}/categories": {
1079
+ "get": {
1080
+ "operationId": "getCategories",
1081
+ "parameters": [
1082
+ {
1083
+ "name": "organizationId",
1084
+ "in": "path",
1085
+ "required": true,
1086
+ "style": "simple",
1087
+ "explode": false,
1088
+ "schema": {
1089
+ "$ref": "#/components/schemas/OrganizationId"
1090
+ }
1091
+ },
1092
+ {
1093
+ "name": "ids",
1094
+ "in": "query",
1095
+ "required": true,
1096
+ "style": "form",
1097
+ "explode": false,
1098
+ "schema": {
1099
+ "type": "array",
1100
+ "items": {
1101
+ "allOf": [
1102
+ {
1103
+ "$ref": "#/components/schemas/CategoryId"
1104
+ }
1105
+ ]
1106
+ },
1107
+ "maxItems": 50
1108
+ }
1109
+ },
1110
+ {
1111
+ "name": "levels",
1112
+ "in": "query",
1113
+ "required": false,
1114
+ "style": "form",
1115
+ "explode": true,
1116
+ "schema": {
1117
+ "type": "integer",
1118
+ "format": "int32",
1119
+ "enum": [
1120
+ 0,
1121
+ 1,
1122
+ 2
1123
+ ],
1124
+ "minimum": 0
1125
+ }
1126
+ },
1127
+ {
1128
+ "name": "locale",
1129
+ "in": "query",
1130
+ "required": false,
1131
+ "style": "form",
1132
+ "explode": true,
1133
+ "schema": {
1134
+ "$ref": "#/components/schemas/LocaleCode"
1135
+ }
1136
+ },
1137
+ {
1138
+ "name": "siteId",
1139
+ "in": "query",
1140
+ "required": true,
1141
+ "style": "form",
1142
+ "explode": true,
1143
+ "schema": {
1144
+ "$ref": "#/components/schemas/SiteId"
1145
+ }
1146
+ },
1147
+ {
1148
+ "name": "sfdc_usid",
1149
+ "in": "header",
1150
+ "required": false,
1151
+ "style": "simple",
1152
+ "explode": false,
1153
+ "schema": {
1154
+ "type": "string",
1155
+ "format": "uuid"
1156
+ }
1157
+ },
1158
+ {
1159
+ "name": "sfdc_dw_dnt",
1160
+ "in": "header",
1161
+ "required": false,
1162
+ "style": "simple",
1163
+ "explode": false,
1164
+ "schema": {
1165
+ "type": "string",
1166
+ "enum": [
1167
+ "0",
1168
+ "1"
1169
+ ]
1170
+ }
1171
+ },
1172
+ {
1173
+ "name": "personalized",
1174
+ "in": "query",
1175
+ "required": false,
1176
+ "style": "form",
1177
+ "explode": true,
1178
+ "schema": {
1179
+ "type": "string",
1180
+ "enum": [
1181
+ "none"
1182
+ ]
1183
+ }
1184
+ },
1185
+ {
1186
+ "name": "sfdc_shopper_context",
1187
+ "in": "header",
1188
+ "required": false,
1189
+ "style": "simple",
1190
+ "explode": false,
1191
+ "schema": {
1192
+ "type": "string"
1193
+ }
1194
+ }
1195
+ ],
1196
+ "responses": {
1197
+ "200": {
1198
+ "description": "Success.",
1199
+ "content": {
1200
+ "application/json": {
1201
+ "schema": {
1202
+ "$ref": "#/components/schemas/CategoryResult"
1203
+ }
1204
+ }
1205
+ }
1206
+ },
1207
+ "400": {
1208
+ "description": "Bad Request.",
1209
+ "content": {
1210
+ "application/problem+json": {
1211
+ "schema": {
1212
+ "$ref": "#/components/schemas/ErrorResponse"
1213
+ }
1214
+ }
1215
+ }
1216
+ },
1217
+ "401": {
1218
+ "$ref": "#/components/responses/401unauthorized"
1219
+ }
1220
+ },
1221
+ "security": [
1222
+ {
1223
+ "ShopperToken": [
1224
+ "sfcc.shopper-categories",
1225
+ "sfcc.shopper-standard"
1226
+ ]
1227
+ },
1228
+ {
1229
+ "ShopperClientContextToken": [
1230
+ "sfcc.shopper-categories",
1231
+ "sfcc.shopper-standard"
1232
+ ]
1233
+ }
1234
+ ]
1235
+ }
1236
+ },
1237
+ "/organizations/{organizationId}/categories/{id}": {
1238
+ "get": {
1239
+ "operationId": "getCategory",
1240
+ "parameters": [
1241
+ {
1242
+ "name": "id",
1243
+ "in": "path",
1244
+ "required": true,
1245
+ "style": "simple",
1246
+ "explode": false,
1247
+ "schema": {
1248
+ "$ref": "#/components/schemas/CategoryId"
1249
+ }
1250
+ },
1251
+ {
1252
+ "name": "organizationId",
1253
+ "in": "path",
1254
+ "required": true,
1255
+ "style": "simple",
1256
+ "explode": false,
1257
+ "schema": {
1258
+ "$ref": "#/components/schemas/OrganizationId"
1259
+ }
1260
+ },
1261
+ {
1262
+ "name": "levels",
1263
+ "in": "query",
1264
+ "required": false,
1265
+ "style": "form",
1266
+ "explode": true,
1267
+ "schema": {
1268
+ "type": "integer",
1269
+ "format": "int32",
1270
+ "enum": [
1271
+ 0,
1272
+ 1,
1273
+ 2
1274
+ ],
1275
+ "minimum": 0
1276
+ }
1277
+ },
1278
+ {
1279
+ "name": "locale",
1280
+ "in": "query",
1281
+ "required": false,
1282
+ "style": "form",
1283
+ "explode": true,
1284
+ "schema": {
1285
+ "$ref": "#/components/schemas/LocaleCode"
1286
+ }
1287
+ },
1288
+ {
1289
+ "name": "siteId",
1290
+ "in": "query",
1291
+ "required": true,
1292
+ "style": "form",
1293
+ "explode": true,
1294
+ "schema": {
1295
+ "$ref": "#/components/schemas/SiteId"
1296
+ }
1297
+ },
1298
+ {
1299
+ "name": "sfdc_usid",
1300
+ "in": "header",
1301
+ "required": false,
1302
+ "style": "simple",
1303
+ "explode": false,
1304
+ "schema": {
1305
+ "type": "string",
1306
+ "format": "uuid"
1307
+ }
1308
+ },
1309
+ {
1310
+ "name": "sfdc_dw_dnt",
1311
+ "in": "header",
1312
+ "required": false,
1313
+ "style": "simple",
1314
+ "explode": false,
1315
+ "schema": {
1316
+ "type": "string",
1317
+ "enum": [
1318
+ "0",
1319
+ "1"
1320
+ ]
1321
+ }
1322
+ },
1323
+ {
1324
+ "name": "personalized",
1325
+ "in": "query",
1326
+ "required": false,
1327
+ "style": "form",
1328
+ "explode": true,
1329
+ "schema": {
1330
+ "type": "string",
1331
+ "enum": [
1332
+ "none"
1333
+ ]
1334
+ }
1335
+ },
1336
+ {
1337
+ "name": "sfdc_shopper_context",
1338
+ "in": "header",
1339
+ "required": false,
1340
+ "style": "simple",
1341
+ "explode": false,
1342
+ "schema": {
1343
+ "type": "string"
1344
+ }
1345
+ }
1346
+ ],
1347
+ "responses": {
1348
+ "200": {
1349
+ "description": "Success.",
1350
+ "content": {
1351
+ "application/json": {
1352
+ "schema": {
1353
+ "$ref": "#/components/schemas/Category"
1354
+ }
1355
+ }
1356
+ }
1357
+ },
1358
+ "400": {
1359
+ "description": "Bad Request.",
1360
+ "content": {
1361
+ "application/problem+json": {
1362
+ "schema": {
1363
+ "$ref": "#/components/schemas/ErrorResponse"
1364
+ }
1365
+ }
1366
+ }
1367
+ },
1368
+ "401": {
1369
+ "$ref": "#/components/responses/401unauthorized"
1370
+ },
1371
+ "404": {
1372
+ "description": "No online or offline category was found with the specified ID.",
1373
+ "content": {
1374
+ "application/problem+json": {
1375
+ "schema": {
1376
+ "$ref": "#/components/schemas/ErrorResponse"
1377
+ }
1378
+ }
1379
+ }
1380
+ }
1381
+ },
1382
+ "security": [
1383
+ {
1384
+ "ShopperToken": [
1385
+ "sfcc.shopper-categories",
1386
+ "sfcc.shopper-standard"
1387
+ ]
1388
+ },
1389
+ {
1390
+ "ShopperClientContextToken": [
1391
+ "sfcc.shopper-categories",
1392
+ "sfcc.shopper-standard"
1393
+ ]
1394
+ }
1395
+ ]
1396
+ }
1397
+ }
1398
+ },
1399
+ "components": {
1400
+ "schemas": {
1401
+ "OrganizationId": {
1402
+ "type": "string",
1403
+ "pattern": "^f_ecom_[a-z]{4}_(prd|stg|dev|s[0-9]{2}|[0-9]{3})$"
1404
+ },
1405
+ "ProductId": {
1406
+ "type": "string",
1407
+ "maxLength": 100,
1408
+ "minLength": 1
1409
+ },
1410
+ "InventoryId": {
1411
+ "type": "string",
1412
+ "maxLength": 256,
1413
+ "minLength": 1
1414
+ },
1415
+ "SiteId": {
1416
+ "type": "string",
1417
+ "maxLength": 32,
1418
+ "minLength": 1
1419
+ },
1420
+ "Select": {
1421
+ "type": "string",
1422
+ "minLength": 1,
1423
+ "pattern": "^[(].*[)]$"
1424
+ },
1425
+ "LanguageCountry": {
1426
+ "type": "string",
1427
+ "pattern": "^[a-z][a-z]-[A-Z][A-Z]$"
1428
+ },
1429
+ "LanguageCode": {
1430
+ "type": "string",
1431
+ "pattern": "^[a-z][a-z]$"
1432
+ },
1433
+ "DefaultFallback": {
1434
+ "type": "string",
1435
+ "default": "default",
1436
+ "pattern": "^default$"
1437
+ },
1438
+ "LocaleCode": {
1439
+ "oneOf": [
1440
+ {
1441
+ "$ref": "#/components/schemas/LanguageCountry"
1442
+ },
1443
+ {
1444
+ "$ref": "#/components/schemas/LanguageCode"
1445
+ },
1446
+ {
1447
+ "$ref": "#/components/schemas/DefaultFallback"
1448
+ }
1449
+ ]
1450
+ },
1451
+ "CurrencyCode": {
1452
+ "type": "string",
1453
+ "pattern": "^([A-Z][A-Z][A-Z]|N/A)$"
1454
+ },
1455
+ "Product": {
1456
+ "type": "object",
1457
+ "additionalProperties": {},
1458
+ "properties": {
1459
+ "brand": {
1460
+ "type": "string"
1461
+ },
1462
+ "bundledProducts": {
1463
+ "type": "array",
1464
+ "items": {
1465
+ "$ref": "#/components/schemas/BundledProduct"
1466
+ }
1467
+ },
1468
+ "currency": {
1469
+ "$ref": "#/components/schemas/CurrencyCode"
1470
+ },
1471
+ "ean": {
1472
+ "type": "string"
1473
+ },
1474
+ "fetchDate": {
1475
+ "type": "integer",
1476
+ "format": "int32"
1477
+ },
1478
+ "id": {
1479
+ "$ref": "#/components/schemas/ProductId"
1480
+ },
1481
+ "imageGroups": {
1482
+ "type": "array",
1483
+ "items": {
1484
+ "$ref": "#/components/schemas/ImageGroup"
1485
+ }
1486
+ },
1487
+ "inventories": {
1488
+ "type": "array",
1489
+ "items": {
1490
+ "$ref": "#/components/schemas/Inventory"
1491
+ }
1492
+ },
1493
+ "inventory": {
1494
+ "allOf": [
1495
+ {
1496
+ "$ref": "#/components/schemas/Inventory"
1497
+ }
1498
+ ]
1499
+ },
1500
+ "longDescription": {
1501
+ "type": "string"
1502
+ },
1503
+ "manufacturerName": {
1504
+ "type": "string"
1505
+ },
1506
+ "manufacturerSku": {
1507
+ "type": "string"
1508
+ },
1509
+ "master": {
1510
+ "allOf": [
1511
+ {
1512
+ "$ref": "#/components/schemas/Master"
1513
+ }
1514
+ ]
1515
+ },
1516
+ "minOrderQuantity": {
1517
+ "type": "number",
1518
+ "format": "double"
1519
+ },
1520
+ "name": {
1521
+ "type": "string"
1522
+ },
1523
+ "options": {
1524
+ "type": "array",
1525
+ "items": {
1526
+ "$ref": "#/components/schemas/Option"
1527
+ }
1528
+ },
1529
+ "pageDescription": {
1530
+ "type": "string"
1531
+ },
1532
+ "pageKeywords": {
1533
+ "type": "string"
1534
+ },
1535
+ "pageTitle": {
1536
+ "type": "string"
1537
+ },
1538
+ "pageMetaTags": {
1539
+ "type": "array",
1540
+ "items": {
1541
+ "$ref": "#/components/schemas/PageMetaTag"
1542
+ }
1543
+ },
1544
+ "price": {
1545
+ "type": "number",
1546
+ "format": "double"
1547
+ },
1548
+ "pricePerUnit": {
1549
+ "type": "number",
1550
+ "format": "double"
1551
+ },
1552
+ "pricePerUnitMax": {
1553
+ "type": "number",
1554
+ "format": "double"
1555
+ },
1556
+ "priceMax": {
1557
+ "type": "number",
1558
+ "format": "double"
1559
+ },
1560
+ "priceRanges": {
1561
+ "type": "array",
1562
+ "items": {
1563
+ "$ref": "#/components/schemas/PriceRange"
1564
+ }
1565
+ },
1566
+ "prices": {
1567
+ "type": "object",
1568
+ "additionalProperties": {
1569
+ "type": "number",
1570
+ "format": "double"
1571
+ }
1572
+ },
1573
+ "primaryCategoryId": {
1574
+ "type": "string"
1575
+ },
1576
+ "primaryCategory": {
1577
+ "type": "object",
1578
+ "properties": {
1579
+ "id": {
1580
+ "type": "string",
1581
+ "maxLength": 256,
1582
+ "minLength": 1
1583
+ },
1584
+ "name": {
1585
+ "type": "string",
1586
+ "maxLength": 256,
1587
+ "minLength": 1
1588
+ },
1589
+ "parentCategoryTree": {
1590
+ "type": "array",
1591
+ "items": {
1592
+ "type": "object",
1593
+ "properties": {
1594
+ "id": {
1595
+ "type": "string",
1596
+ "maxLength": 256,
1597
+ "minLength": 1
1598
+ },
1599
+ "name": {
1600
+ "type": "string",
1601
+ "maxLength": 256,
1602
+ "minLength": 1
1603
+ }
1604
+ }
1605
+ }
1606
+ }
1607
+ }
1608
+ },
1609
+ "productLinks": {
1610
+ "type": "array",
1611
+ "items": {
1612
+ "$ref": "#/components/schemas/ProductLink"
1613
+ }
1614
+ },
1615
+ "productPromotions": {
1616
+ "type": "array",
1617
+ "items": {
1618
+ "$ref": "#/components/schemas/ProductPromotion"
1619
+ }
1620
+ },
1621
+ "recommendations": {
1622
+ "type": "array",
1623
+ "items": {
1624
+ "$ref": "#/components/schemas/Recommendation"
1625
+ }
1626
+ },
1627
+ "setProducts": {
1628
+ "type": "array",
1629
+ "items": {
1630
+ "$ref": "#/components/schemas/Product"
1631
+ }
1632
+ },
1633
+ "shortDescription": {
1634
+ "type": "string"
1635
+ },
1636
+ "slugUrl": {
1637
+ "type": "string"
1638
+ },
1639
+ "stepQuantity": {
1640
+ "type": "number",
1641
+ "format": "double"
1642
+ },
1643
+ "tieredPrices": {
1644
+ "type": "array",
1645
+ "items": {
1646
+ "$ref": "#/components/schemas/ProductPriceTable"
1647
+ }
1648
+ },
1649
+ "type": {
1650
+ "allOf": [
1651
+ {
1652
+ "$ref": "#/components/schemas/ProductType"
1653
+ }
1654
+ ]
1655
+ },
1656
+ "unit": {
1657
+ "type": "string"
1658
+ },
1659
+ "upc": {
1660
+ "type": "string"
1661
+ },
1662
+ "validFrom": {
1663
+ "type": "string",
1664
+ "format": "date-time"
1665
+ },
1666
+ "validTo": {
1667
+ "type": "string",
1668
+ "format": "date-time"
1669
+ },
1670
+ "variants": {
1671
+ "type": "array",
1672
+ "items": {
1673
+ "$ref": "#/components/schemas/Variant"
1674
+ }
1675
+ },
1676
+ "variationAttributes": {
1677
+ "type": "array",
1678
+ "items": {
1679
+ "$ref": "#/components/schemas/VariationAttribute"
1680
+ }
1681
+ },
1682
+ "variationGroups": {
1683
+ "type": "array",
1684
+ "items": {
1685
+ "$ref": "#/components/schemas/VariationGroup"
1686
+ }
1687
+ },
1688
+ "variationValues": {
1689
+ "type": "object",
1690
+ "additionalProperties": {
1691
+ "type": "string"
1692
+ }
1693
+ },
1694
+ "shippingMethods": {
1695
+ "type": "array",
1696
+ "items": {
1697
+ "$ref": "#/components/schemas/ShippingMethod"
1698
+ }
1699
+ }
1700
+ },
1701
+ "required": [
1702
+ "id"
1703
+ ]
1704
+ },
1705
+ "BundledProduct": {
1706
+ "type": "object",
1707
+ "properties": {
1708
+ "id": {
1709
+ "type": "string"
1710
+ },
1711
+ "product": {
1712
+ "allOf": [
1713
+ {
1714
+ "$ref": "#/components/schemas/Product"
1715
+ }
1716
+ ]
1717
+ },
1718
+ "quantity": {
1719
+ "type": "number",
1720
+ "format": "double"
1721
+ }
1722
+ },
1723
+ "required": [
1724
+ "id",
1725
+ "product",
1726
+ "quantity"
1727
+ ]
1728
+ },
1729
+ "Image": {
1730
+ "type": "object",
1731
+ "properties": {
1732
+ "alt": {
1733
+ "type": "string"
1734
+ },
1735
+ "disBaseLink": {
1736
+ "type": "string"
1737
+ },
1738
+ "link": {
1739
+ "type": "string",
1740
+ "minLength": 1
1741
+ },
1742
+ "title": {
1743
+ "type": "string"
1744
+ }
1745
+ },
1746
+ "required": [
1747
+ "link"
1748
+ ]
1749
+ },
1750
+ "VariationAttributeValue": {
1751
+ "type": "object",
1752
+ "properties": {
1753
+ "description": {
1754
+ "type": "string"
1755
+ },
1756
+ "image": {
1757
+ "allOf": [
1758
+ {
1759
+ "$ref": "#/components/schemas/Image"
1760
+ }
1761
+ ]
1762
+ },
1763
+ "imageSwatch": {
1764
+ "allOf": [
1765
+ {
1766
+ "$ref": "#/components/schemas/Image"
1767
+ }
1768
+ ]
1769
+ },
1770
+ "name": {
1771
+ "type": "string"
1772
+ },
1773
+ "orderable": {
1774
+ "type": "boolean"
1775
+ },
1776
+ "value": {
1777
+ "type": "string",
1778
+ "minLength": 1
1779
+ }
1780
+ },
1781
+ "required": [
1782
+ "value"
1783
+ ]
1784
+ },
1785
+ "VariationAttribute": {
1786
+ "type": "object",
1787
+ "properties": {
1788
+ "id": {
1789
+ "type": "string",
1790
+ "minLength": 1
1791
+ },
1792
+ "name": {
1793
+ "type": "string"
1794
+ },
1795
+ "values": {
1796
+ "type": "array",
1797
+ "items": {
1798
+ "$ref": "#/components/schemas/VariationAttributeValue"
1799
+ }
1800
+ }
1801
+ },
1802
+ "required": [
1803
+ "id"
1804
+ ]
1805
+ },
1806
+ "ImageGroup": {
1807
+ "type": "object",
1808
+ "properties": {
1809
+ "images": {
1810
+ "type": "array",
1811
+ "items": {
1812
+ "$ref": "#/components/schemas/Image"
1813
+ }
1814
+ },
1815
+ "variationAttributes": {
1816
+ "type": "array",
1817
+ "items": {
1818
+ "$ref": "#/components/schemas/VariationAttribute"
1819
+ }
1820
+ },
1821
+ "viewType": {
1822
+ "type": "string"
1823
+ }
1824
+ },
1825
+ "required": [
1826
+ "images",
1827
+ "viewType"
1828
+ ]
1829
+ },
1830
+ "Inventory": {
1831
+ "type": "object",
1832
+ "properties": {
1833
+ "ats": {
1834
+ "type": "number",
1835
+ "format": "double"
1836
+ },
1837
+ "backorderable": {
1838
+ "type": "boolean"
1839
+ },
1840
+ "id": {
1841
+ "$ref": "#/components/schemas/InventoryId"
1842
+ },
1843
+ "inStockDate": {
1844
+ "type": "string",
1845
+ "format": "date-time"
1846
+ },
1847
+ "orderable": {
1848
+ "type": "boolean"
1849
+ },
1850
+ "preorderable": {
1851
+ "type": "boolean"
1852
+ },
1853
+ "stockLevel": {
1854
+ "type": "number",
1855
+ "format": "double"
1856
+ }
1857
+ },
1858
+ "required": [
1859
+ "id"
1860
+ ]
1861
+ },
1862
+ "Price": {
1863
+ "type": "number",
1864
+ "format": "double"
1865
+ },
1866
+ "Master": {
1867
+ "type": "object",
1868
+ "properties": {
1869
+ "masterId": {
1870
+ "allOf": [
1871
+ {
1872
+ "$ref": "#/components/schemas/ProductId"
1873
+ }
1874
+ ]
1875
+ },
1876
+ "orderable": {
1877
+ "type": "boolean"
1878
+ },
1879
+ "price": {
1880
+ "allOf": [
1881
+ {
1882
+ "$ref": "#/components/schemas/Price"
1883
+ }
1884
+ ]
1885
+ },
1886
+ "priceMax": {
1887
+ "allOf": [
1888
+ {
1889
+ "$ref": "#/components/schemas/Price"
1890
+ }
1891
+ ]
1892
+ },
1893
+ "prices": {
1894
+ "type": "object",
1895
+ "additionalProperties": {
1896
+ "type": "number",
1897
+ "format": "double"
1898
+ }
1899
+ }
1900
+ },
1901
+ "required": [
1902
+ "masterId"
1903
+ ]
1904
+ },
1905
+ "OptionValue": {
1906
+ "type": "object",
1907
+ "properties": {
1908
+ "default": {
1909
+ "type": "boolean"
1910
+ },
1911
+ "id": {
1912
+ "allOf": [
1913
+ {
1914
+ "$ref": "#/components/schemas/ProductId"
1915
+ }
1916
+ ]
1917
+ },
1918
+ "name": {
1919
+ "type": "string"
1920
+ },
1921
+ "price": {
1922
+ "allOf": [
1923
+ {
1924
+ "$ref": "#/components/schemas/Price"
1925
+ }
1926
+ ]
1927
+ }
1928
+ },
1929
+ "required": [
1930
+ "id"
1931
+ ]
1932
+ },
1933
+ "Option": {
1934
+ "type": "object",
1935
+ "properties": {
1936
+ "description": {
1937
+ "type": "string"
1938
+ },
1939
+ "id": {
1940
+ "allOf": [
1941
+ {
1942
+ "$ref": "#/components/schemas/ProductId"
1943
+ }
1944
+ ]
1945
+ },
1946
+ "image": {
1947
+ "type": "string"
1948
+ },
1949
+ "name": {
1950
+ "type": "string"
1951
+ },
1952
+ "values": {
1953
+ "type": "array",
1954
+ "items": {
1955
+ "$ref": "#/components/schemas/OptionValue"
1956
+ }
1957
+ }
1958
+ },
1959
+ "required": [
1960
+ "id"
1961
+ ]
1962
+ },
1963
+ "PageMetaTag": {
1964
+ "properties": {
1965
+ "id": {
1966
+ "type": "string"
1967
+ },
1968
+ "value": {
1969
+ "type": "string"
1970
+ },
1971
+ "type": {
1972
+ "type": "string",
1973
+ "maxLength": 64
1974
+ }
1975
+ }
1976
+ },
1977
+ "PriceRange": {
1978
+ "type": "object",
1979
+ "properties": {
1980
+ "maxPrice": {
1981
+ "allOf": [
1982
+ {
1983
+ "$ref": "#/components/schemas/Price"
1984
+ }
1985
+ ]
1986
+ },
1987
+ "minPrice": {
1988
+ "allOf": [
1989
+ {
1990
+ "$ref": "#/components/schemas/Price"
1991
+ }
1992
+ ]
1993
+ },
1994
+ "pricebook": {
1995
+ "type": "string"
1996
+ }
1997
+ }
1998
+ },
1999
+ "ProductLink": {
2000
+ "type": "object",
2001
+ "properties": {
2002
+ "sourceProductId": {
2003
+ "allOf": [
2004
+ {
2005
+ "$ref": "#/components/schemas/ProductId"
2006
+ }
2007
+ ]
2008
+ },
2009
+ "sourceProductLink": {
2010
+ "type": "string"
2011
+ },
2012
+ "targetProductId": {
2013
+ "allOf": [
2014
+ {
2015
+ "$ref": "#/components/schemas/ProductId"
2016
+ }
2017
+ ]
2018
+ },
2019
+ "targetProductLink": {
2020
+ "type": "string"
2021
+ },
2022
+ "type": {
2023
+ "type": "string",
2024
+ "enum": [
2025
+ "cross_sell",
2026
+ "replacement",
2027
+ "up_sell",
2028
+ "accessory",
2029
+ "newer_version",
2030
+ "alt_orderunit",
2031
+ "spare_part",
2032
+ "other"
2033
+ ]
2034
+ }
2035
+ },
2036
+ "required": [
2037
+ "sourceProductId",
2038
+ "sourceProductLink",
2039
+ "targetProductId",
2040
+ "targetProductLink",
2041
+ "type"
2042
+ ]
2043
+ },
2044
+ "ProductPromotion": {
2045
+ "type": "object",
2046
+ "properties": {
2047
+ "calloutMsg": {
2048
+ "type": "string"
2049
+ },
2050
+ "promotionId": {
2051
+ "type": "string"
2052
+ },
2053
+ "promotionalPrice": {
2054
+ "allOf": [
2055
+ {
2056
+ "$ref": "#/components/schemas/Price"
2057
+ }
2058
+ ]
2059
+ }
2060
+ },
2061
+ "required": [
2062
+ "calloutMsg",
2063
+ "promotionId",
2064
+ "promotionalPrice"
2065
+ ]
2066
+ },
2067
+ "RecommendationType": {
2068
+ "type": "object",
2069
+ "properties": {
2070
+ "displayValue": {
2071
+ "type": "string"
2072
+ },
2073
+ "value": {
2074
+ "type": "integer",
2075
+ "format": "int32"
2076
+ }
2077
+ },
2078
+ "required": [
2079
+ "displayValue",
2080
+ "value"
2081
+ ]
2082
+ },
2083
+ "Recommendation": {
2084
+ "type": "object",
2085
+ "properties": {
2086
+ "calloutMsg": {
2087
+ "type": "string"
2088
+ },
2089
+ "image": {
2090
+ "$ref": "#/components/schemas/Image"
2091
+ },
2092
+ "longDescription": {
2093
+ "type": "string"
2094
+ },
2095
+ "name": {
2096
+ "type": "string"
2097
+ },
2098
+ "recommendationType": {
2099
+ "$ref": "#/components/schemas/RecommendationType"
2100
+ },
2101
+ "recommendedItemId": {
2102
+ "type": "string"
2103
+ },
2104
+ "shortDescription": {
2105
+ "type": "string"
2106
+ }
2107
+ },
2108
+ "required": [
2109
+ "recommendationType"
2110
+ ]
2111
+ },
2112
+ "ProductPriceTable": {
2113
+ "type": "object",
2114
+ "properties": {
2115
+ "price": {
2116
+ "allOf": [
2117
+ {
2118
+ "$ref": "#/components/schemas/Price"
2119
+ }
2120
+ ]
2121
+ },
2122
+ "pricebook": {
2123
+ "type": "string"
2124
+ },
2125
+ "quantity": {
2126
+ "type": "number",
2127
+ "format": "double"
2128
+ }
2129
+ }
2130
+ },
2131
+ "ProductType": {
2132
+ "type": "object",
2133
+ "properties": {
2134
+ "bundle": {
2135
+ "type": "boolean"
2136
+ },
2137
+ "item": {
2138
+ "type": "boolean"
2139
+ },
2140
+ "master": {
2141
+ "type": "boolean"
2142
+ },
2143
+ "option": {
2144
+ "type": "boolean"
2145
+ },
2146
+ "set": {
2147
+ "type": "boolean"
2148
+ },
2149
+ "variant": {
2150
+ "type": "boolean"
2151
+ },
2152
+ "variationGroup": {
2153
+ "type": "boolean"
2154
+ }
2155
+ }
2156
+ },
2157
+ "Variant": {
2158
+ "type": "object",
2159
+ "properties": {
2160
+ "orderable": {
2161
+ "type": "boolean"
2162
+ },
2163
+ "price": {
2164
+ "allOf": [
2165
+ {
2166
+ "$ref": "#/components/schemas/Price"
2167
+ }
2168
+ ]
2169
+ },
2170
+ "productId": {
2171
+ "allOf": [
2172
+ {
2173
+ "$ref": "#/components/schemas/ProductId"
2174
+ }
2175
+ ]
2176
+ },
2177
+ "tieredPrices": {
2178
+ "type": "array",
2179
+ "items": {
2180
+ "$ref": "#/components/schemas/ProductPriceTable"
2181
+ }
2182
+ },
2183
+ "variationValues": {
2184
+ "type": "object",
2185
+ "additionalProperties": {
2186
+ "type": "string"
2187
+ }
2188
+ }
2189
+ },
2190
+ "required": [
2191
+ "productId"
2192
+ ]
2193
+ },
2194
+ "VariationGroup": {
2195
+ "type": "object",
2196
+ "properties": {
2197
+ "orderable": {
2198
+ "type": "boolean"
2199
+ },
2200
+ "price": {
2201
+ "allOf": [
2202
+ {
2203
+ "$ref": "#/components/schemas/Price"
2204
+ }
2205
+ ]
2206
+ },
2207
+ "productId": {
2208
+ "allOf": [
2209
+ {
2210
+ "$ref": "#/components/schemas/ProductId"
2211
+ }
2212
+ ]
2213
+ },
2214
+ "variationValues": {
2215
+ "type": "object",
2216
+ "additionalProperties": {
2217
+ "type": "string"
2218
+ }
2219
+ }
2220
+ },
2221
+ "required": [
2222
+ "orderable",
2223
+ "price",
2224
+ "productId",
2225
+ "variationValues"
2226
+ ]
2227
+ },
2228
+ "ShippingPromotion": {
2229
+ "type": "object",
2230
+ "additionalProperties": {},
2231
+ "properties": {
2232
+ "calloutMsg": {
2233
+ "type": "string"
2234
+ },
2235
+ "promotionId": {
2236
+ "type": "string"
2237
+ },
2238
+ "promotionName": {
2239
+ "type": "string"
2240
+ }
2241
+ }
2242
+ },
2243
+ "ShippingMethod": {
2244
+ "type": "object",
2245
+ "additionalProperties": {},
2246
+ "properties": {
2247
+ "description": {
2248
+ "type": "string"
2249
+ },
2250
+ "externalShippingMethod": {
2251
+ "type": "string"
2252
+ },
2253
+ "id": {
2254
+ "type": "string",
2255
+ "maxLength": 256
2256
+ },
2257
+ "name": {
2258
+ "type": "string"
2259
+ },
2260
+ "price": {
2261
+ "type": "number",
2262
+ "format": "double"
2263
+ },
2264
+ "shippingPromotions": {
2265
+ "type": "array",
2266
+ "items": {
2267
+ "$ref": "#/components/schemas/ShippingPromotion"
2268
+ }
2269
+ }
2270
+ },
2271
+ "required": [
2272
+ "id"
2273
+ ]
2274
+ },
2275
+ "ProductResult": {
2276
+ "type": "object",
2277
+ "properties": {
2278
+ "limit": {
2279
+ "type": "integer",
2280
+ "format": "int32"
2281
+ },
2282
+ "data": {
2283
+ "type": "array",
2284
+ "items": {
2285
+ "$ref": "#/components/schemas/Product"
2286
+ }
2287
+ },
2288
+ "total": {
2289
+ "type": "integer",
2290
+ "format": "int32"
2291
+ }
2292
+ },
2293
+ "required": [
2294
+ "data",
2295
+ "limit",
2296
+ "total"
2297
+ ]
2298
+ },
2299
+ "ErrorResponse": {
2300
+ "type": "object",
2301
+ "additionalProperties": true,
2302
+ "properties": {
2303
+ "title": {
2304
+ "type": "string",
2305
+ "maxLength": 256
2306
+ },
2307
+ "type": {
2308
+ "type": "string",
2309
+ "maxLength": 2048
2310
+ },
2311
+ "detail": {
2312
+ "type": "string"
2313
+ },
2314
+ "instance": {
2315
+ "type": "string",
2316
+ "maxLength": 2048
2317
+ }
2318
+ },
2319
+ "required": [
2320
+ "detail",
2321
+ "title",
2322
+ "type"
2323
+ ]
2324
+ },
2325
+ "ProductImages": {
2326
+ "type": "object",
2327
+ "properties": {
2328
+ "id": {
2329
+ "$ref": "#/components/schemas/ProductId"
2330
+ },
2331
+ "imageGroups": {
2332
+ "type": "array",
2333
+ "items": {
2334
+ "$ref": "#/components/schemas/ImageGroup"
2335
+ }
2336
+ }
2337
+ },
2338
+ "required": [
2339
+ "id"
2340
+ ]
2341
+ },
2342
+ "ProductPriceRange": {
2343
+ "type": "object",
2344
+ "properties": {
2345
+ "pricebook": {
2346
+ "type": "string",
2347
+ "maxLength": 256,
2348
+ "minLength": 1
2349
+ },
2350
+ "minPrice": {
2351
+ "type": "number",
2352
+ "format": "double"
2353
+ },
2354
+ "maxPrice": {
2355
+ "type": "number",
2356
+ "format": "double"
2357
+ }
2358
+ }
2359
+ },
2360
+ "PricesResult": {
2361
+ "type": "object",
2362
+ "properties": {
2363
+ "productId": {
2364
+ "type": "string",
2365
+ "maxLength": 100,
2366
+ "minLength": 1
2367
+ },
2368
+ "price": {
2369
+ "type": "number",
2370
+ "format": "double"
2371
+ },
2372
+ "priceMax": {
2373
+ "type": "number",
2374
+ "format": "double"
2375
+ },
2376
+ "pricePerUnit": {
2377
+ "type": "number",
2378
+ "format": "double"
2379
+ },
2380
+ "pricePerUnitMax": {
2381
+ "type": "number",
2382
+ "format": "double"
2383
+ },
2384
+ "pricePerUnitUnit": {
2385
+ "type": "string",
2386
+ "maxLength": 256,
2387
+ "minLength": 1
2388
+ },
2389
+ "tieredPrices": {
2390
+ "type": "array",
2391
+ "items": {
2392
+ "$ref": "#/components/schemas/ProductPriceTable"
2393
+ }
2394
+ },
2395
+ "prices": {
2396
+ "type": "object",
2397
+ "additionalProperties": {
2398
+ "type": "number",
2399
+ "format": "double"
2400
+ }
2401
+ },
2402
+ "currency": {
2403
+ "$ref": "#/components/schemas/CurrencyCode"
2404
+ },
2405
+ "priceRanges": {
2406
+ "type": "array",
2407
+ "items": {
2408
+ "$ref": "#/components/schemas/ProductPriceRange"
2409
+ }
2410
+ }
2411
+ },
2412
+ "required": [
2413
+ "productId"
2414
+ ]
2415
+ },
2416
+ "schemas-ProductPromotion": {
2417
+ "type": "object",
2418
+ "properties": {
2419
+ "promotionId": {
2420
+ "type": "string",
2421
+ "maxLength": 256,
2422
+ "minLength": 1
2423
+ },
2424
+ "calloutMsg": {
2425
+ "type": "string",
2426
+ "maxLength": 4000,
2427
+ "minLength": 1
2428
+ },
2429
+ "promotionalPrice": {
2430
+ "type": "number",
2431
+ "format": "double"
2432
+ }
2433
+ },
2434
+ "required": [
2435
+ "calloutMsg",
2436
+ "promotionId"
2437
+ ]
2438
+ },
2439
+ "PromotionsResult": {
2440
+ "type": "object",
2441
+ "properties": {
2442
+ "productId": {
2443
+ "type": "string",
2444
+ "maxLength": 100,
2445
+ "minLength": 1
2446
+ },
2447
+ "productPromotions": {
2448
+ "type": "array",
2449
+ "items": {
2450
+ "$ref": "#/components/schemas/schemas-ProductPromotion"
2451
+ }
2452
+ }
2453
+ },
2454
+ "required": [
2455
+ "productId"
2456
+ ]
2457
+ },
2458
+ "CategoryId": {
2459
+ "type": "string",
2460
+ "maxLength": 256,
2461
+ "minLength": 1
2462
+ },
2463
+ "Total": {
2464
+ "type": "integer",
2465
+ "format": "int32",
2466
+ "default": 0,
2467
+ "minimum": 0
2468
+ },
2469
+ "ResultBase": {
2470
+ "type": "object",
2471
+ "properties": {
2472
+ "limit": {
2473
+ "type": "integer",
2474
+ "format": "int32"
2475
+ },
2476
+ "total": {
2477
+ "$ref": "#/components/schemas/Total"
2478
+ }
2479
+ },
2480
+ "required": [
2481
+ "limit",
2482
+ "total"
2483
+ ]
2484
+ },
2485
+ "Category": {
2486
+ "type": "object",
2487
+ "additionalProperties": {},
2488
+ "properties": {
2489
+ "categories": {
2490
+ "type": "array",
2491
+ "items": {
2492
+ "$ref": "#/components/schemas/Category"
2493
+ }
2494
+ },
2495
+ "description": {
2496
+ "type": "string"
2497
+ },
2498
+ "id": {
2499
+ "$ref": "#/components/schemas/CategoryId"
2500
+ },
2501
+ "image": {
2502
+ "type": "string"
2503
+ },
2504
+ "name": {
2505
+ "type": "string"
2506
+ },
2507
+ "onlineSubCategoriesCount": {
2508
+ "type": "integer",
2509
+ "format": "int64"
2510
+ },
2511
+ "pageDescription": {
2512
+ "type": "string"
2513
+ },
2514
+ "pageKeywords": {
2515
+ "type": "string"
2516
+ },
2517
+ "pageTitle": {
2518
+ "type": "string"
2519
+ },
2520
+ "parentCategoryId": {
2521
+ "type": "string"
2522
+ },
2523
+ "parentCategoryTree": {
2524
+ "type": "array",
2525
+ "items": {
2526
+ "$ref": "#/components/schemas/PathRecord"
2527
+ }
2528
+ },
2529
+ "thumbnail": {
2530
+ "type": "string"
2531
+ }
2532
+ },
2533
+ "required": [
2534
+ "id"
2535
+ ]
2536
+ },
2537
+ "PathRecord": {
2538
+ "type": "object",
2539
+ "properties": {
2540
+ "id": {
2541
+ "type": "string"
2542
+ },
2543
+ "name": {
2544
+ "type": "string"
2545
+ }
2546
+ }
2547
+ },
2548
+ "CategoryResult": {
2549
+ "allOf": [
2550
+ {
2551
+ "$ref": "#/components/schemas/ResultBase"
2552
+ }
2553
+ ],
2554
+ "properties": {
2555
+ "data": {
2556
+ "type": "array",
2557
+ "items": {
2558
+ "$ref": "#/components/schemas/Category"
2559
+ }
2560
+ }
2561
+ },
2562
+ "required": [
2563
+ "data"
2564
+ ]
2565
+ }
2566
+ },
2567
+ "responses": {
2568
+ "401unauthorized": {
2569
+ "description": "Your access token is invalid or expired and can’t be used to identify a user.",
2570
+ "content": {
2571
+ "application/problem+json": {
2572
+ "schema": {
2573
+ "$ref": "#/components/schemas/ErrorResponse"
2574
+ }
2575
+ }
2576
+ }
2577
+ }
2578
+ },
2579
+ "parameters": {
2580
+ "organizationId": {
2581
+ "name": "organizationId",
2582
+ "in": "path",
2583
+ "required": true,
2584
+ "style": "simple",
2585
+ "explode": false,
2586
+ "schema": {
2587
+ "$ref": "#/components/schemas/OrganizationId"
2588
+ }
2589
+ },
2590
+ "ids": {
2591
+ "name": "ids",
2592
+ "in": "query",
2593
+ "required": true,
2594
+ "style": "form",
2595
+ "explode": false,
2596
+ "schema": {
2597
+ "type": "array",
2598
+ "items": {
2599
+ "allOf": [
2600
+ {
2601
+ "$ref": "#/components/schemas/ProductId"
2602
+ }
2603
+ ]
2604
+ },
2605
+ "maxItems": 100
2606
+ }
2607
+ },
2608
+ "inventoryIds": {
2609
+ "name": "inventoryIds",
2610
+ "in": "query",
2611
+ "required": false,
2612
+ "style": "form",
2613
+ "explode": false,
2614
+ "schema": {
2615
+ "type": "array",
2616
+ "items": {
2617
+ "allOf": [
2618
+ {
2619
+ "$ref": "#/components/schemas/InventoryId"
2620
+ }
2621
+ ]
2622
+ },
2623
+ "maxItems": 5
2624
+ }
2625
+ },
2626
+ "expand_multiId": {
2627
+ "name": "expand",
2628
+ "in": "query",
2629
+ "required": false,
2630
+ "style": "form",
2631
+ "explode": false,
2632
+ "schema": {
2633
+ "type": "array",
2634
+ "items": {
2635
+ "type": "string",
2636
+ "enum": [
2637
+ "none",
2638
+ "availability",
2639
+ "bundled_products",
2640
+ "links",
2641
+ "promotions",
2642
+ "options",
2643
+ "images",
2644
+ "prices",
2645
+ "variations",
2646
+ "set_products",
2647
+ "recommendations",
2648
+ "shipping_methods",
2649
+ "page_meta_tags",
2650
+ "primary_category"
2651
+ ]
2652
+ }
2653
+ }
2654
+ },
2655
+ "allImages": {
2656
+ "name": "allImages",
2657
+ "in": "query",
2658
+ "required": false,
2659
+ "style": "form",
2660
+ "explode": true,
2661
+ "schema": {
2662
+ "type": "boolean"
2663
+ }
2664
+ },
2665
+ "imgTypes": {
2666
+ "name": "imgTypes",
2667
+ "in": "query",
2668
+ "required": false,
2669
+ "style": "form",
2670
+ "explode": true,
2671
+ "schema": {
2672
+ "type": "string",
2673
+ "maxLength": 50
2674
+ }
2675
+ },
2676
+ "perPricebook": {
2677
+ "name": "perPricebook",
2678
+ "in": "query",
2679
+ "required": false,
2680
+ "style": "form",
2681
+ "explode": true,
2682
+ "schema": {
2683
+ "type": "boolean"
2684
+ }
2685
+ },
2686
+ "siteId": {
2687
+ "name": "siteId",
2688
+ "in": "query",
2689
+ "required": true,
2690
+ "style": "form",
2691
+ "explode": true,
2692
+ "schema": {
2693
+ "$ref": "#/components/schemas/SiteId"
2694
+ }
2695
+ },
2696
+ "select": {
2697
+ "name": "select",
2698
+ "in": "query",
2699
+ "required": false,
2700
+ "style": "form",
2701
+ "explode": true,
2702
+ "schema": {
2703
+ "$ref": "#/components/schemas/Select"
2704
+ }
2705
+ },
2706
+ "locale": {
2707
+ "name": "locale",
2708
+ "in": "query",
2709
+ "required": false,
2710
+ "style": "form",
2711
+ "explode": true,
2712
+ "schema": {
2713
+ "$ref": "#/components/schemas/LocaleCode"
2714
+ }
2715
+ },
2716
+ "currency": {
2717
+ "name": "currency",
2718
+ "in": "query",
2719
+ "required": false,
2720
+ "style": "form",
2721
+ "explode": true,
2722
+ "schema": {
2723
+ "$ref": "#/components/schemas/CurrencyCode"
2724
+ }
2725
+ },
2726
+ "id": {
2727
+ "name": "id",
2728
+ "in": "path",
2729
+ "required": true,
2730
+ "style": "simple",
2731
+ "explode": false,
2732
+ "schema": {
2733
+ "$ref": "#/components/schemas/ProductId"
2734
+ }
2735
+ },
2736
+ "expand_singleId": {
2737
+ "name": "expand",
2738
+ "in": "query",
2739
+ "required": false,
2740
+ "style": "form",
2741
+ "explode": false,
2742
+ "schema": {
2743
+ "type": "array",
2744
+ "items": {
2745
+ "type": "string",
2746
+ "enum": [
2747
+ "none",
2748
+ "availability",
2749
+ "bundled_products",
2750
+ "links",
2751
+ "promotions",
2752
+ "options",
2753
+ "images",
2754
+ "prices",
2755
+ "variations",
2756
+ "set_products",
2757
+ "recommendations",
2758
+ "shipping_methods",
2759
+ "page_meta_tags",
2760
+ "primary_category"
2761
+ ]
2762
+ }
2763
+ }
2764
+ },
2765
+ "productId": {
2766
+ "name": "productId",
2767
+ "in": "path",
2768
+ "required": true,
2769
+ "style": "simple",
2770
+ "explode": false,
2771
+ "schema": {
2772
+ "$ref": "#/components/schemas/ProductId"
2773
+ }
2774
+ },
2775
+ "parameters-imgTypes": {
2776
+ "name": "imgTypes",
2777
+ "in": "query",
2778
+ "required": false,
2779
+ "style": "form",
2780
+ "explode": true,
2781
+ "schema": {
2782
+ "type": "string",
2783
+ "maxLength": 50
2784
+ }
2785
+ },
2786
+ "parameters-allImages": {
2787
+ "name": "allImages",
2788
+ "in": "query",
2789
+ "required": false,
2790
+ "style": "form",
2791
+ "explode": true,
2792
+ "schema": {
2793
+ "type": "boolean",
2794
+ "default": false
2795
+ }
2796
+ },
2797
+ "variationAttribute": {
2798
+ "name": "variationAttribute",
2799
+ "in": "query",
2800
+ "required": false,
2801
+ "style": "form",
2802
+ "explode": false,
2803
+ "schema": {
2804
+ "type": "array",
2805
+ "items": {
2806
+ "type": "string",
2807
+ "maxLength": 256,
2808
+ "minLength": 1
2809
+ }
2810
+ }
2811
+ },
2812
+ "parameters-productId": {
2813
+ "name": "productId",
2814
+ "in": "path",
2815
+ "required": true,
2816
+ "style": "simple",
2817
+ "explode": false,
2818
+ "schema": {
2819
+ "$ref": "#/components/schemas/ProductId"
2820
+ }
2821
+ },
2822
+ "components-parameters-productId": {
2823
+ "name": "productId",
2824
+ "in": "path",
2825
+ "required": true,
2826
+ "style": "simple",
2827
+ "explode": false,
2828
+ "schema": {
2829
+ "$ref": "#/components/schemas/ProductId"
2830
+ }
2831
+ },
2832
+ "parameters-ids": {
2833
+ "name": "ids",
2834
+ "in": "query",
2835
+ "required": true,
2836
+ "style": "form",
2837
+ "explode": false,
2838
+ "schema": {
2839
+ "type": "array",
2840
+ "items": {
2841
+ "allOf": [
2842
+ {
2843
+ "$ref": "#/components/schemas/CategoryId"
2844
+ }
2845
+ ]
2846
+ },
2847
+ "maxItems": 50
2848
+ }
2849
+ },
2850
+ "levels": {
2851
+ "name": "levels",
2852
+ "in": "query",
2853
+ "required": false,
2854
+ "style": "form",
2855
+ "explode": true,
2856
+ "schema": {
2857
+ "type": "integer",
2858
+ "format": "int32",
2859
+ "enum": [
2860
+ 0,
2861
+ 1,
2862
+ 2
2863
+ ],
2864
+ "minimum": 0
2865
+ }
2866
+ },
2867
+ "parameters-id": {
2868
+ "name": "id",
2869
+ "in": "path",
2870
+ "required": true,
2871
+ "style": "simple",
2872
+ "explode": false,
2873
+ "schema": {
2874
+ "$ref": "#/components/schemas/CategoryId"
2875
+ }
2876
+ },
2877
+ "sfdcUsid": {
2878
+ "name": "sfdc_usid",
2879
+ "in": "header",
2880
+ "required": false,
2881
+ "style": "simple",
2882
+ "explode": false,
2883
+ "schema": {
2884
+ "type": "string",
2885
+ "format": "uuid"
2886
+ }
2887
+ },
2888
+ "sfdcDwDnt": {
2889
+ "name": "sfdc_dw_dnt",
2890
+ "in": "header",
2891
+ "required": false,
2892
+ "style": "simple",
2893
+ "explode": false,
2894
+ "schema": {
2895
+ "type": "string",
2896
+ "enum": [
2897
+ "0",
2898
+ "1"
2899
+ ]
2900
+ }
2901
+ },
2902
+ "personalized": {
2903
+ "name": "personalized",
2904
+ "in": "query",
2905
+ "required": false,
2906
+ "style": "form",
2907
+ "explode": true,
2908
+ "schema": {
2909
+ "type": "string",
2910
+ "enum": [
2911
+ "none"
2912
+ ]
2913
+ }
2914
+ },
2915
+ "sfdcShopperContext": {
2916
+ "name": "sfdc_shopper_context",
2917
+ "in": "header",
2918
+ "required": false,
2919
+ "style": "simple",
2920
+ "explode": false,
2921
+ "schema": {
2922
+ "type": "string"
2923
+ }
2924
+ }
2925
+ },
2926
+ "securitySchemes": {
2927
+ "ShopperToken": {
2928
+ "type": "oauth2",
2929
+ "flows": {
2930
+ "clientCredentials": {
2931
+ "tokenUrl": "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/v1/organizations/{organizationId}/oauth2/token",
2932
+ "scopes": {
2933
+ "sfcc.shopper-products": "scope granting read-access to product endpoints",
2934
+ "sfcc.shopper-categories": "scope granting read-access to category endpoints"
2935
+ }
2936
+ },
2937
+ "authorizationCode": {
2938
+ "authorizationUrl": "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/v1/organizations/{organizationId}/oauth2/authorize",
2939
+ "tokenUrl": "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/v1/organizations/{organizationId}/oauth2/token",
2940
+ "scopes": {
2941
+ "sfcc.shopper-products": "scope granting read-access to product endpoints",
2942
+ "sfcc.shopper-categories": "scope granting read-access to category endpoints"
2943
+ }
2944
+ }
2945
+ }
2946
+ },
2947
+ "ShopperClientContextToken": {
2948
+ "type": "oauth2",
2949
+ "flows": {
2950
+ "clientCredentials": {
2951
+ "tokenUrl": "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/v1/organizations/{organizationId}/oauth2/token?hint=client_context",
2952
+ "scopes": {
2953
+ "sfcc.shopper-products": "scope granting read-access to product endpoints",
2954
+ "sfcc.shopper-categories": "scope granting read-access to category endpoints"
2955
+ }
2956
+ }
2957
+ }
2958
+ }
2959
+ }
2960
+ }
2961
+ }