> 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/recommended-search-term-management.md).

# Recommended Search Term Management

## Edit Recommended Search Term / Recommended Search Term (Multilingual)

> \## Function Description\
> \* Edits the recommended search term / recommended search term multilingual content on the recommended search term page.\
> \---\
> \## Detailed Description\
> \* Edits the multilingual content of the recommended search term / recommended search term.<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":{"RecomSchWrdInfoRequest":{"type":"object","description":"Recommended Search Term Information Request","properties":{"recomSchWrdSeq":{"type":"string","description":"Recommended Search Term Sequence No. (PK)"},"aplyStrDtm":{"type":"string","format":"date-time","description":"Application Start Date/Time"},"aplyEndDtm":{"type":"string","format":"date-time","description":"Application End Date/Time"},"useYn":{"type":"string","description":"Usage Status"},"sortSeq":{"type":"integer","format":"int32","description":"Display Order"},"recomSchWrd":{"type":"string","description":"Recommended Search Term"},"mlRecomSchWrd":{"type":"string","description":"English Recommended Search Term"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/goods/recomSchWrdMgmtApi/modifyRecomSchWrdInfo":{"put":{"tags":["Recommended Search Term Management"],"summary":"Edit Recommended Search Term / Recommended Search Term (Multilingual)","description":"## Function Description\n* Edits the recommended search term / recommended search term multilingual content on the recommended search term page.\n---\n## Detailed Description\n* Edits the multilingual content of the recommended search term / recommended search term.\n","operationId":"modifyRecomSchWrdInfo","parameters":[{"name":"request","in":"query","description":"Recommended Search Term / Recommended Search Term (Multilingual) Edit Request","schema":{"$ref":"#/components/schemas/RecomSchWrdInfoRequest"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecomSchWrdInfoRequest"}}},"required":true},"responses":{"200":{"description":"Recommended search term / recommended search term (multilingual) edited successfully","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Failed to edit recommended search term / recommended search term (multilingual)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
```

## Register Multilingual Recommended Search Term

> \## Function Description\
> \* Registers multilingual recommended search terms on the Recommended Search Term page.\
> \---\
> \## Detailed Description\
> \* Registers multilingual recommended search terms.<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":{"RecomSchWrdInfoRequest":{"type":"object","description":"Recommended Search Term Information Request","properties":{"recomSchWrdSeq":{"type":"string","description":"Recommended Search Term Sequence No. (PK)"},"aplyStrDtm":{"type":"string","format":"date-time","description":"Application Start Date/Time"},"aplyEndDtm":{"type":"string","format":"date-time","description":"Application End Date/Time"},"useYn":{"type":"string","description":"Usage Status"},"sortSeq":{"type":"integer","format":"int32","description":"Display Order"},"recomSchWrd":{"type":"string","description":"Recommended Search Term"},"mlRecomSchWrd":{"type":"string","description":"English Recommended Search Term"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/goods/recomSchWrdMgmtApi/registerRecomSchWrdMultiLangInfo":{"post":{"tags":["Recommended Search Term Management"],"summary":"Register Multilingual Recommended Search Term","description":"## Function Description\n* Registers multilingual recommended search terms on the Recommended Search Term page.\n---\n## Detailed Description\n* Registers multilingual recommended search terms.\n","operationId":"registerRecomSchWrdMultiLangInfo","parameters":[{"name":"request","in":"query","description":"Register Multilingual Recommended Search Term Request","schema":{"$ref":"#/components/schemas/RecomSchWrdInfoRequest"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecomSchWrdInfoRequest"}}},"required":true},"responses":{"200":{"description":"Register Multilingual Recommended Search Term Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Register Multilingual Recommended Search Term Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
```

## Register Recommended Search Term

> \## Function Description\
> \* Registers a recommended search term on the Recommended Search Term page.\
> \---\
> \## Detailed Description\
> \* Registers a new recommended search term.<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":{"RecomSchWrdInfoRequest":{"type":"object","description":"Recommended Search Term Information Request","properties":{"recomSchWrdSeq":{"type":"string","description":"Recommended Search Term Sequence No. (PK)"},"aplyStrDtm":{"type":"string","format":"date-time","description":"Application Start Date/Time"},"aplyEndDtm":{"type":"string","format":"date-time","description":"Application End Date/Time"},"useYn":{"type":"string","description":"Usage Status"},"sortSeq":{"type":"integer","format":"int32","description":"Display Order"},"recomSchWrd":{"type":"string","description":"Recommended Search Term"},"mlRecomSchWrd":{"type":"string","description":"English Recommended Search Term"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/goods/recomSchWrdMgmtApi/registerRecomSchWrdInfo":{"post":{"tags":["Recommended Search Term Management"],"summary":"Register Recommended Search Term","description":"## Function Description\n* Registers a recommended search term on the Recommended Search Term page.\n---\n## Detailed Description\n* Registers a new recommended search term.\n","operationId":"registerRecomSchWrdInfo","parameters":[{"name":"request","in":"query","description":"Register Recommended Search Term Request","schema":{"$ref":"#/components/schemas/RecomSchWrdInfoRequest"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecomSchWrdInfoRequest"}}},"required":true},"responses":{"200":{"description":"Register Recommended Search Term Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Register Recommended Search Term Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
```

## Modify Recommended Search Term Grid

> \## Function Description\
> \* Saves the modifications made to the recommended search term grid on the Recommended Search Term page.\
> \---\
> \## Detailed Description\
> \* Saves the modifications made in the recommended search term grid.<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":{"RealGridCUDRequestRecomSchWrdInfoRequest":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/RecomSchWrdInfoRequest"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/RecomSchWrdInfoRequest"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/RecomSchWrdInfoRequest"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/RecomSchWrdInfoRequest"}}}},"RecomSchWrdInfoRequest":{"type":"object","description":"Recommended Search Term Information Request","properties":{"recomSchWrdSeq":{"type":"string","description":"Recommended Search Term Sequence No. (PK)"},"aplyStrDtm":{"type":"string","format":"date-time","description":"Application Start Date/Time"},"aplyEndDtm":{"type":"string","format":"date-time","description":"Application End Date/Time"},"useYn":{"type":"string","description":"Usage Status"},"sortSeq":{"type":"integer","format":"int32","description":"Display Order"},"recomSchWrd":{"type":"string","description":"Recommended Search Term"},"mlRecomSchWrd":{"type":"string","description":"English Recommended Search Term"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/goods/recomSchWrdMgmtApi/modifyRecomSchWrdGrid":{"post":{"tags":["Recommended Search Term Management"],"summary":"Modify Recommended Search Term Grid","description":"## Function Description\n* Saves the modifications made to the recommended search term grid on the Recommended Search Term page.\n---\n## Detailed Description\n* Saves the modifications made in the recommended search term grid.\n","operationId":"modifyRecomSchWrdGrid","parameters":[{"name":"request","in":"query","description":"Modify Recommended Search Term List Request","schema":{"type":"RecomSchWrdInfoRequest"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealGridCUDRequestRecomSchWrdInfoRequest"}}},"required":true},"responses":{"200":{"description":"Modify Recommended Search Term Grid Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Modify Recommended Search Term Grid Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
```

## Search Registered Multilingual Count of Recommended Search Term

> \## Function Description\
> \* Searches the registered multilingual count of the recommended search term on the Recommended Search Term page.\
> \---\
> \## Detailed Description\
> \* The total count result value of this API is used to determine whether the recommended search term is a new registration or a modification.<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":{"RecomSchWrdInfoRequest":{"type":"object","description":"Recommended Search Term Information Request","properties":{"recomSchWrdSeq":{"type":"string","description":"Recommended Search Term Sequence No. (PK)"},"aplyStrDtm":{"type":"string","format":"date-time","description":"Application Start Date/Time"},"aplyEndDtm":{"type":"string","format":"date-time","description":"Application End Date/Time"},"useYn":{"type":"string","description":"Usage Status"},"sortSeq":{"type":"integer","format":"int32","description":"Display Order"},"recomSchWrd":{"type":"string","description":"Recommended Search Term"},"mlRecomSchWrd":{"type":"string","description":"English Recommended Search Term"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/goods/recomSchWrdMgmtApi/getRecomSchWrdMultiLangCount":{"get":{"tags":["Recommended Search Term Management"],"summary":"Search Registered Multilingual Count of Recommended Search Term","description":"## Function Description\n* Searches the registered multilingual count of the recommended search term on the Recommended Search Term page.\n---\n## Detailed Description\n* The total count result value of this API is used to determine whether the recommended search term is a new registration or a modification.\n","operationId":"getRecomSchWrdMultiLangCount","parameters":[{"name":"request","in":"query","description":"Search Registered Multilingual Count of Recommended Search Term Request","required":true,"schema":{"$ref":"#/components/schemas/RecomSchWrdInfoRequest"}}],"responses":{"200":{"description":"Search Registered Multilingual Count of Recommended Search Term Success","content":{"*/*":{"schema":{"type":"integer","format":"int32"}}}},"900":{"description":"Search Registered Multilingual Count of Recommended Search Term Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
```

## Recommended Search Term List

> \## Function Description\
> \* Searches the recommended search term list on the Recommended Search Term page.\
> \---\
> \## Detailed Description\
> \* Searches the recommended search term corresponding to the entered usage status and recommended search term.\
> \* Searched in order of most recent application start date/time.<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":{"RecomSchWrdRequest":{"type":"object","description":"Recommended Search Term Request","properties":{"siteNo":{"type":"string","description":"Site"},"dataLangCd":{"type":"string","description":"Multilingual Registration Language Code"},"aplyStrDtm":{"type":"string","format":"date-time","description":"Application Start Date/Time"},"aplyEndDtm":{"type":"string","format":"date-time","description":"Application End Date/Time"},"useYn":{"type":"string","description":"Usage Status"},"recomSchWrd":{"type":"string","description":"Recommended Search Term"},"dateSelect":{"type":"string","description":"Date Button"},"recomSchWrdSeq":{"type":"string","description":"Recommended Search Term Sequence No. (PK)"}}},"RecomSchWrdResponse":{"type":"object","description":"Recommended Search Term Response","properties":{"siteNo":{"type":"string","description":"Site No."},"sysRegDtm":{"type":"string","format":"date-time","description":"Registration Date/Time"},"sysRegId":{"type":"string","description":"Registrant"},"siteNm":{"type":"string","description":"Site Name"},"recomSchWrdSeq":{"type":"string","description":"Recommended Search Term Sequence No."},"recomSchWrd":{"type":"string","description":"Recommended Search Term"},"mlRecomSchWrd":{"type":"string","description":"Multilingual Recommended Search Term"},"useYn":{"type":"string","description":"Usage Status"},"sortSeq":{"type":"string","description":"Display Order"},"aplyStrDtm":{"type":"string","format":"date-time","description":"Application Start Date/Time"},"aplyEndDtm":{"type":"string","format":"date-time","description":"Application End Date/Time"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/goods/recomSchWrdMgmtApi/getRecomSchWrdList":{"get":{"tags":["Recommended Search Term Management"],"summary":"Recommended Search Term List","description":"## Function Description\n* Searches the recommended search term list on the Recommended Search Term page.\n---\n## Detailed Description\n* Searches the recommended search term corresponding to the entered usage status and recommended search term.\n* Searched in order of most recent application start date/time.\n","operationId":"getRecomSchWrdList","parameters":[{"name":"recomSchWrdRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/RecomSchWrdRequest"}},{"name":"request","in":"query","description":"Recommended Search Term Request","schema":{"$ref":"#/components/schemas/RecomSchWrdRequest"}}],"responses":{"200":{"description":"Recommended Search Term Retrieved Successfully","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RecomSchWrdResponse"}}}},"900":{"description":"Recommended Search Term Retrieval Failed","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
```

## Search Recommended Search Term Detail

> \## Function Description\
> \* Searches the detailed content of the recommended search term on the Recommended Search Term page.\
> \---\
> \## Detailed Description\
> \* Searches the detailed content of the corresponding recommended search term.<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":{"RecomSchWrdRequest":{"type":"object","description":"Recommended Search Term Request","properties":{"siteNo":{"type":"string","description":"Site"},"dataLangCd":{"type":"string","description":"Multilingual Registration Language Code"},"aplyStrDtm":{"type":"string","format":"date-time","description":"Application Start Date/Time"},"aplyEndDtm":{"type":"string","format":"date-time","description":"Application End Date/Time"},"useYn":{"type":"string","description":"Usage Status"},"recomSchWrd":{"type":"string","description":"Recommended Search Term"},"dateSelect":{"type":"string","description":"Date Button"},"recomSchWrdSeq":{"type":"string","description":"Recommended Search Term Sequence No. (PK)"}}},"RecomSchWrdResponse":{"type":"object","description":"Recommended Search Term Response","properties":{"siteNo":{"type":"string","description":"Site No."},"sysRegDtm":{"type":"string","format":"date-time","description":"Registration Date/Time"},"sysRegId":{"type":"string","description":"Registrant"},"siteNm":{"type":"string","description":"Site Name"},"recomSchWrdSeq":{"type":"string","description":"Recommended Search Term Sequence No."},"recomSchWrd":{"type":"string","description":"Recommended Search Term"},"mlRecomSchWrd":{"type":"string","description":"Multilingual Recommended Search Term"},"useYn":{"type":"string","description":"Usage Status"},"sortSeq":{"type":"string","description":"Display Order"},"aplyStrDtm":{"type":"string","format":"date-time","description":"Application Start Date/Time"},"aplyEndDtm":{"type":"string","format":"date-time","description":"Application End Date/Time"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/goods/recomSchWrdMgmtApi/getRecomSchWrdInfo":{"get":{"tags":["Recommended Search Term Management"],"summary":"Search Recommended Search Term Detail","description":"## Function Description\n* Searches the detailed content of the recommended search term on the Recommended Search Term page.\n---\n## Detailed Description\n* Searches the detailed content of the corresponding recommended search term.\n","operationId":"getRecomSchWrdInfo","parameters":[{"name":"recomSchWrdRequest","in":"query","description":"Recommended Search Term Sequence No.","required":true,"schema":{"$ref":"#/components/schemas/RecomSchWrdRequest"}}],"responses":{"200":{"description":"Search Recommended Search Term Detail Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RecomSchWrdResponse"}}}},"900":{"description":"Search Recommended Search Term Detail Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
```