From 0a509027c5e64397794d511786b90c271070dc95 Mon Sep 17 00:00:00 2001 From: Ani Hammond Date: Fri, 14 Jul 2023 08:43:08 -0500 Subject: [PATCH] nojira: docs on search result context (#100) Co-authored-by: ani hammond --- examples/events/example-contexts/mock-search-results-context.md | 2 ++ examples/events/readme.md | 1 - .../storefront-events-sdk/src/types/schemas/searchResults.ts | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/examples/events/example-contexts/mock-search-results-context.md b/examples/events/example-contexts/mock-search-results-context.md index a1e67790..79404082 100644 --- a/examples/events/example-contexts/mock-search-results-context.md +++ b/examples/events/example-contexts/mock-search-results-context.md @@ -12,6 +12,8 @@ [Search Results schema](../../../packages/storefront-events-sdk/src/types/schemas/searchResults.ts) +*Note* It is important that `searchUnitId` matches `searchUnitId` in request for the context to be processed by Commerce correctly. + ### Mock data ```javascript diff --git a/examples/events/readme.md b/examples/events/readme.md index 1783c0f5..053709f0 100644 --- a/examples/events/readme.md +++ b/examples/events/readme.md @@ -52,7 +52,6 @@ Setting `Page` and `Storefront` contexts should happen at the page level/storefr The contexts are included in all event generation examples as a reminder that they are required for events to be processed correctly. - ### Debugging #### Adobe Data Layer diff --git a/packages/storefront-events-sdk/src/types/schemas/searchResults.ts b/packages/storefront-events-sdk/src/types/schemas/searchResults.ts index cd5dd610..77081096 100644 --- a/packages/storefront-events-sdk/src/types/schemas/searchResults.ts +++ b/packages/storefront-events-sdk/src/types/schemas/searchResults.ts @@ -3,7 +3,7 @@ export type SearchResults = { }; export type SearchResultUnit = { - searchUnitId: string; + searchUnitId: string; // must match searchUnitId in request searchRequestId: string; rankingType?: string; trendingWindow?: string;