@salesforce/b2c-tooling-sdk 1.24.2 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (460) hide show
  1. package/data/content-schemas/componenttype.json +0 -30
  2. package/data/scapi-snippets/campaign-promotions.js +40 -0
  3. package/data/scapi-snippets/code-version-inspect.js +31 -0
  4. package/data/scapi-snippets/create-product.js +108 -0
  5. package/data/scapi-snippets/failed-job-triage.js +37 -0
  6. package/data/scapi-snippets/job-execution-inspect.js +52 -0
  7. package/data/scapi-snippets/job-execution-review.js +46 -0
  8. package/data/scapi-snippets/manifest.json +220 -0
  9. package/data/scapi-snippets/site-cartridge-inspect.js +27 -0
  10. package/data/tooling/index.json +80 -116
  11. package/dist/esm/auth/index.d.ts +2 -2
  12. package/dist/esm/auth/index.js +1 -1
  13. package/dist/esm/auth/index.js.map +1 -1
  14. package/dist/esm/auth/oauth-implicit.d.ts +1 -0
  15. package/dist/esm/auth/oauth-implicit.js +1 -0
  16. package/dist/esm/auth/oauth-implicit.js.map +1 -1
  17. package/dist/esm/auth/oauth-jwt.d.ts +18 -4
  18. package/dist/esm/auth/oauth-jwt.js +67 -17
  19. package/dist/esm/auth/oauth-jwt.js.map +1 -1
  20. package/dist/esm/auth/oauth-pkce-fallback.d.ts +1 -0
  21. package/dist/esm/auth/oauth-pkce-fallback.js +1 -0
  22. package/dist/esm/auth/oauth-pkce-fallback.js.map +1 -1
  23. package/dist/esm/auth/oauth-pkce.d.ts +1 -0
  24. package/dist/esm/auth/oauth-pkce.js +1 -0
  25. package/dist/esm/auth/oauth-pkce.js.map +1 -1
  26. package/dist/esm/auth/oauth.d.ts +55 -6
  27. package/dist/esm/auth/oauth.js +139 -21
  28. package/dist/esm/auth/oauth.js.map +1 -1
  29. package/dist/esm/auth/resolve.d.ts +37 -0
  30. package/dist/esm/auth/resolve.js +48 -0
  31. package/dist/esm/auth/resolve.js.map +1 -1
  32. package/dist/esm/auth/types.d.ts +44 -0
  33. package/dist/esm/auth/types.js.map +1 -1
  34. package/dist/esm/cli/base-command.d.ts +9 -0
  35. package/dist/esm/cli/base-command.js +31 -0
  36. package/dist/esm/cli/base-command.js.map +1 -1
  37. package/dist/esm/cli/bm-command.d.ts +15 -0
  38. package/dist/esm/cli/bm-command.js +25 -0
  39. package/dist/esm/cli/bm-command.js.map +1 -0
  40. package/dist/esm/cli/code-command.d.ts +14 -0
  41. package/dist/esm/cli/code-command.js +22 -0
  42. package/dist/esm/cli/code-command.js.map +1 -0
  43. package/dist/esm/cli/config.js +3 -0
  44. package/dist/esm/cli/config.js.map +1 -1
  45. package/dist/esm/cli/index.d.ts +5 -1
  46. package/dist/esm/cli/index.js +7 -1
  47. package/dist/esm/cli/index.js.map +1 -1
  48. package/dist/esm/cli/instance-command.d.ts +45 -0
  49. package/dist/esm/cli/instance-command.js +66 -1
  50. package/dist/esm/cli/instance-command.js.map +1 -1
  51. package/dist/esm/cli/job-command.d.ts +37 -16
  52. package/dist/esm/cli/job-command.js +73 -23
  53. package/dist/esm/cli/job-command.js.map +1 -1
  54. package/dist/esm/cli/mrt-command.d.ts +138 -9
  55. package/dist/esm/cli/mrt-command.js +277 -16
  56. package/dist/esm/cli/mrt-command.js.map +1 -1
  57. package/dist/esm/cli/oauth-command.d.ts +1 -1
  58. package/dist/esm/cli/oauth-command.js +2 -0
  59. package/dist/esm/cli/oauth-command.js.map +1 -1
  60. package/dist/esm/cli/webdav-command.d.ts +1 -0
  61. package/dist/esm/clients/cdn-zones.js +2 -5
  62. package/dist/esm/clients/cdn-zones.js.map +1 -1
  63. package/dist/esm/clients/cip.d.ts +12 -3
  64. package/dist/esm/clients/cip.js +85 -30
  65. package/dist/esm/clients/cip.js.map +1 -1
  66. package/dist/esm/clients/custom-apis.js +2 -5
  67. package/dist/esm/clients/custom-apis.js.map +1 -1
  68. package/dist/esm/clients/dual-backend-factory.d.ts +70 -0
  69. package/dist/esm/clients/dual-backend-factory.js +48 -0
  70. package/dist/esm/clients/dual-backend-factory.js.map +1 -0
  71. package/dist/esm/clients/error-utils.d.ts +62 -0
  72. package/dist/esm/clients/error-utils.js +98 -0
  73. package/dist/esm/clients/error-utils.js.map +1 -1
  74. package/dist/esm/clients/granular-replications.js +2 -5
  75. package/dist/esm/clients/granular-replications.js.map +1 -1
  76. package/dist/esm/clients/index.d.ts +28 -3
  77. package/dist/esm/clients/index.js +24 -2
  78. package/dist/esm/clients/index.js.map +1 -1
  79. package/dist/esm/clients/metrics.js +2 -5
  80. package/dist/esm/clients/metrics.js.map +1 -1
  81. package/dist/esm/clients/middleware-registry.d.ts +4 -2
  82. package/dist/esm/clients/middleware-registry.js +3 -1
  83. package/dist/esm/clients/middleware-registry.js.map +1 -1
  84. package/dist/esm/clients/middleware.d.ts +39 -0
  85. package/dist/esm/clients/middleware.js +126 -25
  86. package/dist/esm/clients/middleware.js.map +1 -1
  87. package/dist/esm/clients/mrt-b2c.js +3 -0
  88. package/dist/esm/clients/mrt-b2c.js.map +1 -1
  89. package/dist/esm/clients/mrt.d.ts +27 -10
  90. package/dist/esm/clients/mrt.generated.d.ts +77 -0
  91. package/dist/esm/clients/mrt.js +68 -0
  92. package/dist/esm/clients/mrt.js.map +1 -1
  93. package/dist/esm/clients/preferences.js +2 -5
  94. package/dist/esm/clients/preferences.js.map +1 -1
  95. package/dist/esm/clients/scapi-backend-utils.d.ts +163 -0
  96. package/dist/esm/clients/scapi-backend-utils.js +180 -0
  97. package/dist/esm/clients/scapi-backend-utils.js.map +1 -0
  98. package/dist/esm/clients/scapi-catalogs.d.ts +12 -0
  99. package/dist/esm/clients/scapi-catalogs.generated.d.ts +104 -0
  100. package/dist/esm/clients/scapi-catalogs.generated.js +6 -0
  101. package/dist/esm/clients/scapi-catalogs.generated.js.map +1 -0
  102. package/dist/esm/clients/scapi-catalogs.js +14 -0
  103. package/dist/esm/clients/scapi-catalogs.js.map +1 -0
  104. package/dist/esm/clients/scapi-client-factory.d.ts +81 -0
  105. package/dist/esm/clients/scapi-client-factory.js +84 -0
  106. package/dist/esm/clients/scapi-client-factory.js.map +1 -0
  107. package/dist/esm/clients/scapi-fallback-backend.d.ts +34 -0
  108. package/dist/esm/clients/scapi-fallback-backend.js +132 -0
  109. package/dist/esm/clients/scapi-fallback-backend.js.map +1 -0
  110. package/dist/esm/clients/scapi-jobs.d.ts +32 -0
  111. package/dist/esm/clients/scapi-jobs.generated.d.ts +535 -0
  112. package/dist/esm/clients/scapi-jobs.generated.js +6 -0
  113. package/dist/esm/clients/scapi-jobs.generated.js.map +1 -0
  114. package/dist/esm/clients/scapi-jobs.js +24 -0
  115. package/dist/esm/clients/scapi-jobs.js.map +1 -0
  116. package/dist/esm/clients/scapi-merchant-roles.d.ts +19 -0
  117. package/dist/esm/clients/scapi-merchant-roles.generated.d.ts +726 -0
  118. package/dist/esm/clients/scapi-merchant-roles.generated.js +6 -0
  119. package/dist/esm/clients/scapi-merchant-roles.generated.js.map +1 -0
  120. package/dist/esm/clients/scapi-merchant-roles.js +12 -0
  121. package/dist/esm/clients/scapi-merchant-roles.js.map +1 -0
  122. package/dist/esm/clients/scapi-merchant-users.d.ts +19 -0
  123. package/dist/esm/clients/scapi-merchant-users.generated.d.ts +300 -0
  124. package/dist/esm/clients/scapi-merchant-users.generated.js +6 -0
  125. package/dist/esm/clients/scapi-merchant-users.generated.js.map +1 -0
  126. package/dist/esm/clients/scapi-merchant-users.js +12 -0
  127. package/dist/esm/clients/scapi-merchant-users.js.map +1 -0
  128. package/dist/esm/clients/scapi-schemas.js +2 -5
  129. package/dist/esm/clients/scapi-schemas.js.map +1 -1
  130. package/dist/esm/clients/scapi-scope-tier.d.ts +78 -0
  131. package/dist/esm/clients/scapi-scope-tier.js +113 -0
  132. package/dist/esm/clients/scapi-scope-tier.js.map +1 -0
  133. package/dist/esm/clients/scapi-scripts.d.ts +17 -0
  134. package/dist/esm/clients/scapi-scripts.generated.d.ts +392 -0
  135. package/dist/esm/clients/scapi-scripts.generated.js +6 -0
  136. package/dist/esm/clients/scapi-scripts.generated.js.map +1 -0
  137. package/dist/esm/clients/scapi-scripts.js +12 -0
  138. package/dist/esm/clients/scapi-scripts.js.map +1 -0
  139. package/dist/esm/clients/scapi-sites.d.ts +26 -0
  140. package/dist/esm/clients/scapi-sites.generated.d.ts +500 -0
  141. package/dist/esm/clients/scapi-sites.generated.js +6 -0
  142. package/dist/esm/clients/scapi-sites.generated.js.map +1 -0
  143. package/dist/esm/clients/scapi-sites.js +25 -0
  144. package/dist/esm/clients/scapi-sites.js.map +1 -0
  145. package/dist/esm/clients/slas-shopper.d.ts +19 -0
  146. package/dist/esm/clients/slas-shopper.generated.d.ts +165 -0
  147. package/dist/esm/clients/slas-shopper.generated.js +6 -0
  148. package/dist/esm/clients/slas-shopper.generated.js.map +1 -0
  149. package/dist/esm/clients/slas-shopper.js +35 -0
  150. package/dist/esm/clients/slas-shopper.js.map +1 -0
  151. package/dist/esm/clients/storefront-deployments.d.ts +56 -0
  152. package/dist/esm/clients/storefront-deployments.generated.d.ts +558 -0
  153. package/dist/esm/clients/storefront-deployments.generated.js +6 -0
  154. package/dist/esm/clients/storefront-deployments.generated.js.map +1 -0
  155. package/dist/esm/clients/storefront-deployments.js +24 -0
  156. package/dist/esm/clients/storefront-deployments.js.map +1 -0
  157. package/dist/esm/clients/webdav.js +4 -1
  158. package/dist/esm/clients/webdav.js.map +1 -1
  159. package/dist/esm/compat/dispatcher.d.ts +49 -0
  160. package/dist/esm/compat/dispatcher.js +124 -0
  161. package/dist/esm/compat/dispatcher.js.map +1 -0
  162. package/dist/esm/compat/index.d.ts +10 -0
  163. package/dist/esm/compat/index.js +15 -0
  164. package/dist/esm/compat/index.js.map +1 -0
  165. package/dist/esm/compat/jobs-backend.d.ts +31 -0
  166. package/dist/esm/compat/jobs-backend.js +76 -0
  167. package/dist/esm/compat/jobs-backend.js.map +1 -0
  168. package/dist/esm/config/dw-json.d.ts +4 -0
  169. package/dist/esm/config/dw-json.js.map +1 -1
  170. package/dist/esm/config/index.d.ts +1 -1
  171. package/dist/esm/config/index.js.map +1 -1
  172. package/dist/esm/config/mapping.d.ts +2 -5
  173. package/dist/esm/config/mapping.js +25 -1
  174. package/dist/esm/config/mapping.js.map +1 -1
  175. package/dist/esm/config/resolved-config.d.ts +2 -2
  176. package/dist/esm/config/resolved-config.js.map +1 -1
  177. package/dist/esm/config/sources/env-source.js +17 -0
  178. package/dist/esm/config/sources/env-source.js.map +1 -1
  179. package/dist/esm/config/types.d.ts +21 -2
  180. package/dist/esm/docs/search.js +2 -25
  181. package/dist/esm/docs/search.js.map +1 -1
  182. package/dist/esm/guidance/catalog.d.ts +37 -0
  183. package/dist/esm/guidance/catalog.js +282 -0
  184. package/dist/esm/guidance/catalog.js.map +1 -0
  185. package/dist/esm/guidance/index.d.ts +8 -0
  186. package/dist/esm/guidance/index.js +14 -0
  187. package/dist/esm/guidance/index.js.map +1 -0
  188. package/dist/esm/guidance/markdown.d.ts +10 -0
  189. package/dist/esm/guidance/markdown.js +52 -0
  190. package/dist/esm/guidance/markdown.js.map +1 -0
  191. package/dist/esm/guidance/types.d.ts +92 -0
  192. package/dist/esm/guidance/types.js +17 -0
  193. package/dist/esm/guidance/types.js.map +1 -0
  194. package/dist/esm/index.d.ts +14 -5
  195. package/dist/esm/index.js +14 -2
  196. package/dist/esm/index.js.map +1 -1
  197. package/dist/esm/instance/index.d.ts +96 -2
  198. package/dist/esm/instance/index.js +98 -5
  199. package/dist/esm/instance/index.js.map +1 -1
  200. package/dist/esm/operations/bm-roles/backend.d.ts +4 -0
  201. package/dist/esm/operations/bm-roles/backend.js +11 -0
  202. package/dist/esm/operations/bm-roles/backend.js.map +1 -0
  203. package/dist/esm/operations/bm-roles/index.d.ts +6 -0
  204. package/dist/esm/operations/bm-roles/index.js +4 -0
  205. package/dist/esm/operations/bm-roles/index.js.map +1 -1
  206. package/dist/esm/operations/bm-roles/ocapi-backend.d.ts +17 -0
  207. package/dist/esm/operations/bm-roles/ocapi-backend.js +151 -0
  208. package/dist/esm/operations/bm-roles/ocapi-backend.js.map +1 -0
  209. package/dist/esm/operations/bm-roles/roles.js +13 -17
  210. package/dist/esm/operations/bm-roles/roles.js.map +1 -1
  211. package/dist/esm/operations/bm-roles/scapi-backend.d.ts +27 -0
  212. package/dist/esm/operations/bm-roles/scapi-backend.js +138 -0
  213. package/dist/esm/operations/bm-roles/scapi-backend.js.map +1 -0
  214. package/dist/esm/operations/bm-roles/types.d.ts +49 -0
  215. package/dist/esm/operations/bm-roles/types.js +2 -0
  216. package/dist/esm/operations/bm-roles/types.js.map +1 -0
  217. package/dist/esm/operations/bm-users/backend.d.ts +4 -0
  218. package/dist/esm/operations/bm-users/backend.js +11 -0
  219. package/dist/esm/operations/bm-users/backend.js.map +1 -0
  220. package/dist/esm/operations/bm-users/index.d.ts +11 -3
  221. package/dist/esm/operations/bm-users/index.js +9 -3
  222. package/dist/esm/operations/bm-users/index.js.map +1 -1
  223. package/dist/esm/operations/bm-users/ocapi-backend.d.ts +13 -0
  224. package/dist/esm/operations/bm-users/ocapi-backend.js +92 -0
  225. package/dist/esm/operations/bm-users/ocapi-backend.js.map +1 -0
  226. package/dist/esm/operations/bm-users/scapi-backend.d.ts +23 -0
  227. package/dist/esm/operations/bm-users/scapi-backend.js +199 -0
  228. package/dist/esm/operations/bm-users/scapi-backend.js.map +1 -0
  229. package/dist/esm/operations/bm-users/types.d.ts +99 -0
  230. package/dist/esm/operations/bm-users/types.js +2 -0
  231. package/dist/esm/operations/bm-users/types.js.map +1 -0
  232. package/dist/esm/operations/bm-users/users.d.ts +4 -3
  233. package/dist/esm/operations/bm-users/users.js +23 -19
  234. package/dist/esm/operations/bm-users/users.js.map +1 -1
  235. package/dist/esm/operations/cap/install.js +23 -45
  236. package/dist/esm/operations/cap/install.js.map +1 -1
  237. package/dist/esm/operations/cap/list.js +4 -8
  238. package/dist/esm/operations/cap/list.js.map +1 -1
  239. package/dist/esm/operations/cap/uninstall.js +17 -37
  240. package/dist/esm/operations/cap/uninstall.js.map +1 -1
  241. package/dist/esm/operations/catalogs/catalogs-backend.d.ts +4 -0
  242. package/dist/esm/operations/catalogs/catalogs-backend.js +16 -0
  243. package/dist/esm/operations/catalogs/catalogs-backend.js.map +1 -0
  244. package/dist/esm/operations/catalogs/catalogs-types.d.ts +14 -0
  245. package/dist/esm/operations/catalogs/catalogs-types.js +2 -0
  246. package/dist/esm/operations/catalogs/catalogs-types.js.map +1 -0
  247. package/dist/esm/operations/catalogs/index.d.ts +7 -0
  248. package/dist/esm/operations/catalogs/index.js +10 -0
  249. package/dist/esm/operations/catalogs/index.js.map +1 -0
  250. package/dist/esm/operations/catalogs/ocapi-catalogs-backend.d.ts +8 -0
  251. package/dist/esm/operations/catalogs/ocapi-catalogs-backend.js +36 -0
  252. package/dist/esm/operations/catalogs/ocapi-catalogs-backend.js.map +1 -0
  253. package/dist/esm/operations/catalogs/scapi-catalogs-backend.d.ts +15 -0
  254. package/dist/esm/operations/catalogs/scapi-catalogs-backend.js +42 -0
  255. package/dist/esm/operations/catalogs/scapi-catalogs-backend.js.map +1 -0
  256. package/dist/esm/operations/cip/index.js +10 -2
  257. package/dist/esm/operations/cip/index.js.map +1 -1
  258. package/dist/esm/operations/cip/reports.js +19 -3
  259. package/dist/esm/operations/cip/reports.js.map +1 -1
  260. package/dist/esm/operations/cip/types.d.ts +8 -4
  261. package/dist/esm/operations/code/deploy.d.ts +3 -0
  262. package/dist/esm/operations/code/deploy.js +5 -3
  263. package/dist/esm/operations/code/deploy.js.map +1 -1
  264. package/dist/esm/operations/code/download.d.ts +3 -0
  265. package/dist/esm/operations/code/download.js +5 -5
  266. package/dist/esm/operations/code/download.js.map +1 -1
  267. package/dist/esm/operations/code/index.d.ts +7 -1
  268. package/dist/esm/operations/code/index.js +5 -1
  269. package/dist/esm/operations/code/index.js.map +1 -1
  270. package/dist/esm/operations/code/ocapi-scripts-backend.d.ts +12 -0
  271. package/dist/esm/operations/code/ocapi-scripts-backend.js +40 -0
  272. package/dist/esm/operations/code/ocapi-scripts-backend.js.map +1 -0
  273. package/dist/esm/operations/code/scapi-scripts-backend.d.ts +22 -0
  274. package/dist/esm/operations/code/scapi-scripts-backend.js +94 -0
  275. package/dist/esm/operations/code/scapi-scripts-backend.js.map +1 -0
  276. package/dist/esm/operations/code/scripts-backend.d.ts +17 -0
  277. package/dist/esm/operations/code/scripts-backend.js +40 -0
  278. package/dist/esm/operations/code/scripts-backend.js.map +1 -0
  279. package/dist/esm/operations/code/scripts-types.d.ts +43 -0
  280. package/dist/esm/operations/code/scripts-types.js +2 -0
  281. package/dist/esm/operations/code/scripts-types.js.map +1 -0
  282. package/dist/esm/operations/code/upload-files.d.ts +6 -0
  283. package/dist/esm/operations/code/upload-files.js +58 -7
  284. package/dist/esm/operations/code/upload-files.js.map +1 -1
  285. package/dist/esm/operations/code/versions.d.ts +0 -20
  286. package/dist/esm/operations/code/versions.js +16 -51
  287. package/dist/esm/operations/code/versions.js.map +1 -1
  288. package/dist/esm/operations/code/watch.d.ts +3 -0
  289. package/dist/esm/operations/code/watch.js +3 -2
  290. package/dist/esm/operations/code/watch.js.map +1 -1
  291. package/dist/esm/operations/jobs/discover.d.ts +1 -1
  292. package/dist/esm/operations/jobs/discover.js +51 -21
  293. package/dist/esm/operations/jobs/discover.js.map +1 -1
  294. package/dist/esm/operations/jobs/index.d.ts +14 -57
  295. package/dist/esm/operations/jobs/index.js +15 -59
  296. package/dist/esm/operations/jobs/index.js.map +1 -1
  297. package/dist/esm/operations/jobs/ocapi-mapping.d.ts +34 -0
  298. package/dist/esm/operations/jobs/ocapi-mapping.js +100 -0
  299. package/dist/esm/operations/jobs/ocapi-mapping.js.map +1 -0
  300. package/dist/esm/operations/jobs/run-system-job.d.ts +81 -0
  301. package/dist/esm/operations/jobs/run-system-job.js +137 -0
  302. package/dist/esm/operations/jobs/run-system-job.js.map +1 -0
  303. package/dist/esm/operations/jobs/run.js +16 -4
  304. package/dist/esm/operations/jobs/run.js.map +1 -1
  305. package/dist/esm/operations/jobs/scapi-ops.d.ts +61 -0
  306. package/dist/esm/operations/jobs/scapi-ops.js +214 -0
  307. package/dist/esm/operations/jobs/scapi-ops.js.map +1 -0
  308. package/dist/esm/operations/jobs/site-archive.js +28 -66
  309. package/dist/esm/operations/jobs/site-archive.js.map +1 -1
  310. package/dist/esm/operations/jobs/types.d.ts +46 -0
  311. package/dist/esm/operations/jobs/types.js +2 -0
  312. package/dist/esm/operations/jobs/types.js.map +1 -0
  313. package/dist/esm/operations/jobs/wait-canonical.d.ts +28 -0
  314. package/dist/esm/operations/jobs/wait-canonical.js +48 -0
  315. package/dist/esm/operations/jobs/wait-canonical.js.map +1 -0
  316. package/dist/esm/operations/mrt/bundle.d.ts +164 -2
  317. package/dist/esm/operations/mrt/bundle.js +315 -9
  318. package/dist/esm/operations/mrt/bundle.js.map +1 -1
  319. package/dist/esm/operations/mrt/deployment.d.ts +221 -0
  320. package/dist/esm/operations/mrt/deployment.js +239 -0
  321. package/dist/esm/operations/mrt/deployment.js.map +1 -1
  322. package/dist/esm/operations/mrt/index.d.ts +8 -6
  323. package/dist/esm/operations/mrt/index.js +5 -3
  324. package/dist/esm/operations/mrt/index.js.map +1 -1
  325. package/dist/esm/operations/mrt/mrt-backend.d.ts +117 -0
  326. package/dist/esm/operations/mrt/mrt-backend.js +84 -0
  327. package/dist/esm/operations/mrt/mrt-backend.js.map +1 -0
  328. package/dist/esm/operations/mrt/push.d.ts +83 -1
  329. package/dist/esm/operations/mrt/push.js +102 -1
  330. package/dist/esm/operations/mrt/push.js.map +1 -1
  331. package/dist/esm/operations/sites/cartridges.d.ts +10 -8
  332. package/dist/esm/operations/sites/cartridges.js +35 -67
  333. package/dist/esm/operations/sites/cartridges.js.map +1 -1
  334. package/dist/esm/operations/sites/index.d.ts +10 -6
  335. package/dist/esm/operations/sites/index.js +9 -6
  336. package/dist/esm/operations/sites/index.js.map +1 -1
  337. package/dist/esm/operations/sites/ocapi-sites-backend.d.ts +20 -0
  338. package/dist/esm/operations/sites/ocapi-sites-backend.js +98 -0
  339. package/dist/esm/operations/sites/ocapi-sites-backend.js.map +1 -0
  340. package/dist/esm/operations/sites/scapi-sites-backend.d.ts +33 -0
  341. package/dist/esm/operations/sites/scapi-sites-backend.js +166 -0
  342. package/dist/esm/operations/sites/scapi-sites-backend.js.map +1 -0
  343. package/dist/esm/operations/sites/sites-backend.d.ts +9 -0
  344. package/dist/esm/operations/sites/sites-backend.js +16 -0
  345. package/dist/esm/operations/sites/sites-backend.js.map +1 -0
  346. package/dist/esm/operations/sites/sites-scopes.d.ts +2 -0
  347. package/dist/esm/operations/sites/sites-scopes.js +16 -0
  348. package/dist/esm/operations/sites/sites-scopes.js.map +1 -0
  349. package/dist/esm/operations/sites/sites-types.d.ts +50 -0
  350. package/dist/esm/operations/sites/sites-types.js +2 -0
  351. package/dist/esm/operations/sites/sites-types.js.map +1 -0
  352. package/dist/esm/safety/safety-middleware.d.ts +7 -3
  353. package/dist/esm/safety/safety-middleware.js +13 -9
  354. package/dist/esm/safety/safety-middleware.js.map +1 -1
  355. package/dist/esm/scaffold/sources.js +6 -9
  356. package/dist/esm/scaffold/sources.js.map +1 -1
  357. package/dist/esm/scapi/auth-primitives.d.ts +3 -0
  358. package/dist/esm/scapi/auth-primitives.js +104 -0
  359. package/dist/esm/scapi/auth-primitives.js.map +1 -0
  360. package/dist/esm/scapi/authentication.d.ts +30 -0
  361. package/dist/esm/scapi/authentication.js +136 -0
  362. package/dist/esm/scapi/authentication.js.map +1 -0
  363. package/dist/esm/scapi/catalog.d.ts +29 -0
  364. package/dist/esm/scapi/catalog.js +81 -0
  365. package/dist/esm/scapi/catalog.js.map +1 -0
  366. package/dist/esm/scapi/index.d.ts +12 -0
  367. package/dist/esm/scapi/index.js +13 -0
  368. package/dist/esm/scapi/index.js.map +1 -0
  369. package/dist/esm/scapi/request.d.ts +15 -0
  370. package/dist/esm/scapi/request.js +239 -0
  371. package/dist/esm/scapi/request.js.map +1 -0
  372. package/dist/esm/scapi/runtime.d.ts +20 -0
  373. package/dist/esm/scapi/runtime.js +131 -0
  374. package/dist/esm/scapi/runtime.js.map +1 -0
  375. package/dist/esm/scapi/snippets.d.ts +22 -0
  376. package/dist/esm/scapi/snippets.js +140 -0
  377. package/dist/esm/scapi/snippets.js.map +1 -0
  378. package/dist/esm/scapi/worker-source.d.ts +2 -0
  379. package/dist/esm/scapi/worker-source.js +101 -0
  380. package/dist/esm/scapi/worker-source.js.map +1 -0
  381. package/dist/esm/search/ranking.d.ts +12 -0
  382. package/dist/esm/search/ranking.js +28 -0
  383. package/dist/esm/search/ranking.js.map +1 -0
  384. package/dist/esm/skills/sources.d.ts +2 -2
  385. package/dist/esm/skills/sources.js +10 -2
  386. package/dist/esm/skills/sources.js.map +1 -1
  387. package/dist/esm/skills/types.d.ts +1 -1
  388. package/dist/esm/slas/token.js +33 -94
  389. package/dist/esm/slas/token.js.map +1 -1
  390. package/dist/esm/slas/types.d.ts +5 -0
  391. package/node_modules/@salesforce/b2c-api-schemas/README.md +23 -0
  392. package/node_modules/@salesforce/b2c-api-schemas/manifest.json +576 -0
  393. package/node_modules/@salesforce/b2c-api-schemas/package.json +15 -0
  394. package/node_modules/@salesforce/b2c-api-schemas/scapi/cdn/zones/v1.json +11490 -0
  395. package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/orders/v1.json +3589 -0
  396. package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-baskets/v1.json +6544 -0
  397. package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-baskets/v2.json +7148 -0
  398. package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-orders/v1.json +4411 -0
  399. package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-payments/v1.json +643 -0
  400. package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/cors/v1.json +295 -0
  401. package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/preferences/v1.json +2036 -0
  402. package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/shopper-configurations/v1.json +327 -0
  403. package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/timeouts/v1.json +234 -0
  404. package/node_modules/@salesforce/b2c-api-schemas/scapi/custom-object/custom-objects/v1.json +1542 -0
  405. package/node_modules/@salesforce/b2c-api-schemas/scapi/custom-object/shopper-custom-objects/v1.json +405 -0
  406. package/node_modules/@salesforce/b2c-api-schemas/scapi/customer/customers/v1.json +2531 -0
  407. package/node_modules/@salesforce/b2c-api-schemas/scapi/customer/shopper-customers/v1.json +7944 -0
  408. package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/custom-apis/v1.json +292 -0
  409. package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/object-definitions/v1.json +2537 -0
  410. package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/scapi-schemas/v1.json +517 -0
  411. package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/scripts/v1.json +589 -0
  412. package/node_modules/@salesforce/b2c-api-schemas/scapi/experience/experiences/v1.json +3600 -0
  413. package/node_modules/@salesforce/b2c-api-schemas/scapi/experience/shopper-experience/v1.json +2319 -0
  414. package/node_modules/@salesforce/b2c-api-schemas/scapi/intelligence/analytics/v1.json +658 -0
  415. package/node_modules/@salesforce/b2c-api-schemas/scapi/inventory/availability/v1.json +2649 -0
  416. package/node_modules/@salesforce/b2c-api-schemas/scapi/inventory/impex/v1.json +6615 -0
  417. package/node_modules/@salesforce/b2c-api-schemas/scapi/inventory/reservation/v1.json +2103 -0
  418. package/node_modules/@salesforce/b2c-api-schemas/scapi/merchant/roles/v1.json +1760 -0
  419. package/node_modules/@salesforce/b2c-api-schemas/scapi/merchant/users/v1.json +640 -0
  420. package/node_modules/@salesforce/b2c-api-schemas/scapi/observability/metrics/v1.json +1263 -0
  421. package/node_modules/@salesforce/b2c-api-schemas/scapi/operation/jobs/v1.json +1259 -0
  422. package/node_modules/@salesforce/b2c-api-schemas/scapi/operation/replications/v1.json +760 -0
  423. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/assignments/v1.json +1047 -0
  424. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/campaigns/v1.json +1929 -0
  425. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/coupons/v1.json +1542 -0
  426. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/gift-certificates/v1.json +1093 -0
  427. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/promotions/v1.json +1324 -0
  428. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/shopper-gift-certificates/v1.json +325 -0
  429. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/shopper-promotions/v1.json +631 -0
  430. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/source-code-groups/v1.json +1036 -0
  431. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/catalogs/v1.json +5175 -0
  432. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/inventory-lists/v1.json +866 -0
  433. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/price-books/v1.json +747 -0
  434. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/products/v1.json +5076 -0
  435. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/shopper-availability/v1.json +509 -0
  436. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/shopper-delivery-estimates/v1.json +517 -0
  437. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/shopper-products/v1.json +2961 -0
  438. package/node_modules/@salesforce/b2c-api-schemas/scapi/search/shopper-search/v1.json +1889 -0
  439. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/auth/v1.json +7014 -0
  440. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/auth-admin/v1.json +1898 -0
  441. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/consents/v1.json +622 -0
  442. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/shopper-agents/v1.json +192 -0
  443. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/shopper-consents/v1.json +913 -0
  444. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/shopper-context/v1.json +630 -0
  445. package/node_modules/@salesforce/b2c-api-schemas/scapi/site/seo/v1.json +223 -0
  446. package/node_modules/@salesforce/b2c-api-schemas/scapi/site/shopper-seo/v1.json +423 -0
  447. package/node_modules/@salesforce/b2c-api-schemas/scapi/site/sites/v1.json +1088 -0
  448. package/node_modules/@salesforce/b2c-api-schemas/scapi/store/shopper-stores/v1.json +798 -0
  449. package/node_modules/@salesforce/b2c-api-schemas/scapi/store/store-redirect-mappings/v1.json +607 -0
  450. package/node_modules/@salesforce/b2c-api-schemas/scapi/store/stores/v1.json +1418 -0
  451. package/package.json +24 -3
  452. package/specs/dx-scripts-v1.yaml +409 -0
  453. package/specs/merchant-roles-v1.yaml +1085 -0
  454. package/specs/merchant-users-v1.yaml +398 -0
  455. package/specs/mrt-api-v1.json +105 -0
  456. package/specs/operations-jobs-v1.yaml +793 -0
  457. package/specs/product-catalogs-v1.yaml +111 -0
  458. package/specs/site-sites-v1.yaml +667 -0
  459. package/specs/slas-shopper-v1.yaml +83 -0
  460. package/specs/storefront-deployments-v1.yaml +630 -0
