ShopperSearch productSearch refine parameter should be an Array<string> instead of string to allow for different refinements

[AdrianSatnoianu]

The refine parameter should be able to have multiple values, as per documentation: "... for example: refine=price=(0..10)&refine=c_refinementColor=green."

However the type we have is string. If we try to pass different refine values in the string, the '&' value gets encoded.

We need the type updated to refine?: Arrayfor it to function properly, as it did in the v4.0.0

[joeluong-sfcc]

Hi @AdrianSatnoianu I saw that you created a PR to resolve this. We don't manually edit the API specification files directly as those are owned by the API teams. Since they've decided to type this as type string, the SDK just simply reflects the API contract.

I was able to confirm that if you pass in just the example string refine: 'price=(0..10)&c_refinementColor=green' you'll get an error as you're correct that certain characters get encoded, however, if you pass it as refine: '[price=(0..10),c_refinementColor=green]' with array brackets in the string, this allows the SCAPI call to go through and I get a proper search response. Try this out and let me know if it works for you.

[AdrianSatnoianu]

Hi @joeluong-sfcc ,

Thanks for the answer!

I tried on my side to pass the refine parameter as refine: '[price=(0..10),c_refinementColor=green]' in the shopperSearch.productSearch function.
The result on my side has been encoded still: url?&refine=%5Bprice%3D%280..10%29%2Cc_refinementColor%3Dgreen%5D.( The information I have about the URL is based on the sdkLogger, set at level sdkLogger.levels.INFO)

The reason I created the PR it's because I changed locally the type for the refine parameter to Array and the code worked as expected. That made me think that maybe the type change was by mistake.

Can you check with the API team please to see if that was their intention to change the type of the refine parameter or if it was by accident?

[joeluong-sfcc]

Sure, @AdrianSatnoianu, I'll reach out to the API team and circle back once I get a response

[AdrianSatnoianu]

Thanks @joeluong-sfcc !

[AdrianSatnoianu]

Hi @joeluong-sfcc , do you have any updates on this topic?