> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api/api-en/back-office-api-reference/goods-bo-api/popular-search-term-exclusion-management.md).

# Popular Search Term Exclusion Management

## Save/Modify/Delete Popular Search Term Exclusion

> \## Function Description\
> \* Registers popular search term exclusion information for each site.\
> \---\
> \## Detailed Description\
> \* When registering a new word, site number (siteNo) and excluded search term (excludingSearchTerms) are required.\
> \* When modifying a new word, site number (siteNo) and excluded search term (excludingSearchTerms) can be modified.\
> \* Registered information is sent to the search engine.\
> \---\
> \## Revision History\
> \* \`\`\`Release v2.00\_240627\`\`\` : Search Service (added popular search term exclusion management)\ <br>

````json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RealGridCUDRequestExcludPopularKeywordMgmtRequest":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/ExcludPopularKeywordMgmtRequest"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/ExcludPopularKeywordMgmtRequest"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/ExcludPopularKeywordMgmtRequest"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/ExcludPopularKeywordMgmtRequest"}}}},"ExcludPopularKeywordMgmtRequest":{"type":"object","properties":{"id":{"type":"string"},"excludingSearchTerms":{"type":"string"},"offset":{"type":"integer","format":"int32"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/search/excludPopularKewordMgmt/saveExcludPopularKeword":{"post":{"tags":["Popular Search Term Exclusion Management"],"summary":"Save/Modify/Delete Popular Search Term Exclusion","description":"## Function Description\n* Registers popular search term exclusion information for each site.\n---\n## Detailed Description\n* When registering a new word, site number (siteNo) and excluded search term (excludingSearchTerms) are required.\n* When modifying a new word, site number (siteNo) and excluded search term (excludingSearchTerms) can be modified.\n* Registered information is sent to the search engine.\n---\n## Revision History\n* ```Release v2.00_240627``` : Search Service (added popular search term exclusion management)\n\n","operationId":"saveExcludPopularKeword","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealGridCUDRequestExcludPopularKeywordMgmtRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
````

## Search Popular Search Term Exclusion List

> \## Function Description\
> \* A function that searches the popular search term exclusion list.\
> \## Detailed Description\
> \* Search conditions: site code, search term\
> \* The new word list managed for each site may differ or be the same.\
> \---\
> \## Revision History\
> \* \`\`\`Release v2.00\_240627\`\`\` : Search Service (added popular search term exclusion management)<br>

````json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ExcludPopularKeywordMgmtRequest":{"type":"object","properties":{"id":{"type":"string"},"excludingSearchTerms":{"type":"string"},"offset":{"type":"integer","format":"int32"}}},"ExcludPopularKeywordMgmtResponse":{"type":"object","properties":{"size":{"type":"integer","format":"int32"},"from":{"type":"integer","format":"int32"},"totalCount":{"type":"integer","format":"int32"},"searchDataList":{"type":"array","items":{"$ref":"#/components/schemas/ExcludPopularKeywordMgmtRequest"}}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/search/excludPopularKewordMgmt/getExcludPopularKewordList":{"get":{"tags":["Popular Search Term Exclusion Management"],"summary":"Search Popular Search Term Exclusion List","description":"## Function Description\n* A function that searches the popular search term exclusion list.\n## Detailed Description\n* Search conditions: site code, search term\n* The new word list managed for each site may differ or be the same.\n---\n## Revision History\n* ```Release v2.00_240627``` : Search Service (added popular search term exclusion management)\n","operationId":"getExcludPopularKewordList","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/ExcludPopularKeywordMgmtRequest"}},{"name":"siteNo","in":"query","description":"Site No.","required":true,"schema":{"type":"string"}},{"name":"excludingSearchTerms","in":"query","description":"Excluded Search Term","schema":{"type":"string"}},{"name":"pageIdx","in":"query","description":"Current Page","required":true,"schema":{"type":"string"}},{"name":"rowsPerPage","in":"query","description":"Rows per Page","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExcludPopularKeywordMgmtResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
````