@@ -0,0 +1,2531 @@
1
+ {
2
+ "openapi": "3.0.3",
3
+ "info": {
4
+ "title": "Customers",
5
+ "version": "1.1.3",
6
+ "x-api-type": "Admin",
7
+ "x-api-family": "Customer"
8
+ },
9
+ "servers": [
10
+ {
11
+ "url": "https://{shortCode}.api.commercecloud.salesforce.com/customer/customers/v1",
12
+ "variables": {
13
+ "shortCode": {
14
+ "default": "shortCode"
15
+ }
16
+ }
17
+ }
18
+ ],
19
+ "paths": {
20
+ "/organizations/{organizationId}/customer-lists/{customerListId}/customer-search": {
21
+ "post": {
22
+ "operationId": "searchCustomerInCustomerList",
23
+ "parameters": [
24
+ {
25
+ "name": "customerListId",
26
+ "in": "path",
27
+ "required": true,
28
+ "style": "simple",
29
+ "explode": false,
30
+ "schema": {
31
+ "type": "string",
32
+ "maxLength": 256,
33
+ "minLength": 1
34
+ }
35
+ },
36
+ {
37
+ "name": "organizationId",
38
+ "in": "path",
39
+ "required": true,
40
+ "style": "simple",
41
+ "explode": false,
42
+ "schema": {
43
+ "$ref": "#/components/schemas/OrganizationId"
44
+ }
45
+ }
46
+ ],
47
+ "requestBody": {
48
+ "content": {
49
+ "application/json": {
50
+ "schema": {
51
+ "$ref": "#/components/schemas/SearchRequest"
52
+ }
53
+ }
54
+ },
55
+ "required": true
56
+ },
57
+ "responses": {
58
+ "200": {
59
+ "description": "Success",
60
+ "content": {
61
+ "application/json": {
62
+ "schema": {
63
+ "$ref": "#/components/schemas/CustomerSearchResult"
64
+ }
65
+ }
66
+ }
67
+ },
68
+ "400": {
69
+ "description": "Bad Request. Thrown when a specified parameter value is unknown.\n",
70
+ "content": {
71
+ "application/problem+json": {
72
+ "schema": {
73
+ "$ref": "#/components/schemas/ErrorResponse"
74
+ }
75
+ }
76
+ }
77
+ },
78
+ "401": {
79
+ "description": "Unauthorized. Your Client ID is invalid, or you are not allowed to access\nthe content provided by the requested URL.\n",
80
+ "content": {
81
+ "application/problem+json": {
82
+ "schema": {
83
+ "$ref": "#/components/schemas/ErrorResponse"
84
+ }
85
+ }
86
+ }
87
+ },
88
+ "404": {
89
+ "description": "Not Found. This error is thrown when the ID does not match any of the customer group sites or if the ID is ill-formed.",
90
+ "content": {
91
+ "application/problem+json": {
92
+ "schema": {
93
+ "$ref": "#/components/schemas/ErrorResponse"
94
+ }
95
+ }
96
+ }
97
+ }
98
+ },
99
+ "security": [
100
+ {
101
+ "AmOAuth2": [
102
+ "sfcc.customerlists",
103
+ "sfcc.customerlists.rw"
104
+ ]
105
+ }
106
+ ]
107
+ }
108
+ },
109
+ "/organizations/{organizationId}/customer-lists/{customerListId}/customers": {
110
+ "post": {
111
+ "operationId": "createCustomerList",
112
+ "parameters": [
113
+ {
114
+ "name": "customerListId",
115
+ "in": "path",
116
+ "required": true,
117
+ "style": "simple",
118
+ "explode": false,
119
+ "schema": {
120
+ "type": "string",
121
+ "maxLength": 256,
122
+ "minLength": 1
123
+ }
124
+ },
125
+ {
126
+ "name": "organizationId",
127
+ "in": "path",
128
+ "required": true,
129
+ "style": "simple",
130
+ "explode": false,
131
+ "schema": {
132
+ "$ref": "#/components/schemas/OrganizationId"
133
+ }
134
+ }
135
+ ],
136
+ "requestBody": {
137
+ "content": {
138
+ "application/json": {
139
+ "schema": {
140
+ "$ref": "#/components/schemas/Customer"
141
+ }
142
+ }
143
+ },
144
+ "required": true
145
+ },
146
+ "responses": {
147
+ "200": {
148
+ "description": "Success",
149
+ "content": {
150
+ "application/json": {
151
+ "schema": {
152
+ "$ref": "#/components/schemas/Customer"
153
+ }
154
+ }
155
+ }
156
+ },
157
+ "400": {
158
+ "description": "Bad Request. Thrown when a specified parameter value is unknown.\n",
159
+ "content": {
160
+ "application/problem+json": {
161
+ "schema": {
162
+ "$ref": "#/components/schemas/ErrorResponse"
163
+ }
164
+ }
165
+ }
166
+ },
167
+ "401": {
168
+ "description": "Unauthorized. Your Client ID is invalid, or you are not allowed to access\nthe content provided by the requested URL.\n",
169
+ "content": {
170
+ "application/problem+json": {
171
+ "schema": {
172
+ "$ref": "#/components/schemas/ErrorResponse"
173
+ }
174
+ }
175
+ }
176
+ },
177
+ "404": {
178
+ "description": "Not Found. This error is thrown when the ID does not match any of the customer group sites or if the ID is ill-formed.",
179
+ "content": {
180
+ "application/problem+json": {
181
+ "schema": {
182
+ "$ref": "#/components/schemas/ErrorResponse"
183
+ }
184
+ }
185
+ }
186
+ }
187
+ },
188
+ "security": [
189
+ {
190
+ "AmOAuth2": [
191
+ "sfcc.customerlists.rw"
192
+ ]
193
+ }
194
+ ]
195
+ }
196
+ },
197
+ "/organizations/{organizationId}/customer-lists/{customerListId}/customers/{customerNo}": {
198
+ "get": {
199
+ "operationId": "getCustomerFromCustomerList",
200
+ "parameters": [
201
+ {
202
+ "name": "customerNo",
203
+ "in": "path",
204
+ "required": true,
205
+ "style": "simple",
206
+ "explode": false,
207
+ "schema": {
208
+ "type": "string",
209
+ "maxLength": 100,
210
+ "minLength": 1
211
+ }
212
+ },
213
+ {
214
+ "name": "customerListId",
215
+ "in": "path",
216
+ "required": true,
217
+ "style": "simple",
218
+ "explode": false,
219
+ "schema": {
220
+ "type": "string",
221
+ "maxLength": 256,
222
+ "minLength": 1
223
+ }
224
+ },
225
+ {
226
+ "name": "organizationId",
227
+ "in": "path",
228
+ "required": true,
229
+ "style": "simple",
230
+ "explode": false,
231
+ "schema": {
232
+ "$ref": "#/components/schemas/OrganizationId"
233
+ }
234
+ }
235
+ ],
236
+ "responses": {
237
+ "200": {
238
+ "description": "Success",
239
+ "content": {
240
+ "application/json": {
241
+ "schema": {
242
+ "$ref": "#/components/schemas/Customer"
243
+ }
244
+ }
245
+ }
246
+ },
247
+ "400": {
248
+ "description": "Bad Request. Thrown when a specified parameter value is unknown.\n",
249
+ "content": {
250
+ "application/problem+json": {
251
+ "schema": {
252
+ "$ref": "#/components/schemas/ErrorResponse"
253
+ }
254
+ }
255
+ }
256
+ },
257
+ "401": {
258
+ "description": "Unauthorized. Your Client ID is invalid, or you are not allowed to access\nthe content provided by the requested URL.\n",
259
+ "content": {
260
+ "application/problem+json": {
261
+ "schema": {
262
+ "$ref": "#/components/schemas/ErrorResponse"
263
+ }
264
+ }
265
+ }
266
+ },
267
+ "404": {
268
+ "description": "Not Found. This error is thrown when the ID does not match any of the customer group sites or if the ID is ill-formed.",
269
+ "content": {
270
+ "application/problem+json": {
271
+ "schema": {
272
+ "$ref": "#/components/schemas/ErrorResponse"
273
+ }
274
+ }
275
+ }
276
+ }
277
+ },
278
+ "security": [
279
+ {
280
+ "AmOAuth2": [
281
+ "sfcc.customerlists",
282
+ "sfcc.customerlists.rw"
283
+ ]
284
+ }
285
+ ]
286
+ },
287
+ "put": {
288
+ "operationId": "createCustomerInCustomerList",
289
+ "parameters": [
290
+ {
291
+ "name": "customerNo",
292
+ "in": "path",
293
+ "required": true,
294
+ "style": "simple",
295
+ "explode": false,
296
+ "schema": {
297
+ "type": "string",
298
+ "maxLength": 100,
299
+ "minLength": 1
300
+ }
301
+ },
302
+ {
303
+ "name": "customerListId",
304
+ "in": "path",
305
+ "required": true,
306
+ "style": "simple",
307
+ "explode": false,
308
+ "schema": {
309
+ "type": "string",
310
+ "maxLength": 256,
311
+ "minLength": 1
312
+ }
313
+ },
314
+ {
315
+ "name": "organizationId",
316
+ "in": "path",
317
+ "required": true,
318
+ "style": "simple",
319
+ "explode": false,
320
+ "schema": {
321
+ "$ref": "#/components/schemas/OrganizationId"
322
+ }
323
+ }
324
+ ],
325
+ "requestBody": {
326
+ "content": {
327
+ "application/json": {
328
+ "schema": {
329
+ "$ref": "#/components/schemas/Customer"
330
+ }
331
+ }
332
+ },
333
+ "required": true
334
+ },
335
+ "responses": {
336
+ "200": {
337
+ "description": "Success",
338
+ "content": {
339
+ "application/json": {
340
+ "schema": {
341
+ "$ref": "#/components/schemas/Customer"
342
+ }
343
+ }
344
+ }
345
+ },
346
+ "201": {
347
+ "description": "Created",
348
+ "content": {
349
+ "application/json": {
350
+ "schema": {
351
+ "$ref": "#/components/schemas/Customer"
352
+ }
353
+ }
354
+ }
355
+ },
356
+ "400": {
357
+ "description": "Bad Request. Thrown when a specified parameter value is unknown.\n",
358
+ "content": {
359
+ "application/problem+json": {
360
+ "schema": {
361
+ "$ref": "#/components/schemas/ErrorResponse"
362
+ }
363
+ }
364
+ }
365
+ },
366
+ "401": {
367
+ "description": "Unauthorized. Your Client ID is invalid, or you are not allowed to access\nthe content provided by the requested URL.\n",
368
+ "content": {
369
+ "application/problem+json": {
370
+ "schema": {
371
+ "$ref": "#/components/schemas/ErrorResponse"
372
+ }
373
+ }
374
+ }
375
+ },
376
+ "404": {
377
+ "description": "Not Found. This error is thrown when the ID does not match any of the customer group sites or if the ID is ill-formed.",
378
+ "content": {
379
+ "application/problem+json": {
380
+ "schema": {
381
+ "$ref": "#/components/schemas/ErrorResponse"
382
+ }
383
+ }
384
+ }
385
+ }
386
+ },
387
+ "security": [
388
+ {
389
+ "AmOAuth2": [
390
+ "sfcc.customerlists.rw"
391
+ ]
392
+ }
393
+ ]
394
+ },
395
+ "delete": {
396
+ "operationId": "deleteCustomerFromCustomerList",
397
+ "parameters": [
398
+ {
399
+ "name": "customerNo",
400
+ "in": "path",
401
+ "required": true,
402
+ "style": "simple",
403
+ "explode": false,
404
+ "schema": {
405
+ "type": "string",
406
+ "maxLength": 100,
407
+ "minLength": 1
408
+ }
409
+ },
410
+ {
411
+ "name": "customerListId",
412
+ "in": "path",
413
+ "required": true,
414
+ "style": "simple",
415
+ "explode": false,
416
+ "schema": {
417
+ "type": "string",
418
+ "maxLength": 256,
419
+ "minLength": 1
420
+ }
421
+ },
422
+ {
423
+ "name": "organizationId",
424
+ "in": "path",
425
+ "required": true,
426
+ "style": "simple",
427
+ "explode": false,
428
+ "schema": {
429
+ "$ref": "#/components/schemas/OrganizationId"
430
+ }
431
+ }
432
+ ],
433
+ "responses": {
434
+ "204": {
435
+ "description": "No Content"
436
+ },
437
+ "400": {
438
+ "description": "Bad Request. Thrown when a specified parameter value is unknown.\n",
439
+ "content": {
440
+ "application/problem+json": {
441
+ "schema": {
442
+ "$ref": "#/components/schemas/ErrorResponse"
443
+ }
444
+ }
445
+ }
446
+ },
447
+ "401": {
448
+ "description": "Unauthorized. Your Client ID is invalid, or you are not allowed to access\nthe content provided by the requested URL.\n",
449
+ "content": {
450
+ "application/problem+json": {
451
+ "schema": {
452
+ "$ref": "#/components/schemas/ErrorResponse"
453
+ }
454
+ }
455
+ }
456
+ },
457
+ "404": {
458
+ "description": "Not Found. This error is thrown when the ID does not match any of the customer group sites or if the ID is ill-formed.",
459
+ "content": {
460
+ "application/problem+json": {
461
+ "schema": {
462
+ "$ref": "#/components/schemas/ErrorResponse"
463
+ }
464
+ }
465
+ }
466
+ }
467
+ },
468
+ "security": [
469
+ {
470
+ "AmOAuth2": [
471
+ "sfcc.customerlists.rw"
472
+ ]
473
+ }
474
+ ]
475
+ },
476
+ "patch": {
477
+ "operationId": "updateCustomerInCustomerList",
478
+ "parameters": [
479
+ {
480
+ "name": "customerNo",
481
+ "in": "path",
482
+ "required": true,
483
+ "style": "simple",
484
+ "explode": false,
485
+ "schema": {
486
+ "type": "string",
487
+ "maxLength": 100,
488
+ "minLength": 1
489
+ }
490
+ },
491
+ {
492
+ "name": "customerListId",
493
+ "in": "path",
494
+ "required": true,
495
+ "style": "simple",
496
+ "explode": false,
497
+ "schema": {
498
+ "type": "string",
499
+ "maxLength": 256,
500
+ "minLength": 1
501
+ }
502
+ },
503
+ {
504
+ "name": "organizationId",
505
+ "in": "path",
506
+ "required": true,
507
+ "style": "simple",
508
+ "explode": false,
509
+ "schema": {
510
+ "$ref": "#/components/schemas/OrganizationId"
511
+ }
512
+ }
513
+ ],
514
+ "requestBody": {
515
+ "content": {
516
+ "application/json": {
517
+ "schema": {
518
+ "$ref": "#/components/schemas/Customer"
519
+ }
520
+ }
521
+ },
522
+ "required": true
523
+ },
524
+ "responses": {
525
+ "200": {
526
+ "description": "Success",
527
+ "content": {
528
+ "application/json": {
529
+ "schema": {
530
+ "$ref": "#/components/schemas/Customer"
531
+ }
532
+ }
533
+ }
534
+ },
535
+ "400": {
536
+ "description": "Bad Request. Thrown when a specified parameter value is unknown.\n",
537
+ "content": {
538
+ "application/problem+json": {
539
+ "schema": {
540
+ "$ref": "#/components/schemas/ErrorResponse"
541
+ }
542
+ }
543
+ }
544
+ },
545
+ "401": {
546
+ "description": "Unauthorized. Your Client ID is invalid, or you are not allowed to access\nthe content provided by the requested URL.\n",
547
+ "content": {
548
+ "application/problem+json": {
549
+ "schema": {
550
+ "$ref": "#/components/schemas/ErrorResponse"
551
+ }
552
+ }
553
+ }
554
+ },
555
+ "404": {
556
+ "description": "Not Found. This error is thrown when the ID does not match any of the customer group sites or if the ID is ill-formed.",
557
+ "content": {
558
+ "application/problem+json": {
559
+ "schema": {
560
+ "$ref": "#/components/schemas/ErrorResponse"
561
+ }
562
+ }
563
+ }
564
+ }
565
+ },
566
+ "security": [
567
+ {
568
+ "AmOAuth2": [
569
+ "sfcc.customerlists.rw"
570
+ ]
571
+ }
572
+ ]
573
+ }
574
+ },
575
+ "/organizations/{organizationId}/customer-lists/{customerListId}/customers/{customerNo}/addresses": {
576
+ "get": {
577
+ "operationId": "getAddressesForCustomerFromCustomerList",
578
+ "parameters": [
579
+ {
580
+ "name": "customerNo",
581
+ "in": "path",
582
+ "required": true,
583
+ "style": "simple",
584
+ "explode": false,
585
+ "schema": {
586
+ "type": "string",
587
+ "maxLength": 100,
588
+ "minLength": 1
589
+ }
590
+ },
591
+ {
592
+ "name": "customerListId",
593
+ "in": "path",
594
+ "required": true,
595
+ "style": "simple",
596
+ "explode": false,
597
+ "schema": {
598
+ "type": "string",
599
+ "maxLength": 256,
600
+ "minLength": 1
601
+ }
602
+ },
603
+ {
604
+ "name": "organizationId",
605
+ "in": "path",
606
+ "required": true,
607
+ "style": "simple",
608
+ "explode": false,
609
+ "schema": {
610
+ "$ref": "#/components/schemas/OrganizationId"
611
+ }
612
+ },
613
+ {
614
+ "name": "limit",
615
+ "in": "query",
616
+ "required": false,
617
+ "style": "form",
618
+ "explode": true,
619
+ "schema": {
620
+ "type": "integer",
621
+ "format": "int32",
622
+ "default": 25,
623
+ "maximum": 50
624
+ }
625
+ },
626
+ {
627
+ "name": "offset",
628
+ "in": "query",
629
+ "required": false,
630
+ "style": "form",
631
+ "explode": true,
632
+ "schema": {
633
+ "type": "integer",
634
+ "format": "int32",
635
+ "default": 0,
636
+ "minimum": 0
637
+ }
638
+ }
639
+ ],
640
+ "responses": {
641
+ "200": {
642
+ "description": "Success",
643
+ "content": {
644
+ "application/json": {
645
+ "schema": {
646
+ "$ref": "#/components/schemas/CustomerAddressResult"
647
+ }
648
+ }
649
+ }
650
+ },
651
+ "400": {
652
+ "description": "Bad Request. Thrown when a specified parameter value is unknown.\n",
653
+ "content": {
654
+ "application/problem+json": {
655
+ "schema": {
656
+ "$ref": "#/components/schemas/ErrorResponse"
657
+ }
658
+ }
659
+ }
660
+ },
661
+ "401": {
662
+ "description": "Unauthorized. Your Client ID is invalid, or you are not allowed to access\nthe content provided by the requested URL.\n",
663
+ "content": {
664
+ "application/problem+json": {
665
+ "schema": {
666
+ "$ref": "#/components/schemas/ErrorResponse"
667
+ }
668
+ }
669
+ }
670
+ },
671
+ "404": {
672
+ "description": "Not Found. This error is thrown when the ID does not match any of the customer group sites or if the ID is ill-formed.",
673
+ "content": {
674
+ "application/problem+json": {
675
+ "schema": {
676
+ "$ref": "#/components/schemas/ErrorResponse"
677
+ }
678
+ }
679
+ }
680
+ }
681
+ },
682
+ "security": [
683
+ {
684
+ "AmOAuth2": [
685
+ "sfcc.customerlists",
686
+ "sfcc.customerlists.rw"
687
+ ]
688
+ }
689
+ ]
690
+ },
691
+ "post": {
692
+ "operationId": "createAddressForCustomerInCustomerList",
693
+ "parameters": [
694
+ {
695
+ "name": "customerNo",
696
+ "in": "path",
697
+ "required": true,
698
+ "style": "simple",
699
+ "explode": false,
700
+ "schema": {
701
+ "type": "string",
702
+ "maxLength": 100,
703
+ "minLength": 1
704
+ }
705
+ },
706
+ {
707
+ "name": "customerListId",
708
+ "in": "path",
709
+ "required": true,
710
+ "style": "simple",
711
+ "explode": false,
712
+ "schema": {
713
+ "type": "string",
714
+ "maxLength": 256,
715
+ "minLength": 1
716
+ }
717
+ },
718
+ {
719
+ "name": "organizationId",
720
+ "in": "path",
721
+ "required": true,
722
+ "style": "simple",
723
+ "explode": false,
724
+ "schema": {
725
+ "$ref": "#/components/schemas/OrganizationId"
726
+ }
727
+ }
728
+ ],
729
+ "requestBody": {
730
+ "content": {
731
+ "application/json": {
732
+ "schema": {
733
+ "$ref": "#/components/schemas/CustomerAddress"
734
+ }
735
+ }
736
+ },
737
+ "required": true
738
+ },
739
+ "responses": {
740
+ "200": {
741
+ "description": "Success",
742
+ "content": {
743
+ "application/json": {
744
+ "schema": {
745
+ "$ref": "#/components/schemas/CustomerAddress"
746
+ }
747
+ }
748
+ }
749
+ },
750
+ "400": {
751
+ "description": "Bad Request. Thrown when a specified parameter value is unknown.\n",
752
+ "content": {
753
+ "application/problem+json": {
754
+ "schema": {
755
+ "$ref": "#/components/schemas/ErrorResponse"
756
+ }
757
+ }
758
+ }
759
+ },
760
+ "401": {
761
+ "description": "Unauthorized. Your Client ID is invalid, or you are not allowed to access\nthe content provided by the requested URL.\n",
762
+ "content": {
763
+ "application/problem+json": {
764
+ "schema": {
765
+ "$ref": "#/components/schemas/ErrorResponse"
766
+ }
767
+ }
768
+ }
769
+ },
770
+ "404": {
771
+ "description": "Not Found. This error is thrown when the ID does not match any of the customer group sites or if the ID is ill-formed.",
772
+ "content": {
773
+ "application/problem+json": {
774
+ "schema": {
775
+ "$ref": "#/components/schemas/ErrorResponse"
776
+ }
777
+ }
778
+ }
779
+ }
780
+ },
781
+ "security": [
782
+ {
783
+ "AmOAuth2": [
784
+ "sfcc.customerlists.rw"
785
+ ]
786
+ }
787
+ ]
788
+ }
789
+ },
790
+ "/organizations/{organizationId}/customer-lists/{customerListId}/customers/{customerNo}/addresses/{addressId}": {
791
+ "get": {
792
+ "operationId": "getAddressForCustomerFromCustomerList",
793
+ "parameters": [
794
+ {
795
+ "name": "addressId",
796
+ "in": "path",
797
+ "required": true,
798
+ "style": "simple",
799
+ "explode": false,
800
+ "schema": {
801
+ "type": "string",
802
+ "maxLength": 256,
803
+ "minLength": 1
804
+ }
805
+ },
806
+ {
807
+ "name": "customerNo",
808
+ "in": "path",
809
+ "required": true,
810
+ "style": "simple",
811
+ "explode": false,
812
+ "schema": {
813
+ "type": "string",
814
+ "maxLength": 100,
815
+ "minLength": 1
816
+ }
817
+ },
818
+ {
819
+ "name": "customerListId",
820
+ "in": "path",
821
+ "required": true,
822
+ "style": "simple",
823
+ "explode": false,
824
+ "schema": {
825
+ "type": "string",
826
+ "maxLength": 256,
827
+ "minLength": 1
828
+ }
829
+ },
830
+ {
831
+ "name": "organizationId",
832
+ "in": "path",
833
+ "required": true,
834
+ "style": "simple",
835
+ "explode": false,
836
+ "schema": {
837
+ "$ref": "#/components/schemas/OrganizationId"
838
+ }
839
+ }
840
+ ],
841
+ "responses": {
842
+ "200": {
843
+ "description": "Success",
844
+ "content": {
845
+ "application/json": {
846
+ "schema": {
847
+ "$ref": "#/components/schemas/CustomerAddress"
848
+ }
849
+ }
850
+ }
851
+ },
852
+ "400": {
853
+ "description": "Bad Request. Thrown when a specified parameter value is unknown.\n",
854
+ "content": {
855
+ "application/problem+json": {
856
+ "schema": {
857
+ "$ref": "#/components/schemas/ErrorResponse"
858
+ }
859
+ }
860
+ }
861
+ },
862
+ "401": {
863
+ "description": "Unauthorized. Your Client ID is invalid, or you are not allowed to access\nthe content provided by the requested URL.\n",
864
+ "content": {
865
+ "application/problem+json": {
866
+ "schema": {
867
+ "$ref": "#/components/schemas/ErrorResponse"
868
+ }
869
+ }
870
+ }
871
+ },
872
+ "404": {
873
+ "description": "Not Found. This error is thrown when the ID does not match any of the customer group sites or if the ID is ill-formed.",
874
+ "content": {
875
+ "application/problem+json": {
876
+ "schema": {
877
+ "$ref": "#/components/schemas/ErrorResponse"
878
+ }
879
+ }
880
+ }
881
+ }
882
+ },
883
+ "security": [
884
+ {
885
+ "AmOAuth2": [
886
+ "sfcc.customerlists",
887
+ "sfcc.customerlists.rw"
888
+ ]
889
+ }
890
+ ]
891
+ },
892
+ "delete": {
893
+ "operationId": "removeAddressForCustomerInCustomerList",
894
+ "parameters": [
895
+ {
896
+ "name": "addressId",
897
+ "in": "path",
898
+ "required": true,
899
+ "style": "simple",
900
+ "explode": false,
901
+ "schema": {
902
+ "type": "string",
903
+ "maxLength": 256,
904
+ "minLength": 1
905
+ }
906
+ },
907
+ {
908
+ "name": "customerNo",
909
+ "in": "path",
910
+ "required": true,
911
+ "style": "simple",
912
+ "explode": false,
913
+ "schema": {
914
+ "type": "string",
915
+ "maxLength": 100,
916
+ "minLength": 1
917
+ }
918
+ },
919
+ {
920
+ "name": "customerListId",
921
+ "in": "path",
922
+ "required": true,
923
+ "style": "simple",
924
+ "explode": false,
925
+ "schema": {
926
+ "type": "string",
927
+ "maxLength": 256,
928
+ "minLength": 1
929
+ }
930
+ },
931
+ {
932
+ "name": "organizationId",
933
+ "in": "path",
934
+ "required": true,
935
+ "style": "simple",
936
+ "explode": false,
937
+ "schema": {
938
+ "$ref": "#/components/schemas/OrganizationId"
939
+ }
940
+ }
941
+ ],
942
+ "responses": {
943
+ "204": {
944
+ "description": "No Content"
945
+ },
946
+ "400": {
947
+ "description": "Bad Request. Thrown when a specified parameter value is unknown.\n",
948
+ "content": {
949
+ "application/problem+json": {
950
+ "schema": {
951
+ "$ref": "#/components/schemas/ErrorResponse"
952
+ }
953
+ }
954
+ }
955
+ },
956
+ "401": {
957
+ "description": "Unauthorized. Your Client ID is invalid, or you are not allowed to access\nthe content provided by the requested URL.\n",
958
+ "content": {
959
+ "application/problem+json": {
960
+ "schema": {
961
+ "$ref": "#/components/schemas/ErrorResponse"
962
+ }
963
+ }
964
+ }
965
+ },
966
+ "404": {
967
+ "description": "Not Found. This error is thrown when the ID does not match any of the customer group sites or if the ID is ill-formed.",
968
+ "content": {
969
+ "application/problem+json": {
970
+ "schema": {
971
+ "$ref": "#/components/schemas/ErrorResponse"
972
+ }
973
+ }
974
+ }
975
+ }
976
+ },
977
+ "security": [
978
+ {
979
+ "AmOAuth2": [
980
+ "sfcc.customerlists.rw"
981
+ ]
982
+ }
983
+ ]
984
+ },
985
+ "patch": {
986
+ "operationId": "updateAddressForCustomerInCustomerList",
987
+ "parameters": [
988
+ {
989
+ "name": "addressId",
990
+ "in": "path",
991
+ "required": true,
992
+ "style": "simple",
993
+ "explode": false,
994
+ "schema": {
995
+ "type": "string",
996
+ "maxLength": 256,
997
+ "minLength": 1
998
+ }
999
+ },
1000
+ {
1001
+ "name": "customerNo",
1002
+ "in": "path",
1003
+ "required": true,
1004
+ "style": "simple",
1005
+ "explode": false,
1006
+ "schema": {
1007
+ "type": "string",
1008
+ "maxLength": 100,
1009
+ "minLength": 1
1010
+ }
1011
+ },
1012
+ {
1013
+ "name": "customerListId",
1014
+ "in": "path",
1015
+ "required": true,
1016
+ "style": "simple",
1017
+ "explode": false,
1018
+ "schema": {
1019
+ "type": "string",
1020
+ "maxLength": 256,
1021
+ "minLength": 1
1022
+ }
1023
+ },
1024
+ {
1025
+ "name": "organizationId",
1026
+ "in": "path",
1027
+ "required": true,
1028
+ "style": "simple",
1029
+ "explode": false,
1030
+ "schema": {
1031
+ "$ref": "#/components/schemas/OrganizationId"
1032
+ }
1033
+ }
1034
+ ],
1035
+ "requestBody": {
1036
+ "content": {
1037
+ "application/json": {
1038
+ "schema": {
1039
+ "$ref": "#/components/schemas/CustomerAddress"
1040
+ }
1041
+ }
1042
+ },
1043
+ "required": true
1044
+ },
1045
+ "responses": {
1046
+ "200": {
1047
+ "description": "Success",
1048
+ "content": {
1049
+ "application/json": {
1050
+ "schema": {
1051
+ "$ref": "#/components/schemas/CustomerAddress"
1052
+ }
1053
+ }
1054
+ }
1055
+ },
1056
+ "400": {
1057
+ "description": "Bad Request. Thrown when a specified parameter value is unknown.\n",
1058
+ "content": {
1059
+ "application/problem+json": {
1060
+ "schema": {
1061
+ "$ref": "#/components/schemas/ErrorResponse"
1062
+ }
1063
+ }
1064
+ }
1065
+ },
1066
+ "401": {
1067
+ "description": "Unauthorized. Your Client ID is invalid, or you are not allowed to access\nthe content provided by the requested URL.\n",
1068
+ "content": {
1069
+ "application/problem+json": {
1070
+ "schema": {
1071
+ "$ref": "#/components/schemas/ErrorResponse"
1072
+ }
1073
+ }
1074
+ }
1075
+ },
1076
+ "404": {
1077
+ "description": "Not Found. This error is thrown when the ID does not match any of the customer group sites or if the ID is ill-formed.",
1078
+ "content": {
1079
+ "application/problem+json": {
1080
+ "schema": {
1081
+ "$ref": "#/components/schemas/ErrorResponse"
1082
+ }
1083
+ }
1084
+ }
1085
+ }
1086
+ },
1087
+ "security": [
1088
+ {
1089
+ "AmOAuth2": [
1090
+ "sfcc.customerlists.rw"
1091
+ ]
1092
+ }
1093
+ ]
1094
+ }
1095
+ },
1096
+ "/organizations/{organizationId}/customer-group-search": {
1097
+ "post": {
1098
+ "operationId": "searchCustomerGroup",
1099
+ "parameters": [
1100
+ {
1101
+ "name": "organizationId",
1102
+ "in": "path",
1103
+ "required": true,
1104
+ "style": "simple",
1105
+ "explode": false,
1106
+ "schema": {
1107
+ "$ref": "#/components/schemas/OrganizationId"
1108
+ }
1109
+ },
1110
+ {
1111
+ "name": "siteId",
1112
+ "in": "query",
1113
+ "required": true,
1114
+ "style": "form",
1115
+ "explode": true,
1116
+ "schema": {
1117
+ "$ref": "#/components/schemas/SiteId"
1118
+ }
1119
+ }
1120
+ ],
1121
+ "requestBody": {
1122
+ "content": {
1123
+ "application/json": {
1124
+ "schema": {
1125
+ "$ref": "#/components/schemas/SearchRequest"
1126
+ }
1127
+ }
1128
+ },
1129
+ "required": true
1130
+ },
1131
+ "responses": {
1132
+ "200": {
1133
+ "description": "Success",
1134
+ "content": {
1135
+ "application/json": {
1136
+ "schema": {
1137
+ "$ref": "#/components/schemas/CustomerGroupSearchResult"
1138
+ }
1139
+ }
1140
+ }
1141
+ },
1142
+ "400": {
1143
+ "description": "Bad Request. Thrown if the search term in term query does not match any of the customer group or if the query is ill-formed.\n",
1144
+ "content": {
1145
+ "application/problem+json": {
1146
+ "schema": {
1147
+ "$ref": "#/components/schemas/ErrorResponse"
1148
+ }
1149
+ }
1150
+ }
1151
+ },
1152
+ "401": {
1153
+ "description": "Unauthorized. Your Client ID is invalid, or you are not allowed to access\nthe content provided by the requested URL.\n",
1154
+ "content": {
1155
+ "application/problem+json": {
1156
+ "schema": {
1157
+ "$ref": "#/components/schemas/ErrorResponse"
1158
+ }
1159
+ }
1160
+ }
1161
+ }
1162
+ },
1163
+ "security": [
1164
+ {
1165
+ "AmOAuth2": [
1166
+ "sfcc.customergroups",
1167
+ "sfcc.customergroups.rw"
1168
+ ]
1169
+ }
1170
+ ]
1171
+ }
1172
+ },
1173
+ "/organizations/{organizationId}/customer-groups": {
1174
+ "get": {
1175
+ "operationId": "getCustomerGroups",
1176
+ "parameters": [
1177
+ {
1178
+ "name": "organizationId",
1179
+ "in": "path",
1180
+ "required": true,
1181
+ "style": "simple",
1182
+ "explode": false,
1183
+ "schema": {
1184
+ "$ref": "#/components/schemas/OrganizationId"
1185
+ }
1186
+ },
1187
+ {
1188
+ "name": "siteId",
1189
+ "in": "query",
1190
+ "required": true,
1191
+ "style": "form",
1192
+ "explode": true,
1193
+ "schema": {
1194
+ "$ref": "#/components/schemas/SiteId"
1195
+ }
1196
+ },
1197
+ {
1198
+ "name": "select",
1199
+ "in": "query",
1200
+ "required": false,
1201
+ "style": "form",
1202
+ "explode": true,
1203
+ "schema": {
1204
+ "$ref": "#/components/schemas/Select"
1205
+ }
1206
+ },
1207
+ {
1208
+ "name": "limit",
1209
+ "in": "query",
1210
+ "required": false,
1211
+ "style": "form",
1212
+ "explode": true,
1213
+ "schema": {
1214
+ "type": "integer",
1215
+ "format": "int32",
1216
+ "default": 25,
1217
+ "maximum": 50
1218
+ }
1219
+ },
1220
+ {
1221
+ "name": "offset",
1222
+ "in": "query",
1223
+ "required": false,
1224
+ "style": "form",
1225
+ "explode": true,
1226
+ "schema": {
1227
+ "type": "integer",
1228
+ "format": "int32",
1229
+ "default": 0,
1230
+ "minimum": 0
1231
+ }
1232
+ }
1233
+ ],
1234
+ "responses": {
1235
+ "200": {
1236
+ "description": "Success",
1237
+ "content": {
1238
+ "application/json": {
1239
+ "schema": {
1240
+ "$ref": "#/components/schemas/CustomerGroupResult"
1241
+ }
1242
+ }
1243
+ }
1244
+ },
1245
+ "400": {
1246
+ "description": "Bad Request. Thrown when a specified parameter value is invalid.\n",
1247
+ "content": {
1248
+ "application/problem+json": {
1249
+ "schema": {
1250
+ "$ref": "#/components/schemas/ErrorResponse"
1251
+ }
1252
+ }
1253
+ }
1254
+ }
1255
+ },
1256
+ "security": [
1257
+ {
1258
+ "AmOAuth2": [
1259
+ "sfcc.customergroups",
1260
+ "sfcc.customergroups.rw"
1261
+ ]
1262
+ }
1263
+ ]
1264
+ }
1265
+ },
1266
+ "/organizations/{organizationId}/customer-groups/{customerGroupId}/members": {
1267
+ "put": {
1268
+ "operationId": "assignCustomerGroupMembers",
1269
+ "parameters": [
1270
+ {
1271
+ "name": "organizationId",
1272
+ "in": "path",
1273
+ "required": true,
1274
+ "style": "simple",
1275
+ "explode": false,
1276
+ "schema": {
1277
+ "$ref": "#/components/schemas/OrganizationId"
1278
+ }
1279
+ },
1280
+ {
1281
+ "name": "siteId",
1282
+ "in": "query",
1283
+ "required": true,
1284
+ "style": "form",
1285
+ "explode": true,
1286
+ "schema": {
1287
+ "$ref": "#/components/schemas/SiteId"
1288
+ }
1289
+ },
1290
+ {
1291
+ "name": "customerGroupId",
1292
+ "in": "path",
1293
+ "required": true,
1294
+ "style": "simple",
1295
+ "explode": false,
1296
+ "schema": {
1297
+ "$ref": "#/components/schemas/CustomerGroupId"
1298
+ }
1299
+ },
1300
+ {
1301
+ "name": "customerNos",
1302
+ "in": "query",
1303
+ "required": true,
1304
+ "style": "form",
1305
+ "explode": false,
1306
+ "schema": {
1307
+ "type": "array",
1308
+ "items": {
1309
+ "$ref": "#/components/schemas/CustomerNo"
1310
+ },
1311
+ "maxItems": 50,
1312
+ "minItems": 1
1313
+ }
1314
+ }
1315
+ ],
1316
+ "responses": {
1317
+ "200": {
1318
+ "description": "Successfully returned the assigned customer group members.",
1319
+ "content": {
1320
+ "application/json": {
1321
+ "schema": {
1322
+ "$ref": "#/components/schemas/CustomerGroupMemberResult"
1323
+ }
1324
+ }
1325
+ }
1326
+ },
1327
+ "403": {
1328
+ "description": "Forbidden. The customer group is not a static group.\n",
1329
+ "content": {
1330
+ "application/problem+json": {
1331
+ "schema": {
1332
+ "$ref": "#/components/schemas/ErrorResponse"
1333
+ }
1334
+ }
1335
+ }
1336
+ },
1337
+ "404": {
1338
+ "description": "Not Found. The customer group does not exist or one or more customers were not found.\n",
1339
+ "content": {
1340
+ "application/problem+json": {
1341
+ "schema": {
1342
+ "$ref": "#/components/schemas/ErrorResponse"
1343
+ }
1344
+ }
1345
+ }
1346
+ },
1347
+ "409": {
1348
+ "description": "Conflict. The customer group is already in deletion state.\n",
1349
+ "content": {
1350
+ "application/problem+json": {
1351
+ "schema": {
1352
+ "$ref": "#/components/schemas/ErrorResponse"
1353
+ }
1354
+ }
1355
+ }
1356
+ }
1357
+ },
1358
+ "security": [
1359
+ {
1360
+ "AmOAuth2": [
1361
+ "sfcc.customergroups",
1362
+ "sfcc.customergroups.rw"
1363
+ ]
1364
+ }
1365
+ ]
1366
+ },
1367
+ "delete": {
1368
+ "operationId": "unassignCustomerGroupMembers",
1369
+ "parameters": [
1370
+ {
1371
+ "name": "organizationId",
1372
+ "in": "path",
1373
+ "required": true,
1374
+ "style": "simple",
1375
+ "explode": false,
1376
+ "schema": {
1377
+ "$ref": "#/components/schemas/OrganizationId"
1378
+ }
1379
+ },
1380
+ {
1381
+ "name": "siteId",
1382
+ "in": "query",
1383
+ "required": true,
1384
+ "style": "form",
1385
+ "explode": true,
1386
+ "schema": {
1387
+ "$ref": "#/components/schemas/SiteId"
1388
+ }
1389
+ },
1390
+ {
1391
+ "name": "customerGroupId",
1392
+ "in": "path",
1393
+ "required": true,
1394
+ "style": "simple",
1395
+ "explode": false,
1396
+ "schema": {
1397
+ "$ref": "#/components/schemas/CustomerGroupId"
1398
+ }
1399
+ },
1400
+ {
1401
+ "name": "customerNos",
1402
+ "in": "query",
1403
+ "required": true,
1404
+ "style": "form",
1405
+ "explode": false,
1406
+ "schema": {
1407
+ "type": "array",
1408
+ "items": {
1409
+ "$ref": "#/components/schemas/CustomerNo"
1410
+ },
1411
+ "maxItems": 50,
1412
+ "minItems": 1
1413
+ }
1414
+ }
1415
+ ],
1416
+ "responses": {
1417
+ "204": {
1418
+ "description": "The customers were successfully unassigned from the customer group."
1419
+ },
1420
+ "404": {
1421
+ "description": "Not Found. The customer group does not exist.\n",
1422
+ "content": {
1423
+ "application/problem+json": {
1424
+ "schema": {
1425
+ "$ref": "#/components/schemas/ErrorResponse"
1426
+ }
1427
+ }
1428
+ }
1429
+ },
1430
+ "409": {
1431
+ "description": "Conflict. The customer group is already in deletion state.\n",
1432
+ "content": {
1433
+ "application/problem+json": {
1434
+ "schema": {
1435
+ "$ref": "#/components/schemas/ErrorResponse"
1436
+ }
1437
+ }
1438
+ }
1439
+ }
1440
+ },
1441
+ "security": [
1442
+ {
1443
+ "AmOAuth2": [
1444
+ "sfcc.customergroups",
1445
+ "sfcc.customergroups.rw"
1446
+ ]
1447
+ }
1448
+ ]
1449
+ }
1450
+ }
1451
+ },
1452
+ "components": {
1453
+ "schemas": {
1454
+ "OrganizationId": {
1455
+ "type": "string",
1456
+ "maxLength": 32,
1457
+ "minLength": 1
1458
+ },
1459
+ "Query": {
1460
+ "type": "object",
1461
+ "additionalProperties": false,
1462
+ "maxProperties": 1,
1463
+ "minProperties": 1,
1464
+ "properties": {
1465
+ "boolQuery": {
1466
+ "$ref": "#/components/schemas/BoolQuery"
1467
+ },
1468
+ "filteredQuery": {
1469
+ "$ref": "#/components/schemas/FilteredQuery"
1470
+ },
1471
+ "matchAllQuery": {
1472
+ "$ref": "#/components/schemas/MatchAllQuery"
1473
+ },
1474
+ "nestedQuery": {
1475
+ "$ref": "#/components/schemas/NestedQuery"
1476
+ },
1477
+ "termQuery": {
1478
+ "$ref": "#/components/schemas/TermQuery"
1479
+ },
1480
+ "textQuery": {
1481
+ "$ref": "#/components/schemas/TextQuery"
1482
+ }
1483
+ }
1484
+ },
1485
+ "BoolQuery": {
1486
+ "type": "object",
1487
+ "additionalProperties": false,
1488
+ "properties": {
1489
+ "must": {
1490
+ "type": "array",
1491
+ "items": {
1492
+ "$ref": "#/components/schemas/Query"
1493
+ }
1494
+ },
1495
+ "mustNot": {
1496
+ "type": "array",
1497
+ "items": {
1498
+ "$ref": "#/components/schemas/Query"
1499
+ }
1500
+ },
1501
+ "should": {
1502
+ "type": "array",
1503
+ "items": {
1504
+ "$ref": "#/components/schemas/Query"
1505
+ }
1506
+ }
1507
+ }
1508
+ },
1509
+ "Filter": {
1510
+ "type": "object",
1511
+ "additionalProperties": false,
1512
+ "maxProperties": 1,
1513
+ "minProperties": 1,
1514
+ "properties": {
1515
+ "boolFilter": {
1516
+ "$ref": "#/components/schemas/BoolFilter"
1517
+ },
1518
+ "queryFilter": {
1519
+ "$ref": "#/components/schemas/QueryFilter"
1520
+ },
1521
+ "range2Filter": {
1522
+ "$ref": "#/components/schemas/Range2Filter"
1523
+ },
1524
+ "rangeFilter": {
1525
+ "$ref": "#/components/schemas/RangeFilter"
1526
+ },
1527
+ "termFilter": {
1528
+ "$ref": "#/components/schemas/TermFilter"
1529
+ }
1530
+ }
1531
+ },
1532
+ "BoolFilter": {
1533
+ "type": "object",
1534
+ "additionalProperties": false,
1535
+ "properties": {
1536
+ "filters": {
1537
+ "type": "array",
1538
+ "items": {
1539
+ "$ref": "#/components/schemas/Filter"
1540
+ }
1541
+ },
1542
+ "operator": {
1543
+ "type": "string",
1544
+ "enum": [
1545
+ "and",
1546
+ "or",
1547
+ "not"
1548
+ ]
1549
+ }
1550
+ },
1551
+ "required": [
1552
+ "operator"
1553
+ ]
1554
+ },
1555
+ "QueryFilter": {
1556
+ "type": "object",
1557
+ "properties": {
1558
+ "query": {
1559
+ "$ref": "#/components/schemas/Query"
1560
+ }
1561
+ },
1562
+ "required": [
1563
+ "query"
1564
+ ]
1565
+ },
1566
+ "Field": {
1567
+ "type": "string",
1568
+ "maxLength": 260
1569
+ },
1570
+ "Range2Filter": {
1571
+ "type": "object",
1572
+ "additionalProperties": false,
1573
+ "properties": {
1574
+ "filterMode": {
1575
+ "type": "string",
1576
+ "default": "overlap",
1577
+ "enum": [
1578
+ "overlap",
1579
+ "containing",
1580
+ "contained"
1581
+ ]
1582
+ },
1583
+ "fromField": {
1584
+ "allOf": [
1585
+ {
1586
+ "$ref": "#/components/schemas/Field"
1587
+ }
1588
+ ]
1589
+ },
1590
+ "fromInclusive": {
1591
+ "type": "boolean",
1592
+ "default": true
1593
+ },
1594
+ "fromValue": {},
1595
+ "toField": {
1596
+ "allOf": [
1597
+ {
1598
+ "$ref": "#/components/schemas/Field"
1599
+ }
1600
+ ]
1601
+ },
1602
+ "toInclusive": {
1603
+ "type": "boolean",
1604
+ "default": true
1605
+ },
1606
+ "toValue": {}
1607
+ },
1608
+ "required": [
1609
+ "fromField",
1610
+ "toField"
1611
+ ]
1612
+ },
1613
+ "RangeFilter": {
1614
+ "type": "object",
1615
+ "properties": {
1616
+ "field": {
1617
+ "allOf": [
1618
+ {
1619
+ "$ref": "#/components/schemas/Field"
1620
+ }
1621
+ ]
1622
+ },
1623
+ "from": {
1624
+ "oneOf": [
1625
+ {
1626
+ "type": "string",
1627
+ "format": "date-time"
1628
+ },
1629
+ {
1630
+ "type": "integer"
1631
+ },
1632
+ {
1633
+ "type": "number"
1634
+ }
1635
+ ]
1636
+ },
1637
+ "fromInclusive": {
1638
+ "type": "boolean",
1639
+ "default": true
1640
+ },
1641
+ "to": {
1642
+ "oneOf": [
1643
+ {
1644
+ "type": "string",
1645
+ "format": "date-time"
1646
+ },
1647
+ {
1648
+ "type": "integer"
1649
+ },
1650
+ {
1651
+ "type": "number"
1652
+ }
1653
+ ]
1654
+ },
1655
+ "toInclusive": {
1656
+ "type": "boolean",
1657
+ "default": true
1658
+ }
1659
+ },
1660
+ "required": [
1661
+ "field"
1662
+ ]
1663
+ },
1664
+ "TermFilter": {
1665
+ "type": "object",
1666
+ "additionalProperties": false,
1667
+ "properties": {
1668
+ "field": {
1669
+ "allOf": [
1670
+ {
1671
+ "$ref": "#/components/schemas/Field"
1672
+ }
1673
+ ]
1674
+ },
1675
+ "operator": {
1676
+ "type": "string",
1677
+ "enum": [
1678
+ "is",
1679
+ "one_of",
1680
+ "is_null",
1681
+ "is_not_null",
1682
+ "less",
1683
+ "greater",
1684
+ "not_in",
1685
+ "neq"
1686
+ ]
1687
+ },
1688
+ "values": {
1689
+ "type": "array",
1690
+ "items": {
1691
+ "type": "string"
1692
+ }
1693
+ }
1694
+ },
1695
+ "required": [
1696
+ "field",
1697
+ "operator"
1698
+ ]
1699
+ },
1700
+ "FilteredQuery": {
1701
+ "type": "object",
1702
+ "additionalProperties": false,
1703
+ "properties": {
1704
+ "filter": {
1705
+ "$ref": "#/components/schemas/Filter"
1706
+ },
1707
+ "query": {
1708
+ "$ref": "#/components/schemas/Query"
1709
+ }
1710
+ },
1711
+ "required": [
1712
+ "filter",
1713
+ "query"
1714
+ ]
1715
+ },
1716
+ "MatchAllQuery": {
1717
+ "type": "object"
1718
+ },
1719
+ "NestedQuery": {
1720
+ "type": "object",
1721
+ "additionalProperties": false,
1722
+ "properties": {
1723
+ "path": {
1724
+ "type": "string",
1725
+ "maxLength": 2048
1726
+ },
1727
+ "query": {
1728
+ "$ref": "#/components/schemas/Query"
1729
+ },
1730
+ "scoreMode": {
1731
+ "type": "string",
1732
+ "enum": [
1733
+ "avg",
1734
+ "total",
1735
+ "max",
1736
+ "none"
1737
+ ]
1738
+ }
1739
+ },
1740
+ "required": [
1741
+ "path",
1742
+ "query"
1743
+ ]
1744
+ },
1745
+ "TermQuery": {
1746
+ "type": "object",
1747
+ "properties": {
1748
+ "fields": {
1749
+ "type": "array",
1750
+ "items": {
1751
+ "$ref": "#/components/schemas/Field"
1752
+ },
1753
+ "minItems": 1
1754
+ },
1755
+ "operator": {
1756
+ "type": "string",
1757
+ "enum": [
1758
+ "is",
1759
+ "one_of",
1760
+ "is_null",
1761
+ "is_not_null",
1762
+ "less",
1763
+ "greater",
1764
+ "not_in",
1765
+ "neq"
1766
+ ]
1767
+ },
1768
+ "values": {
1769
+ "type": "array",
1770
+ "items": {
1771
+ "oneOf": [
1772
+ {
1773
+ "type": "string"
1774
+ },
1775
+ {
1776
+ "type": "number"
1777
+ },
1778
+ {
1779
+ "type": "boolean"
1780
+ },
1781
+ {
1782
+ "type": "integer"
1783
+ }
1784
+ ]
1785
+ }
1786
+ }
1787
+ },
1788
+ "required": [
1789
+ "fields",
1790
+ "operator"
1791
+ ]
1792
+ },
1793
+ "TextQuery": {
1794
+ "type": "object",
1795
+ "additionalProperties": false,
1796
+ "properties": {
1797
+ "fields": {
1798
+ "type": "array",
1799
+ "items": {
1800
+ "$ref": "#/components/schemas/Field"
1801
+ },
1802
+ "minItems": 1
1803
+ },
1804
+ "searchPhrase": {
1805
+ "type": "string"
1806
+ }
1807
+ },
1808
+ "required": [
1809
+ "fields",
1810
+ "searchPhrase"
1811
+ ]
1812
+ },
1813
+ "String256": {
1814
+ "type": "string",
1815
+ "maxLength": 256
1816
+ },
1817
+ "Sort": {
1818
+ "type": "object",
1819
+ "additionalProperties": false,
1820
+ "properties": {
1821
+ "field": {
1822
+ "allOf": [
1823
+ {
1824
+ "$ref": "#/components/schemas/String256"
1825
+ }
1826
+ ]
1827
+ },
1828
+ "sortOrder": {
1829
+ "type": "string",
1830
+ "default": "asc",
1831
+ "enum": [
1832
+ "asc",
1833
+ "desc"
1834
+ ]
1835
+ }
1836
+ },
1837
+ "required": [
1838
+ "field"
1839
+ ]
1840
+ },
1841
+ "Offset": {
1842
+ "type": "integer",
1843
+ "format": "int32",
1844
+ "default": 0,
1845
+ "minimum": 0
1846
+ },
1847
+ "SearchRequest": {
1848
+ "type": "object",
1849
+ "properties": {
1850
+ "limit": {
1851
+ "type": "integer",
1852
+ "format": "int32",
1853
+ "maximum": 200,
1854
+ "minimum": 1
1855
+ },
1856
+ "query": {
1857
+ "$ref": "#/components/schemas/Query"
1858
+ },
1859
+ "sorts": {
1860
+ "type": "array",
1861
+ "items": {
1862
+ "$ref": "#/components/schemas/Sort"
1863
+ }
1864
+ },
1865
+ "offset": {
1866
+ "$ref": "#/components/schemas/Offset"
1867
+ }
1868
+ },
1869
+ "required": [
1870
+ "query"
1871
+ ]
1872
+ },
1873
+ "Total": {
1874
+ "type": "integer",
1875
+ "format": "int32",
1876
+ "default": 0,
1877
+ "minimum": 0
1878
+ },
1879
+ "ResultBase": {
1880
+ "type": "object",
1881
+ "properties": {
1882
+ "limit": {
1883
+ "type": "integer",
1884
+ "format": "int32"
1885
+ },
1886
+ "total": {
1887
+ "$ref": "#/components/schemas/Total"
1888
+ }
1889
+ },
1890
+ "required": [
1891
+ "limit",
1892
+ "total"
1893
+ ]
1894
+ },
1895
+ "PaginatedResultBase": {
1896
+ "allOf": [
1897
+ {
1898
+ "$ref": "#/components/schemas/ResultBase"
1899
+ }
1900
+ ],
1901
+ "properties": {
1902
+ "offset": {
1903
+ "$ref": "#/components/schemas/Offset"
1904
+ }
1905
+ },
1906
+ "required": [
1907
+ "limit",
1908
+ "offset",
1909
+ "total"
1910
+ ]
1911
+ },
1912
+ "PaginatedSearchResult": {
1913
+ "additionalProperties": false,
1914
+ "allOf": [
1915
+ {
1916
+ "$ref": "#/components/schemas/PaginatedResultBase"
1917
+ }
1918
+ ],
1919
+ "properties": {
1920
+ "query": {
1921
+ "$ref": "#/components/schemas/Query"
1922
+ },
1923
+ "sorts": {
1924
+ "type": "array",
1925
+ "items": {
1926
+ "$ref": "#/components/schemas/Sort"
1927
+ }
1928
+ },
1929
+ "hits": {
1930
+ "type": "array",
1931
+ "items": {
1932
+ "type": "object"
1933
+ }
1934
+ }
1935
+ },
1936
+ "required": [
1937
+ "query"
1938
+ ]
1939
+ },
1940
+ "Credentials": {
1941
+ "type": "object",
1942
+ "properties": {
1943
+ "enabled": {
1944
+ "type": "boolean"
1945
+ },
1946
+ "locked": {
1947
+ "type": "boolean"
1948
+ },
1949
+ "login": {
1950
+ "type": "string",
1951
+ "maxLength": 256
1952
+ },
1953
+ "passwordQuestion": {
1954
+ "type": "string",
1955
+ "maxLength": 256
1956
+ }
1957
+ },
1958
+ "required": [
1959
+ "login"
1960
+ ]
1961
+ },
1962
+ "CustomerAddress": {
1963
+ "type": "object",
1964
+ "additionalProperties": {},
1965
+ "properties": {
1966
+ "address1": {
1967
+ "type": "string",
1968
+ "maxLength": 256
1969
+ },
1970
+ "address2": {
1971
+ "type": "string",
1972
+ "maxLength": 256
1973
+ },
1974
+ "addressId": {
1975
+ "type": "string",
1976
+ "maxLength": 256
1977
+ },
1978
+ "city": {
1979
+ "type": "string",
1980
+ "maxLength": 256
1981
+ },
1982
+ "companyName": {
1983
+ "type": "string",
1984
+ "maxLength": 256
1985
+ },
1986
+ "countryCode": {
1987
+ "type": "string",
1988
+ "maxLength": 2
1989
+ },
1990
+ "creationDate": {
1991
+ "type": "string",
1992
+ "format": "date-time"
1993
+ },
1994
+ "etag": {
1995
+ "type": "string"
1996
+ },
1997
+ "firstName": {
1998
+ "type": "string",
1999
+ "maxLength": 256
2000
+ },
2001
+ "fullName": {
2002
+ "type": "string",
2003
+ "maxLength": 1027
2004
+ },
2005
+ "jobTitle": {
2006
+ "type": "string",
2007
+ "maxLength": 256
2008
+ },
2009
+ "lastModified": {
2010
+ "type": "string",
2011
+ "format": "date-time"
2012
+ },
2013
+ "lastName": {
2014
+ "type": "string",
2015
+ "maxLength": 256
2016
+ },
2017
+ "phone": {
2018
+ "type": "string",
2019
+ "maxLength": 32
2020
+ },
2021
+ "postBox": {
2022
+ "type": "string",
2023
+ "maxLength": 256
2024
+ },
2025
+ "postalCode": {
2026
+ "type": "string",
2027
+ "maxLength": 256
2028
+ },
2029
+ "salutation": {
2030
+ "type": "string",
2031
+ "maxLength": 256
2032
+ },
2033
+ "secondName": {
2034
+ "type": "string",
2035
+ "maxLength": 256
2036
+ },
2037
+ "stateCode": {
2038
+ "type": "string",
2039
+ "maxLength": 256
2040
+ },
2041
+ "suffix": {
2042
+ "type": "string",
2043
+ "maxLength": 256
2044
+ },
2045
+ "suite": {
2046
+ "type": "string",
2047
+ "maxLength": 32
2048
+ },
2049
+ "title": {
2050
+ "type": "string",
2051
+ "maxLength": 256
2052
+ }
2053
+ },
2054
+ "required": [
2055
+ "addressId",
2056
+ "countryCode",
2057
+ "lastName"
2058
+ ]
2059
+ },
2060
+ "Customer": {
2061
+ "type": "object",
2062
+ "additionalProperties": {},
2063
+ "properties": {
2064
+ "birthday": {
2065
+ "type": "string",
2066
+ "format": "date"
2067
+ },
2068
+ "companyName": {
2069
+ "type": "string",
2070
+ "maxLength": 256
2071
+ },
2072
+ "creationDate": {
2073
+ "type": "string",
2074
+ "format": "date-time"
2075
+ },
2076
+ "credentials": {
2077
+ "$ref": "#/components/schemas/Credentials"
2078
+ },
2079
+ "customerId": {
2080
+ "type": "string",
2081
+ "maxLength": 28
2082
+ },
2083
+ "customerNo": {
2084
+ "type": "string",
2085
+ "maxLength": 100
2086
+ },
2087
+ "email": {
2088
+ "type": "string",
2089
+ "maxLength": 256
2090
+ },
2091
+ "fax": {
2092
+ "type": "string",
2093
+ "maxLength": 32
2094
+ },
2095
+ "firstName": {
2096
+ "type": "string",
2097
+ "maxLength": 256
2098
+ },
2099
+ "gender": {
2100
+ "type": "integer",
2101
+ "format": "int32"
2102
+ },
2103
+ "jobTitle": {
2104
+ "type": "string",
2105
+ "maxLength": 256
2106
+ },
2107
+ "lastLoginTime": {
2108
+ "type": "string",
2109
+ "format": "date-time"
2110
+ },
2111
+ "lastModified": {
2112
+ "type": "string",
2113
+ "format": "date-time"
2114
+ },
2115
+ "lastName": {
2116
+ "type": "string",
2117
+ "maxLength": 256
2118
+ },
2119
+ "lastVisitTime": {
2120
+ "type": "string",
2121
+ "format": "date-time"
2122
+ },
2123
+ "phoneBusiness": {
2124
+ "type": "string",
2125
+ "maxLength": 32
2126
+ },
2127
+ "phoneHome": {
2128
+ "type": "string",
2129
+ "maxLength": 32
2130
+ },
2131
+ "phoneMobile": {
2132
+ "type": "string",
2133
+ "maxLength": 32
2134
+ },
2135
+ "preferredLocale": {
2136
+ "type": "string",
2137
+ "maxLength": 5
2138
+ },
2139
+ "previousLoginTime": {
2140
+ "type": "string",
2141
+ "format": "date-time"
2142
+ },
2143
+ "previousVisitTime": {
2144
+ "type": "string",
2145
+ "format": "date-time"
2146
+ },
2147
+ "primaryAddress": {
2148
+ "$ref": "#/components/schemas/CustomerAddress"
2149
+ },
2150
+ "salutation": {
2151
+ "type": "string",
2152
+ "maxLength": 256
2153
+ },
2154
+ "secondName": {
2155
+ "type": "string",
2156
+ "maxLength": 256
2157
+ },
2158
+ "suffix": {
2159
+ "type": "string",
2160
+ "maxLength": 256
2161
+ },
2162
+ "title": {
2163
+ "type": "string",
2164
+ "maxLength": 256
2165
+ }
2166
+ },
2167
+ "required": [
2168
+ "customerNo",
2169
+ "lastName"
2170
+ ]
2171
+ },
2172
+ "CustomerSearchHit": {
2173
+ "type": "object",
2174
+ "properties": {
2175
+ "data": {
2176
+ "allOf": [
2177
+ {
2178
+ "$ref": "#/components/schemas/Customer"
2179
+ }
2180
+ ]
2181
+ },
2182
+ "relevance": {
2183
+ "type": "number",
2184
+ "format": "double"
2185
+ }
2186
+ },
2187
+ "required": [
2188
+ "data",
2189
+ "relevance"
2190
+ ]
2191
+ },
2192
+ "CustomerSearchResult": {
2193
+ "additionalProperties": false,
2194
+ "allOf": [
2195
+ {
2196
+ "$ref": "#/components/schemas/PaginatedSearchResult"
2197
+ }
2198
+ ],
2199
+ "properties": {
2200
+ "hits": {
2201
+ "type": "array",
2202
+ "items": {
2203
+ "$ref": "#/components/schemas/CustomerSearchHit"
2204
+ }
2205
+ }
2206
+ },
2207
+ "required": [
2208
+ "hits"
2209
+ ]
2210
+ },
2211
+ "ErrorResponse": {
2212
+ "type": "object",
2213
+ "additionalProperties": true,
2214
+ "properties": {
2215
+ "title": {
2216
+ "type": "string",
2217
+ "maxLength": 256
2218
+ },
2219
+ "type": {
2220
+ "type": "string",
2221
+ "maxLength": 2048
2222
+ },
2223
+ "detail": {
2224
+ "type": "string"
2225
+ },
2226
+ "instance": {
2227
+ "type": "string",
2228
+ "maxLength": 2048
2229
+ }
2230
+ },
2231
+ "required": [
2232
+ "detail",
2233
+ "title",
2234
+ "type"
2235
+ ]
2236
+ },
2237
+ "CustomerAddressResult": {
2238
+ "allOf": [
2239
+ {
2240
+ "$ref": "#/components/schemas/PaginatedResultBase"
2241
+ }
2242
+ ],
2243
+ "properties": {
2244
+ "data": {
2245
+ "type": "array",
2246
+ "items": {
2247
+ "$ref": "#/components/schemas/CustomerAddress"
2248
+ }
2249
+ }
2250
+ }
2251
+ },
2252
+ "SiteId": {
2253
+ "type": "string",
2254
+ "maxLength": 32,
2255
+ "minLength": 1
2256
+ },
2257
+ "CustomerGroupRule": {
2258
+ "type": "object",
2259
+ "properties": {
2260
+ "description": {
2261
+ "type": "string"
2262
+ }
2263
+ },
2264
+ "required": [
2265
+ "description"
2266
+ ]
2267
+ },
2268
+ "CustomerGroup": {
2269
+ "type": "object",
2270
+ "additionalProperties": {},
2271
+ "properties": {
2272
+ "creationDate": {
2273
+ "type": "string",
2274
+ "format": "date-time"
2275
+ },
2276
+ "description": {
2277
+ "type": "string",
2278
+ "maxLength": 4000
2279
+ },
2280
+ "id": {
2281
+ "type": "string",
2282
+ "maxLength": 256,
2283
+ "minLength": 1
2284
+ },
2285
+ "inDeletion": {
2286
+ "type": "boolean"
2287
+ },
2288
+ "lastModified": {
2289
+ "type": "string",
2290
+ "format": "date-time"
2291
+ },
2292
+ "memberCount": {
2293
+ "type": "integer",
2294
+ "format": "int32"
2295
+ },
2296
+ "rule": {
2297
+ "$ref": "#/components/schemas/CustomerGroupRule"
2298
+ },
2299
+ "type": {
2300
+ "type": "string",
2301
+ "enum": [
2302
+ "system",
2303
+ "dynamic",
2304
+ "static"
2305
+ ]
2306
+ }
2307
+ },
2308
+ "required": [
2309
+ "id"
2310
+ ]
2311
+ },
2312
+ "CustomerGroupSearchResult": {
2313
+ "additionalProperties": false,
2314
+ "allOf": [
2315
+ {
2316
+ "$ref": "#/components/schemas/PaginatedSearchResult"
2317
+ }
2318
+ ],
2319
+ "properties": {
2320
+ "hits": {
2321
+ "type": "array",
2322
+ "items": {
2323
+ "$ref": "#/components/schemas/CustomerGroup"
2324
+ }
2325
+ }
2326
+ },
2327
+ "required": [
2328
+ "hits"
2329
+ ]
2330
+ },
2331
+ "Select": {
2332
+ "type": "string",
2333
+ "minLength": 1,
2334
+ "pattern": "^[(].*[)]$"
2335
+ },
2336
+ "CustomerGroupResult": {
2337
+ "allOf": [
2338
+ {
2339
+ "$ref": "#/components/schemas/PaginatedResultBase"
2340
+ }
2341
+ ],
2342
+ "properties": {
2343
+ "data": {
2344
+ "type": "array",
2345
+ "items": {
2346
+ "$ref": "#/components/schemas/CustomerGroup"
2347
+ }
2348
+ }
2349
+ },
2350
+ "required": [
2351
+ "data"
2352
+ ]
2353
+ },
2354
+ "CustomerGroupId": {
2355
+ "type": "string",
2356
+ "maxLength": 256,
2357
+ "minLength": 1
2358
+ },
2359
+ "CustomerNo": {
2360
+ "type": "string",
2361
+ "maxLength": 100,
2362
+ "minLength": 1
2363
+ },
2364
+ "CustomerGroupMember": {
2365
+ "type": "object",
2366
+ "properties": {
2367
+ "customerNo": {
2368
+ "type": "string",
2369
+ "maxLength": 100,
2370
+ "minLength": 1
2371
+ },
2372
+ "login": {
2373
+ "type": "string",
2374
+ "maxLength": 256
2375
+ },
2376
+ "firstName": {
2377
+ "type": "string",
2378
+ "maxLength": 256
2379
+ },
2380
+ "lastName": {
2381
+ "type": "string",
2382
+ "maxLength": 256
2383
+ },
2384
+ "active": {
2385
+ "type": "boolean"
2386
+ }
2387
+ },
2388
+ "required": [
2389
+ "customerNo"
2390
+ ]
2391
+ },
2392
+ "CustomerGroupMemberResult": {
2393
+ "allOf": [
2394
+ {
2395
+ "$ref": "#/components/schemas/ResultBase"
2396
+ }
2397
+ ],
2398
+ "properties": {
2399
+ "data": {
2400
+ "type": "array",
2401
+ "items": {
2402
+ "$ref": "#/components/schemas/CustomerGroupMember"
2403
+ }
2404
+ }
2405
+ },
2406
+ "required": [
2407
+ "data"
2408
+ ]
2409
+ }
2410
+ },
2411
+ "parameters": {
2412
+ "customerListId": {
2413
+ "name": "customerListId",
2414
+ "in": "path",
2415
+ "required": true,
2416
+ "style": "simple",
2417
+ "explode": false,
2418
+ "schema": {
2419
+ "type": "string",
2420
+ "maxLength": 256,
2421
+ "minLength": 1
2422
+ }
2423
+ },
2424
+ "organizationId": {
2425
+ "name": "organizationId",
2426
+ "in": "path",
2427
+ "required": true,
2428
+ "style": "simple",
2429
+ "explode": false,
2430
+ "schema": {
2431
+ "$ref": "#/components/schemas/OrganizationId"
2432
+ }
2433
+ },
2434
+ "customerNo": {
2435
+ "name": "customerNo",
2436
+ "in": "path",
2437
+ "required": true,
2438
+ "style": "simple",
2439
+ "explode": false,
2440
+ "schema": {
2441
+ "type": "string",
2442
+ "maxLength": 100,
2443
+ "minLength": 1
2444
+ }
2445
+ },
2446
+ "addressId": {
2447
+ "name": "addressId",
2448
+ "in": "path",
2449
+ "required": true,
2450
+ "style": "simple",
2451
+ "explode": false,
2452
+ "schema": {
2453
+ "type": "string",
2454
+ "maxLength": 256,
2455
+ "minLength": 1
2456
+ }
2457
+ },
2458
+ "siteId": {
2459
+ "name": "siteId",
2460
+ "in": "query",
2461
+ "required": true,
2462
+ "style": "form",
2463
+ "explode": true,
2464
+ "schema": {
2465
+ "$ref": "#/components/schemas/SiteId"
2466
+ }
2467
+ },
2468
+ "select": {
2469
+ "name": "select",
2470
+ "in": "query",
2471
+ "required": false,
2472
+ "style": "form",
2473
+ "explode": true,
2474
+ "schema": {
2475
+ "$ref": "#/components/schemas/Select"
2476
+ }
2477
+ },
2478
+ "customerGroupId": {
2479
+ "name": "customerGroupId",
2480
+ "in": "path",
2481
+ "required": true,
2482
+ "style": "simple",
2483
+ "explode": false,
2484
+ "schema": {
2485
+ "$ref": "#/components/schemas/CustomerGroupId"
2486
+ }
2487
+ },
2488
+ "customerNos": {
2489
+ "name": "customerNos",
2490
+ "in": "query",
2491
+ "required": true,
2492
+ "style": "form",
2493
+ "explode": false,
2494
+ "schema": {
2495
+ "type": "array",
2496
+ "items": {
2497
+ "$ref": "#/components/schemas/CustomerNo"
2498
+ },
2499
+ "maxItems": 50,
2500
+ "minItems": 1
2501
+ }
2502
+ }
2503
+ },
2504
+ "securitySchemes": {
2505
+ "AmOAuth2": {
2506
+ "type": "oauth2",
2507
+ "flows": {
2508
+ "clientCredentials": {
2509
+ "tokenUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
2510
+ "scopes": {
2511
+ "sfcc.customerlists": "Customer Lists scope READONLY",
2512
+ "sfcc.customerlists.rw": "Customer Lists scope",
2513
+ "sfcc.customergroups": "Customer Groups scope READONLY",
2514
+ "sfcc.customergroups.rw": "Customer Groups scope"
2515
+ }
2516
+ },
2517
+ "authorizationCode": {
2518
+ "authorizationUrl": "https://account.demandware.com/dwsso/oauth2/authorize",
2519
+ "tokenUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
2520
+ "scopes": {
2521
+ "sfcc.customerlists": "Customer Lists scope READONLY",
2522
+ "sfcc.customerlists.rw": "Customer Lists scope",
2523
+ "sfcc.customergroups": "Customer Groups scope READONLY",
2524
+ "sfcc.customergroups.rw": "Customer Groups scope"
2525
+ }
2526
+ }
2527
+ }
2528
+ }
2529
+ }
2530
+ }
2531
+ }