@salesforce/b2c-tooling-sdk 2.2.0 → 2.3.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 (79) hide show
  1. package/data/guides/enrichment.json +790 -0
  2. package/data/guides/index.json +1147 -1
  3. package/data/tooling/index.json +15 -6
  4. package/dist/esm/auth/client-credentials.d.ts +43 -0
  5. package/dist/esm/auth/client-credentials.js +55 -0
  6. package/dist/esm/auth/client-credentials.js.map +1 -1
  7. package/dist/esm/auth/index.d.ts +2 -1
  8. package/dist/esm/auth/index.js +1 -1
  9. package/dist/esm/auth/index.js.map +1 -1
  10. package/dist/esm/auth/oauth.d.ts +3 -0
  11. package/dist/esm/auth/oauth.js +3 -3
  12. package/dist/esm/auth/oauth.js.map +1 -1
  13. package/dist/esm/auth/resolve.d.ts +2 -0
  14. package/dist/esm/auth/resolve.js +3 -2
  15. package/dist/esm/auth/resolve.js.map +1 -1
  16. package/dist/esm/auth/types.d.ts +5 -0
  17. package/dist/esm/auth/types.js +0 -5
  18. package/dist/esm/auth/types.js.map +1 -1
  19. package/dist/esm/cli/config.js +1 -0
  20. package/dist/esm/cli/config.js.map +1 -1
  21. package/dist/esm/cli/instance-command.d.ts +1 -0
  22. package/dist/esm/cli/mrt-command.d.ts +1 -0
  23. package/dist/esm/cli/oauth-command.d.ts +1 -0
  24. package/dist/esm/cli/oauth-command.js +8 -0
  25. package/dist/esm/cli/oauth-command.js.map +1 -1
  26. package/dist/esm/cli/ods-command.d.ts +1 -0
  27. package/dist/esm/cli/webdav-command.d.ts +1 -0
  28. package/dist/esm/clients/slas-shopper.generated.d.ts +2 -1
  29. package/dist/esm/config/dw-json.d.ts +3 -0
  30. package/dist/esm/config/dw-json.js.map +1 -1
  31. package/dist/esm/config/mapping.js +7 -0
  32. package/dist/esm/config/mapping.js.map +1 -1
  33. package/dist/esm/config/resolved-config.js +1 -0
  34. package/dist/esm/config/resolved-config.js.map +1 -1
  35. package/dist/esm/config/sources/env-source.js +3 -0
  36. package/dist/esm/config/sources/env-source.js.map +1 -1
  37. package/dist/esm/config/types.d.ts +3 -0
  38. package/dist/esm/docs/search.js +1 -0
  39. package/dist/esm/docs/search.js.map +1 -1
  40. package/dist/esm/docs/types.d.ts +3 -1
  41. package/dist/esm/instance/index.js +1 -0
  42. package/dist/esm/instance/index.js.map +1 -1
  43. package/dist/esm/openshell/apply.d.ts +90 -0
  44. package/dist/esm/openshell/apply.js +225 -0
  45. package/dist/esm/openshell/apply.js.map +1 -0
  46. package/dist/esm/openshell/index.d.ts +30 -0
  47. package/dist/esm/openshell/index.js +34 -0
  48. package/dist/esm/openshell/index.js.map +1 -0
  49. package/dist/esm/openshell/setup.d.ts +94 -0
  50. package/dist/esm/openshell/setup.js +307 -0
  51. package/dist/esm/openshell/setup.js.map +1 -0
  52. package/dist/esm/scapi/auth-primitives.js +1 -0
  53. package/dist/esm/scapi/auth-primitives.js.map +1 -1
  54. package/dist/esm/scapi/authentication.d.ts +19 -0
  55. package/dist/esm/scapi/authentication.js +65 -6
  56. package/dist/esm/scapi/authentication.js.map +1 -1
  57. package/dist/esm/scapi/catalog.d.ts +2 -0
  58. package/dist/esm/scapi/catalog.js.map +1 -1
  59. package/dist/esm/scapi/index.d.ts +7 -3
  60. package/dist/esm/scapi/index.js +4 -2
  61. package/dist/esm/scapi/index.js.map +1 -1
  62. package/dist/esm/scapi/live.d.ts +52 -0
  63. package/dist/esm/scapi/live.js +142 -0
  64. package/dist/esm/scapi/live.js.map +1 -0
  65. package/dist/esm/scapi/request.d.ts +6 -0
  66. package/dist/esm/scapi/request.js +83 -61
  67. package/dist/esm/scapi/request.js.map +1 -1
  68. package/dist/esm/scapi/shopper.d.ts +31 -0
  69. package/dist/esm/scapi/shopper.js +79 -0
  70. package/dist/esm/scapi/shopper.js.map +1 -0
  71. package/dist/esm/scapi/worker-source.js +1 -1
  72. package/dist/esm/slas/index.d.ts +1 -1
  73. package/dist/esm/slas/index.js +1 -1
  74. package/dist/esm/slas/index.js.map +1 -1
  75. package/dist/esm/slas/token.d.ts +10 -0
  76. package/dist/esm/slas/token.js +27 -0
  77. package/dist/esm/slas/token.js.map +1 -1
  78. package/package.json +5 -1
  79. package/specs/slas-shopper-v1.yaml +2 -1
@@ -5951,6 +5951,20 @@
5951
5951
  "SLAS authentication"
5952
5952
  ]
5953
5953
  },
5954
+ "b2c-commerce/ucp-connect-third-party-oms": {
5955
+ "summary": "Integrate a third-party Order Management System with B2C Commerce to manage orders outside the platform.",
5956
+ "keywords": [
5957
+ "OMS",
5958
+ "order management system",
5959
+ "third-party integration",
5960
+ "connect OMS",
5961
+ "external order management",
5962
+ "order system integration",
5963
+ "OMS integration",
5964
+ "order fulfillment",
5965
+ "third party order system"
5966
+ ]
5967
+ },
5954
5968
  "b2c-commerce/ucp-google-gmc-configuration": {
5955
5969
  "summary": "Set up Google as a commerce platform by completing UCP compliance, configuring Google Merchant Center feeds, and sharing checkout credentials for Gemini and AI Mode shopping.",
5956
5970
  "keywords": [
@@ -7912,6 +7926,765 @@
7912
7926
  "commerce API"
7913
7927
  ]
7914
7928
  },
7929
+ "ocapi/apiexplorer": {
7930
+ "summary": "Interactively explore, browse, and test Open Commerce APIs using the API Explorer tool with Swagger UI.",
7931
+ "keywords": [
7932
+ "API Explorer",
7933
+ "OCAPI",
7934
+ "Open Commerce API",
7935
+ "Swagger UI",
7936
+ "test APIs",
7937
+ "browse APIs",
7938
+ "API documentation",
7939
+ "interactive exploration",
7940
+ "meta API",
7941
+ "Swagger 2.0",
7942
+ "demo metadata",
7943
+ "API testing tool"
7944
+ ]
7945
+ },
7946
+ "ocapi/apiusage": {
7947
+ "summary": "Learn how to use OCAPI including API exploration, batch requests, caching, CORS, customization, and optimization techniques.",
7948
+ "keywords": [
7949
+ "OCAPI usage",
7950
+ "Open Commerce API",
7951
+ "API Explorer",
7952
+ "batch requests",
7953
+ "OCAPI best practices",
7954
+ "CORS",
7955
+ "caching",
7956
+ "client identification",
7957
+ "expansions",
7958
+ "custom properties",
7959
+ "OCAPI customization",
7960
+ "multipart requests"
7961
+ ]
7962
+ },
7963
+ "ocapi/batchrequests": {
7964
+ "summary": "Send up to 50 subrequests in a single multipart HTTP POST/OPTIONS request to reduce network overhead and API calls.",
7965
+ "keywords": [
7966
+ "OCAPI batch requests",
7967
+ "multipart HTTP request",
7968
+ "batch API",
7969
+ "reduce network calls",
7970
+ "subrequests",
7971
+ "Content-Type multipart/mixed",
7972
+ "batch endpoint",
7973
+ "OCAPI batching",
7974
+ "multiple API calls",
7975
+ "request consolidation",
7976
+ "OCAPI performance"
7977
+ ]
7978
+ },
7979
+ "ocapi/bestpractices": {
7980
+ "summary": "Learn OCAPI best practices for building scalable, high-performance applications, including caching behavior and request optimization strategies.",
7981
+ "keywords": [
7982
+ "OCAPI best practices",
7983
+ "OCAPI performance",
7984
+ "OCAPI vs controllers",
7985
+ "OCAPI caching",
7986
+ "application tier cache",
7987
+ "OCAPI requests",
7988
+ "request optimization",
7989
+ "batch requests",
7990
+ "thread behavior",
7991
+ "payload size",
7992
+ "scalable OCAPI",
7993
+ "OCAPI tuning"
7994
+ ]
7995
+ },
7996
+ "ocapi/caching": {
7997
+ "summary": "Configure HTTP cache headers and max-age times for OCAPI Shop API resources to enable client and proxy caching.",
7998
+ "keywords": [
7999
+ "OCAPI caching",
8000
+ "HTTP cache headers",
8001
+ "max-age",
8002
+ "cache control",
8003
+ "Shop API caching",
8004
+ "cache configuration",
8005
+ "REST API caching",
8006
+ "cache time settings",
8007
+ "proxy cache",
8008
+ "Business Manager cache",
8009
+ "cache enablement",
8010
+ "response caching"
8011
+ ]
8012
+ },
8013
+ "ocapi/clientapplicationidentification": {
8014
+ "summary": "Identify client applications to OCAPI by obtaining and including a client ID in every API request using tokens, parameters, or headers.",
8015
+ "keywords": [
8016
+ "OCAPI client ID",
8017
+ "client application identification",
8018
+ "Open Commerce API authentication",
8019
+ "x-dw-client-id header",
8020
+ "client_id parameter",
8021
+ "Bearer token",
8022
+ "JWT issuer claim",
8023
+ "Account Manager API client",
8024
+ "OCAPI authorization",
8025
+ "API client registration"
8026
+ ]
8027
+ },
8028
+ "ocapi/cors": {
8029
+ "summary": "Enable browser-based cross-origin API requests securely using CORS headers and preflight mechanisms instead of same-origin policy restrictions.",
8030
+ "keywords": [
8031
+ "CORS",
8032
+ "cross-origin resource sharing",
8033
+ "cross-origin requests",
8034
+ "XMLHttpRequest",
8035
+ "preflight",
8036
+ "HTTP headers",
8037
+ "same origin policy",
8038
+ "browser security",
8039
+ "API access",
8040
+ "credentials",
8041
+ "OPTIONS request",
8042
+ "JSONP alternative"
8043
+ ]
8044
+ },
8045
+ "ocapi/customization": {
8046
+ "summary": "Customize Shop API resources using before, after, and modifyResponse hooks to augment server-side logic with custom script code.",
8047
+ "keywords": [
8048
+ "OCAPI hooks",
8049
+ "Shop API customization",
8050
+ "before hooks",
8051
+ "after hooks",
8052
+ "modifyResponse",
8053
+ "extension points",
8054
+ "basket calculations",
8055
+ "checkout customization",
8056
+ "server-side logic",
8057
+ "API resource modification",
8058
+ "convenience hooks",
8059
+ "OCAPI extensions"
8060
+ ]
8061
+ },
8062
+ "ocapi/customproperties": {
8063
+ "summary": "Set and read custom properties on OCAPI business objects using c_ prefix with supported value types across SHOP and DATA APIs.",
8064
+ "keywords": [
8065
+ "OCAPI custom properties",
8066
+ "c_ prefix",
8067
+ "custom properties OCAPI",
8068
+ "business object properties",
8069
+ "OCAPI value types",
8070
+ "SHOP API custom properties",
8071
+ "DATA API custom properties",
8072
+ "input output documents",
8073
+ "OCAPI hooks",
8074
+ "modify hooks",
8075
+ "custom fields OCAPI"
8076
+ ]
8077
+ },
8078
+ "ocapi/dataformats": {
8079
+ "summary": "Learn how to specify JSON or XML data formats for OCAPI requests using URL parameters and HTTP headers.",
8080
+ "keywords": [
8081
+ "OCAPI data formats",
8082
+ "JSON XML",
8083
+ "content-type header",
8084
+ "format parameter",
8085
+ "REST API formats",
8086
+ "OCAPI request formats",
8087
+ "HTTP content negotiation",
8088
+ "API response format",
8089
+ "application/json",
8090
+ "application/xml"
8091
+ ]
8092
+ },
8093
+ "ocapi/exceptions": {
8094
+ "summary": "Reference for all OCAPI global exceptions with status codes, types, arguments, and descriptions for error handling.",
8095
+ "keywords": [
8096
+ "OCAPI exceptions",
8097
+ "global exceptions",
8098
+ "error handling",
8099
+ "status codes",
8100
+ "BodyDecodingException",
8101
+ "EnumConstraintViolationException",
8102
+ "HookStatusException",
8103
+ "InvalidClientIdException",
8104
+ "HTTP method override",
8105
+ "exception types",
8106
+ "OCAPI errors"
8107
+ ]
8108
+ },
8109
+ "ocapi/expansions": {
8110
+ "summary": "Use OCAPI expand query parameter to include omitted subresource data in products and product_search API responses, reducing network traffic by default.",
8111
+ "keywords": [
8112
+ "OCAPI expansions",
8113
+ "expand query parameter",
8114
+ "products resource",
8115
+ "product_search",
8116
+ "subresources",
8117
+ "API response optimization",
8118
+ "network traffic reduction",
8119
+ "comma-separated expansion",
8120
+ "products prices variations",
8121
+ "OCAPI response filtering"
8122
+ ]
8123
+ },
8124
+ "ocapi/exportdataunitsconfiguration": {
8125
+ "summary": "Configure which data units to export from a B2C Commerce site by specifying catalogs, inventories, libraries, customer lists, and global data.",
8126
+ "keywords": [
8127
+ "ExportDataUnitsConfiguration",
8128
+ "site export",
8129
+ "data units",
8130
+ "export configuration",
8131
+ "catalogs export",
8132
+ "inventory export",
8133
+ "libraries export",
8134
+ "customer lists export",
8135
+ "global data export",
8136
+ "OCAPI export",
8137
+ "data export settings"
8138
+ ]
8139
+ },
8140
+ "ocapi/exportglobaldataconfiguration": {
8141
+ "summary": "Configure which global data units to export from a B2C Commerce instance using ExportGlobalDataConfiguration document properties.",
8142
+ "keywords": [
8143
+ "ExportGlobalDataConfiguration",
8144
+ "global data export",
8145
+ "export configuration",
8146
+ "OCAPI",
8147
+ "data export settings",
8148
+ "global preferences export",
8149
+ "custom types export",
8150
+ "job schedules export",
8151
+ "metadata export",
8152
+ "instance configuration export",
8153
+ "selective data export",
8154
+ "export options"
8155
+ ]
8156
+ },
8157
+ "ocapi/exportsitesconfiguration": {
8158
+ "summary": "Configure which site-specific data units to export using boolean properties in the ExportSitesConfiguration document.",
8159
+ "keywords": [
8160
+ "ExportSitesConfiguration",
8161
+ "site export configuration",
8162
+ "export data units",
8163
+ "site data export",
8164
+ "OCAPI export",
8165
+ "site configuration export",
8166
+ "export settings",
8167
+ "site backup",
8168
+ "data export document",
8169
+ "site preferences export"
8170
+ ]
8171
+ },
8172
+ "ocapi/filtering": {
8173
+ "summary": "Filter OCAPI resource instances by specifying parameters like type and direction to reduce result sets.",
8174
+ "keywords": [
8175
+ "OCAPI filtering",
8176
+ "filter parameters",
8177
+ "resource filtering",
8178
+ "OCAPI query",
8179
+ "result set filtering",
8180
+ "resource type filtering",
8181
+ "relationship filtering",
8182
+ "OCAPI REST",
8183
+ "filter syntax",
8184
+ "cross_sell filter"
8185
+ ]
8186
+ },
8187
+ "ocapi/flash": {
8188
+ "summary": "Use OCAPI Flash property to store special document information like basket submission errors and unavailable products.",
8189
+ "keywords": [
8190
+ "OCAPI Flash",
8191
+ "basket flash",
8192
+ "document property",
8193
+ "addFlash",
8194
+ "removeFlash",
8195
+ "getFlashes",
8196
+ "basket submission",
8197
+ "product unavailable",
8198
+ "flash messages",
8199
+ "scripting API",
8200
+ "basket errors",
8201
+ "flash paths"
8202
+ ]
8203
+ },
8204
+ "ocapi/get-started-with-ocapi": {
8205
+ "summary": "Learn how to access B2C Commerce resources using OCAPI with HTTP requests, including Shop API, Data API, and Meta API fundamentals.",
8206
+ "keywords": [
8207
+ "OCAPI",
8208
+ "Open Commerce API",
8209
+ "REST API",
8210
+ "Shop API",
8211
+ "Data API",
8212
+ "Meta API",
8213
+ "HTTP requests",
8214
+ "client ID",
8215
+ "API authentication",
8216
+ "get started",
8217
+ "API setup",
8218
+ "commerce resources"
8219
+ ]
8220
+ },
8221
+ "ocapi/globaljobs": {
8222
+ "summary": "Execute global jobs to build search indexes for active data and content across B2C Commerce sites using OCAPI.",
8223
+ "keywords": [
8224
+ "global jobs",
8225
+ "search index update",
8226
+ "active data index",
8227
+ "content index",
8228
+ "job execution",
8229
+ "OCAPI jobs",
8230
+ "sfcc-search-index",
8231
+ "site scope",
8232
+ "index building",
8233
+ "SearchIndexUpdateConfiguration",
8234
+ "JobExecution",
8235
+ "full index update"
8236
+ ]
8237
+ },
8238
+ "ocapi/hookcircuitbreaker": {
8239
+ "summary": "Manage hook stability and prevent cascading failures using the Circuit Breaker feature that tracks failed hook executions and returns 503 errors.",
8240
+ "keywords": [
8241
+ "hook circuit breaker",
8242
+ "OCAPI hooks",
8243
+ "hook failures",
8244
+ "503 service unavailable",
8245
+ "extension point",
8246
+ "HookCircuitBreakerException",
8247
+ "circuit breaker states",
8248
+ "hook monitoring",
8249
+ "hook troubleshooting",
8250
+ "hook rate limiting",
8251
+ "HookInvocationException",
8252
+ "half-open state"
8253
+ ]
8254
+ },
8255
+ "ocapi/hooks-data": {
8256
+ "summary": "Execute custom logic after content asset creation, deletion, or update operations via OCAPI Data API hooks in version 24.5.",
8257
+ "keywords": [
8258
+ "OCAPI hooks",
8259
+ "Data API",
8260
+ "content hooks",
8261
+ "afterCreate",
8262
+ "afterDelete",
8263
+ "afterUpdate",
8264
+ "content asset",
8265
+ "lifecycle hooks",
8266
+ "dw.ocapi.data.content",
8267
+ "trigger actions",
8268
+ "API callbacks"
8269
+ ]
8270
+ },
8271
+ "ocapi/hooks-shop": {
8272
+ "summary": "Intercept and customize customer authentication in Shop API using OCAPI hooks before and after POST /customers/auth requests.",
8273
+ "keywords": [
8274
+ "OCAPI hooks",
8275
+ "Shop API authentication",
8276
+ "beforePOST",
8277
+ "afterPOST",
8278
+ "customer auth",
8279
+ "/customers/auth",
8280
+ "auth hooks",
8281
+ "authentication lifecycle",
8282
+ "guest login refresh",
8283
+ "authorization header",
8284
+ "hook execution"
8285
+ ]
8286
+ },
8287
+ "ocapi/http-headers": {
8288
+ "summary": "Reference guide to OCAPI global HTTP headers for requests and responses, including CORS and character encoding.",
8289
+ "keywords": [
8290
+ "OCAPI headers",
8291
+ "HTTP headers",
8292
+ "CORS headers",
8293
+ "Accept-Charset",
8294
+ "Access-Control-Allow",
8295
+ "request headers",
8296
+ "response headers",
8297
+ "OCAPI reference",
8298
+ "cross-origin",
8299
+ "preflight request",
8300
+ "HTTP standards"
8301
+ ]
8302
+ },
8303
+ "ocapi/httpmethods": {
8304
+ "summary": "Learn how OCAPI supports RESTful HTTP methods (GET, DELETE, PUT) for retrieving, removing, and managing resources with proper status codes.",
8305
+ "keywords": [
8306
+ "HTTP methods",
8307
+ "OCAPI",
8308
+ "REST API",
8309
+ "GET",
8310
+ "DELETE",
8311
+ "PUT",
8312
+ "RESTful",
8313
+ "status codes",
8314
+ "RFC 2616",
8315
+ "resource management",
8316
+ "idempotent"
8317
+ ]
8318
+ },
8319
+ "ocapi/httpstatuscodesandfaults": {
8320
+ "summary": "Understand OCAPI HTTP status codes and fault documents for handling errors in Open Commerce API requests.",
8321
+ "keywords": [
8322
+ "OCAPI HTTP status codes",
8323
+ "API error handling",
8324
+ "fault documents",
8325
+ "400 Bad Request",
8326
+ "401 Unauthorized",
8327
+ "404 Not Found",
8328
+ "500 Internal Server Error",
8329
+ "HTTP response codes",
8330
+ "Open Commerce API errors",
8331
+ "REST API status codes",
8332
+ "OCAPI faults",
8333
+ "error responses"
8334
+ ]
8335
+ },
8336
+ "ocapi/httpversions": {
8337
+ "summary": "OCAPI supports HTTP/1.1 (case-insensitive headers) and HTTP/2 (lowercase headers required) with format differences and availability by instance type.",
8338
+ "keywords": [
8339
+ "HTTP versions",
8340
+ "HTTP/1.1",
8341
+ "HTTP/2",
8342
+ "OCAPI",
8343
+ "header names",
8344
+ "case-insensitive",
8345
+ "lowercase headers",
8346
+ "instance group",
8347
+ "production staging development",
8348
+ "ODS sandbox",
8349
+ "RFC 7540",
8350
+ "RFC 2616"
8351
+ ]
8352
+ },
8353
+ "ocapi/images": {
8354
+ "summary": "OCAPI returns image URLs through the Shop API as absolute URLs for product and content images.",
8355
+ "keywords": [
8356
+ "OCAPI images",
8357
+ "Shop API",
8358
+ "image URLs",
8359
+ "absolute URLs",
8360
+ "Open Commerce API",
8361
+ "product images",
8362
+ "image endpoints",
8363
+ "OCAPI Shop",
8364
+ "content images",
8365
+ "image resources"
8366
+ ]
8367
+ },
8368
+ "ocapi/jsonp": {
8369
+ "summary": "Use OCAPI's callback parameter to enable JSONP responses for cross-domain browser requests with wrapped JSON data.",
8370
+ "keywords": [
8371
+ "OCAPI JSONP",
8372
+ "JSON with padding",
8373
+ "callback parameter",
8374
+ "cross-domain requests",
8375
+ "JSONP",
8376
+ "browser JavaScript",
8377
+ "cross-origin",
8378
+ "API response format",
8379
+ "wrapped JSON",
8380
+ "Open Commerce API"
8381
+ ]
8382
+ },
8383
+ "ocapi/jwt": {
8384
+ "summary": "Use JWT authentication with OCAPI Shop API resources by obtaining tokens via /customers/auth or /customers/auth/trustedsystem endpoints after registering your client application.",
8385
+ "keywords": [
8386
+ "OCAPI JWT",
8387
+ "JSON Web Token authentication",
8388
+ "Shop API",
8389
+ "customer auth",
8390
+ "/customers/auth",
8391
+ "OAuth token",
8392
+ "client ID",
8393
+ "trusted system",
8394
+ "API authentication",
8395
+ "OCAPI security",
8396
+ "JWT token",
8397
+ "Account Manager registration"
8398
+ ]
8399
+ },
8400
+ "ocapi/localization": {
8401
+ "summary": "Learn how to request localized content in OCAPI Shop API and Data API using locale parameters and fallback behavior.",
8402
+ "keywords": [
8403
+ "OCAPI localization",
8404
+ "locale parameter",
8405
+ "Shop API locale",
8406
+ "Data API locale",
8407
+ "language code country code",
8408
+ "locale fallback",
8409
+ "localized content",
8410
+ "multi-locale",
8411
+ "language fallback",
8412
+ "locale format",
8413
+ "OCAPI internationalization"
8414
+ ]
8415
+ },
8416
+ "ocapi/metadata": {
8417
+ "summary": "Access OCAPI metadata to discover available APIs, versions, resources, and documents with OAuth authentication.",
8418
+ "keywords": [
8419
+ "OCAPI metadata",
8420
+ "meta API",
8421
+ "API discovery",
8422
+ "available APIs",
8423
+ "API versions",
8424
+ "resource descriptions",
8425
+ "OCAPI settings",
8426
+ "OAuth token",
8427
+ "metadata caching",
8428
+ "API documentation",
8429
+ "Shop API metadata",
8430
+ "Data API metadata"
8431
+ ]
8432
+ },
8433
+ "ocapi/oauth": {
8434
+ "summary": "Authenticate OCAPI requests using OAuth 2.0 with client credentials grant or Business Manager user grant based on server-to-server or user interaction scenarios.",
8435
+ "keywords": [
8436
+ "OCAPI OAuth 2.0",
8437
+ "OAuth authentication",
8438
+ "client credentials grant",
8439
+ "Business Manager user grant",
8440
+ "Data API authentication",
8441
+ "Shop API authentication",
8442
+ "server-to-server OAuth",
8443
+ "OCAPI authorization",
8444
+ "OAuth 2.0 protocol",
8445
+ "API access control"
8446
+ ]
8447
+ },
8448
+ "ocapi/ocapi-api-doc": {
8449
+ "summary": "Reference documentation for OCAPI Shop API and Data API endpoints for B2C Commerce development.",
8450
+ "keywords": [
8451
+ "OCAPI",
8452
+ "Shop API",
8453
+ "Data API",
8454
+ "API reference",
8455
+ "B2C Commerce",
8456
+ "REST API",
8457
+ "commerce API",
8458
+ "OCAPI endpoints",
8459
+ "API documentation",
8460
+ "commerce endpoints"
8461
+ ]
8462
+ },
8463
+ "ocapi/ocapisettings": {
8464
+ "summary": "Configure OCAPI settings in Business Manager to manage client permissions, caching, and API behavior across sites or globally.",
8465
+ "keywords": [
8466
+ "OCAPI settings",
8467
+ "configure OCAPI",
8468
+ "Business Manager OCAPI",
8469
+ "client permissions",
8470
+ "OCAPI caching",
8471
+ "global settings",
8472
+ "site-specific settings",
8473
+ "Open Commerce API",
8474
+ "API configuration",
8475
+ "OCAPI deprecation",
8476
+ "SCAPI migration",
8477
+ "JSON configuration"
8478
+ ]
8479
+ },
8480
+ "ocapi/opencommerceapi": {
8481
+ "summary": "RESTful API with Shop, Data, and Meta components for accessing Commerce Cloud Digital storefront and configuration functionality.",
8482
+ "keywords": [
8483
+ "Open Commerce API",
8484
+ "OCAPI",
8485
+ "REST API",
8486
+ "Shop API",
8487
+ "Data API",
8488
+ "Meta API",
8489
+ "Commerce Cloud Digital",
8490
+ "storefront API",
8491
+ "B2C Commerce API",
8492
+ "API components",
8493
+ "REST endpoints",
8494
+ "commerce integration"
8495
+ ]
8496
+ },
8497
+ "ocapi/optimisticlocking": {
8498
+ "summary": "Understand OCAPI's two-level optimistic locking mechanism for preventing concurrent modification conflicts and handling HTTP 409 errors.",
8499
+ "keywords": [
8500
+ "optimistic locking",
8501
+ "OCAPI",
8502
+ "concurrent modification",
8503
+ "HTTP 409",
8504
+ "ConcurrentModificationException",
8505
+ "data consistency",
8506
+ "lost update problem",
8507
+ "retry logic",
8508
+ "conflict resolution",
8509
+ "Commerce Cloud Digital"
8510
+ ]
8511
+ },
8512
+ "ocapi/pagination": {
8513
+ "summary": "Configure OCAPI pagination using start and count parameters to retrieve API collection data in manageable chunks with navigation links.",
8514
+ "keywords": [
8515
+ "OCAPI pagination",
8516
+ "start parameter",
8517
+ "count parameter",
8518
+ "API paging",
8519
+ "collection pagination",
8520
+ "Open Commerce API",
8521
+ "paginate results",
8522
+ "next previous links",
8523
+ "resource chunks",
8524
+ "API response paging",
8525
+ "pagination parameters",
8526
+ "offset limit"
8527
+ ]
8528
+ },
8529
+ "ocapi/propertyselection": {
8530
+ "summary": "Use property selectors with the select parameter to reduce API response size by retrieving only needed resource properties.",
8531
+ "keywords": [
8532
+ "property selection",
8533
+ "select parameter",
8534
+ "OCAPI",
8535
+ "resource properties",
8536
+ "bandwidth optimization",
8537
+ "property selectors",
8538
+ "API filtering",
8539
+ "complex properties",
8540
+ "child document properties",
8541
+ "array indexing",
8542
+ "filter expression"
8543
+ ]
8544
+ },
8545
+ "ocapi/queries": {
8546
+ "summary": "Use queries to selectively retrieve OCAPI data with match_all, term, text, boolean, and filtered query types to reduce bandwidth.",
8547
+ "keywords": [
8548
+ "OCAPI queries",
8549
+ "query types",
8550
+ "match_all_query",
8551
+ "term_query",
8552
+ "text_query",
8553
+ "boolean_query",
8554
+ "filtered_query",
8555
+ "data filtering",
8556
+ "search criteria",
8557
+ "record selection",
8558
+ "query syntax",
8559
+ "OCAPI data retrieval"
8560
+ ]
8561
+ },
8562
+ "ocapi/resourcestates": {
8563
+ "summary": "Implement optimistic locking in OCAPI clients using resource state tokens to prevent concurrent update collisions.",
8564
+ "keywords": [
8565
+ "resource state",
8566
+ "OCAPI resource state",
8567
+ "optimistic locking",
8568
+ "_resource_state",
8569
+ "x-dw-resource-state",
8570
+ "concurrency control",
8571
+ "lost update problem",
8572
+ "ETag alternative",
8573
+ "collision prevention",
8574
+ "resource state header",
8575
+ "OCAPI locking"
8576
+ ]
8577
+ },
8578
+ "ocapi/searchindexupdateconfiguration": {
8579
+ "summary": "Configure search index update settings with site scope properties for B2C Commerce OCAPI.",
8580
+ "keywords": [
8581
+ "search index update",
8582
+ "SearchIndexUpdateConfiguration",
8583
+ "site scope",
8584
+ "search index configuration",
8585
+ "OCAPI",
8586
+ "index settings",
8587
+ "search configuration",
8588
+ "index update",
8589
+ "site_scope",
8590
+ "search indexing"
8591
+ ]
8592
+ },
8593
+ "ocapi/sessionbridge": {
8594
+ "summary": "Enable seamless authentication between OCAPI and session-based storefronts by exchanging JWTs and session cookies without reauthentication.",
8595
+ "keywords": [
8596
+ "OCAPI session bridge",
8597
+ "JWT session exchange",
8598
+ "dwsid cookie",
8599
+ "customers/auth resource",
8600
+ "/sessions resource",
8601
+ "Authorization Bearer token",
8602
+ "session authentication",
8603
+ "OCAPI authentication",
8604
+ "guest customer JWT",
8605
+ "registered customer session",
8606
+ "dwsecuretoken",
8607
+ "seamless authentication"
8608
+ ]
8609
+ },
8610
+ "ocapi/sitearchiveexportconfiguration": {
8611
+ "summary": "Configure site archive export jobs by specifying data units, export file path, and overwrite settings for OCAPI system jobs.",
8612
+ "keywords": [
8613
+ "SiteArchiveExportConfiguration",
8614
+ "site archive export",
8615
+ "OCAPI document",
8616
+ "export configuration",
8617
+ "data units export",
8618
+ "system job",
8619
+ "export file",
8620
+ "IMPEX",
8621
+ "overwrite export",
8622
+ "archive export setup"
8623
+ ]
8624
+ },
8625
+ "ocapi/sitearchiveimportconfiguration": {
8626
+ "summary": "Configure site archive import settings including file path and merge mode for system jobs.",
8627
+ "keywords": [
8628
+ "SiteArchiveImportConfiguration",
8629
+ "site archive import",
8630
+ "import configuration",
8631
+ "system job import",
8632
+ "file_name property",
8633
+ "merge mode",
8634
+ "import mode",
8635
+ "archive import setup",
8636
+ "OCAPI import",
8637
+ "site data import"
8638
+ ]
8639
+ },
8640
+ "ocapi/systemjobs": {
8641
+ "summary": "Trigger and monitor predefined OCAPI system jobs via background job requests with job status responses.",
8642
+ "keywords": [
8643
+ "OCAPI system jobs",
8644
+ "background jobs",
8645
+ "job status",
8646
+ "OCAPI Data API",
8647
+ "sfcc- prefix",
8648
+ "system job request",
8649
+ "job triggering",
8650
+ "job monitoring",
8651
+ "predefined jobs",
8652
+ "job ID",
8653
+ "OCAPI request"
8654
+ ]
8655
+ },
8656
+ "ocapi/urlschema": {
8657
+ "summary": "Learn how to construct OCAPI URLs using base URL and extended URL patterns for accessing Commerce Cloud API resources.",
8658
+ "keywords": [
8659
+ "OCAPI URL syntax",
8660
+ "Open Commerce API URLs",
8661
+ "base URL structure",
8662
+ "extended URL patterns",
8663
+ "OCAPI endpoints",
8664
+ "Commerce Cloud API URLs",
8665
+ "URL construction",
8666
+ "API resource access",
8667
+ "production instance URL",
8668
+ "non-production instance URL",
8669
+ "api_type",
8670
+ "site_id"
8671
+ ]
8672
+ },
8673
+ "ocapi/versioninganddeprecationpolicy": {
8674
+ "summary": "Understand OCAPI versioning scheme, deprecation policy, and how version numbers are formatted in URLs and documents.",
8675
+ "keywords": [
8676
+ "OCAPI versioning",
8677
+ "API deprecation policy",
8678
+ "version numbers",
8679
+ "API versioning strategy",
8680
+ "OCAPI versions",
8681
+ "version format",
8682
+ "deprecated API versions",
8683
+ "API version management",
8684
+ "Commerce Cloud API versioning",
8685
+ "version numbering scheme"
8686
+ ]
8687
+ },
7915
8688
  "pwa-kit-managed-runtime/active-data": {
7916
8689
  "summary": "Use Active Data in PWA Kit to collect shopper engagement and order metrics for merchandising rules and performance analysis.",
7917
8690
  "keywords": [
@@ -10194,6 +10967,23 @@
10194
10967
  "site-locale prefix"
10195
10968
  ]
10196
10969
  },
10970
+ "sfnext/sfnext-hybrid-section": {
10971
+ "summary": "Set up and deploy Storefront Next alongside existing SFRA or SiteGenesis storefronts using Hybrid Auth with routing and authentication.",
10972
+ "keywords": [
10973
+ "hybrid storefront",
10974
+ "Storefront Next",
10975
+ "SFRA",
10976
+ "SiteGenesis",
10977
+ "Hybrid Auth",
10978
+ "go live",
10979
+ "routing configuration",
10980
+ "login registration hybrid",
10981
+ "parallel deployment",
10982
+ "storefront migration",
10983
+ "authentication hybrid",
10984
+ "multi-storefront setup"
10985
+ ]
10986
+ },
10197
10987
  "sfnext/sfnext-images": {
10198
10988
  "summary": "Optimize storefront images using Dynamic Imaging Service (DIS) and the DynamicImage component for responsive, format-converted, server-resized delivery.",
10199
10989
  "keywords": [