> 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/keyword-boosting-management.md).
# Keyword Boosting Management
## Retrieve Keyword Boosting Details
> \## Function Description\
> \* This API retrieves keyword boosting detail information.\
> \---\
> \## Detailed Description\
> \* Retrieves keyword boosting detail information.\
> \---\
> \## Revision History\
> \* \`\`\`Release v1.04\_231120\`\`\` : Keyword boosting settings
````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":{"ResponseKwdBoostingDetailResponse":{"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":{"$ref":"#/components/schemas/KwdBoostingDetailResponse","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"KwdBoostingDetailResponse":{"type":"object","properties":{"siteNo":{"type":"string","description":"Site No."},"bstNo":{"type":"string","description":"Boosting No."},"kwd":{"type":"string","description":"Keyword"},"useYn":{"type":"string","description":"Usage Status"},"aplyCategory":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"Applicable Condition - Display Category"}},"aplyBrand":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"Applicable Condition - Brand"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"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"}}}}}},"paths":{"/v1/search/kwdBoostingMgmt/{bstNo}":{"get":{"tags":["Keyword Boosting Management"],"summary":"Retrieve Keyword Boosting Details","description":"## Function Description\n* This API retrieves keyword boosting detail information.\n---\n## Detailed Description\n* Retrieves keyword boosting detail information.\n---\n## Revision History\n* ```Release v1.04_231120``` : Keyword boosting settings\n","operationId":"detail","parameters":[{"name":"bstNo","in":"path","description":"Boosting No.","required":true,"schema":{"type":"string","description":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseKwdBoostingDetailResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
````
## Edit Keyword Boosting Details
> \## Function Description\
> \* This API edits keyword boosting detail information.\
> \---\
> \## Detailed Description\
> \* Edits keyword boosting detail information.\
> \---\
> \## Revision History\
> \* \`\`\`Release v1.04\_231120\`\`\` : Keyword boosting settings
````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":{"KwdBoostingSaveRequest":{"type":"object","description":"Keyword Boosting Save Request Model","properties":{"siteNo":{"type":"string","description":"Site No."},"bstNo":{"type":"string","description":"Boosting No."},"kwd":{"type":"string","description":"Keyword"},"useYn":{"type":"string","description":"Usage Status"},"aplyCategory":{"type":"array","description":"Applied Category List","items":{"type":"string"}},"aplyBrand":{"type":"array","description":"Applied Brand List","items":{"type":"string"}}}},"ResponseString":{"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":{"type":"string","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"}}},"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"}}}}}},"paths":{"/v1/search/kwdBoostingMgmt/{bstNo}":{"put":{"tags":["Keyword Boosting Management"],"summary":"Edit Keyword Boosting Details","description":"## Function Description\n* This API edits keyword boosting detail information.\n---\n## Detailed Description\n* Edits keyword boosting detail information.\n---\n## Revision History\n* ```Release v1.04_231120``` : Keyword boosting settings\n","operationId":"modify","parameters":[{"name":"bstNo","in":"path","description":"Boosting No.","required":true,"schema":{"type":"string","description":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KwdBoostingSaveRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
````
## Validate Keyword Boosting
> \## Function Description\
> \* An API that validates keyword boosting information.\
> \---\
> \## Detailed Description\
> \* Validation items\
> \- Keyword duplicate check (within the same site)\
> \- Display category validation\
> \* For new registration: call without bstNo\
> \* For modification: call with bstNo included (excluding itself)\
```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":{"KwdBoostingSaveRequest":{"type":"object","description":"Keyword Boosting Save Request Model","properties":{"siteNo":{"type":"string","description":"Site No."},"bstNo":{"type":"string","description":"Boosting No."},"kwd":{"type":"string","description":"Keyword"},"useYn":{"type":"string","description":"Usage Status"},"aplyCategory":{"type":"array","description":"Applied Category List","items":{"type":"string"}},"aplyBrand":{"type":"array","description":"Applied Brand List","items":{"type":"string"}}}},"ResponseString":{"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":{"type":"string","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"}}},"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"}}}}}},"paths":{"/v1/search/kwdBoostingMgmt/validate":{"post":{"tags":["Keyword Boosting Management"],"summary":"Validate Keyword Boosting","description":"## Function Description\n* An API that validates keyword boosting information.\n---\n## Detailed Description\n* Validation items\n - Keyword duplicate check (within the same site)\n - Display category validation\n* For new registration: call without bstNo\n* For modification: call with bstNo included (excluding itself)\n\n","operationId":"validate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KwdBoostingSaveRequest"}}},"required":true},"responses":{"200":{"description":"Success (validation passed)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"Validation Failed","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Register Keyword Boosting Information
> \## Function Description\
> \* An API that registers keyword boosting information.\
> \---\
> \## Detailed Description\
> \* Input parameters ( \* : required)\
> \* create : kwd \*, useYn \*, siteNo \*\
> \* update : bstNo \*, kwd \*, useYn \*, siteNo \*\
> \---\
> \## Revision History\
> \* \`\`\`Release v1.04\_231120\`\`\` : Keyword boosting settings
````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":{"KwdBoostingSaveRequest":{"type":"object","description":"Keyword Boosting Save Request Model","properties":{"siteNo":{"type":"string","description":"Site No."},"bstNo":{"type":"string","description":"Boosting No."},"kwd":{"type":"string","description":"Keyword"},"useYn":{"type":"string","description":"Usage Status"},"aplyCategory":{"type":"array","description":"Applied Category List","items":{"type":"string"}},"aplyBrand":{"type":"array","description":"Applied Brand List","items":{"type":"string"}}}},"ResponseString":{"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":{"type":"string","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"}}},"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"}}}}}},"paths":{"/v1/search/kwdBoostingMgmt/save":{"post":{"tags":["Keyword Boosting Management"],"summary":"Register Keyword Boosting Information","description":"## Function Description\n* An API that registers keyword boosting information.\n---\n## Detailed Description\n* Input parameters ( * : required)\n * create : kwd *, useYn *, siteNo *\n * update : bstNo *, kwd *, useYn *, siteNo *\n---\n## Revision History\n* ```Release v1.04_231120``` : Keyword boosting settings\n","operationId":"save","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KwdBoostingSaveRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
````
## Search Keyword Boosting List
> \## Function Description\
> \* An API that searches the keyword boosting information list.\
> \---\
> \## Detailed Description\
> \* Search conditions: keyword, site number, usage status, boosting type\
> \* The keyword boosting list is displayed in descending order of boosting number.\
> \* Boosting types: brand, category\
> \---\
> \## Revision History\
> \* \`\`\`Release v1.04\_231120\`\`\` : Keyword boosting settings
````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":{"ResponseRealGridListResponseKwdBoostingBase":{"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":{"$ref":"#/components/schemas/RealGridListResponseKwdBoostingBase","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"RealGridListResponseKwdBoostingBase":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/KwdBoostingBase"}}}},"KwdBoostingBase":{"type":"object","description":"Keyword Boosting Basic Model","properties":{"siteNo":{"type":"string","description":"Site No."},"bstNo":{"type":"string","description":"Boosting No."},"kwd":{"type":"string","description":"Keyword"},"useYn":{"type":"string","description":"Usage Status"},"bstTypCdList":{"type":"string","description":"Boosting Type Code List"},"bstType":{"type":"string","description":"Boosting Type"}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"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"}}}}}},"paths":{"/v1/search/kwdBoostingMgmt/getKwdBoostingList":{"get":{"tags":["Keyword Boosting Management"],"summary":"Search Keyword Boosting List","description":"## Function Description\n* An API that searches the keyword boosting information list.\n---\n## Detailed Description\n* Search conditions: keyword, site number, usage status, boosting type\n* The keyword boosting list is displayed in descending order of boosting number.\n* Boosting types: brand, category\n---\n## Revision History\n* ```Release v1.04_231120``` : Keyword boosting settings\n","operationId":"getKwdBoostingList","parameters":[{"name":"kwd","in":"query","description":"Keyword","schema":{"type":"string"}},{"name":"siteNo","in":"query","description":"Site No.","schema":{"type":"string"}},{"name":"useYn","in":"query","description":"Usage Status","schema":{"type":"string"}},{"name":"bstType","in":"query","description":"Boosting Type","schema":{"type":"string","enum":["brand","category"]}},{"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/ResponseRealGridListResponseKwdBoostingBase"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
````
## Delete Keyword Boosting Information
> \## Function Description\
> \* An API that deletes keyword boosting information.\
> \---\
> \## Detailed Description\
> \* Deletes keyword boosting information by boosting number.\
> \---\
> \## Revision History\
> \* \`\`\`Release v1.04\_231120\`\`\` : Keyword boosting settings
````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":{"ResponseString":{"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":{"type":"string","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"}}},"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"}}}}}},"paths":{"/v1/search/kwdBoostingMgmt/list":{"delete":{"tags":["Keyword Boosting Management"],"summary":"Delete Keyword Boosting Information","description":"## Function Description\n* An API that deletes keyword boosting information.\n---\n## Detailed Description\n* Deletes keyword boosting information by boosting number.\n---\n## Revision History\n* ```Release v1.04_231120``` : Keyword boosting settings\n","operationId":"delete","parameters":[{"name":"bstNoList","in":"query","description":"Boosting Number Array","required":true,"schema":{"type":"array"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
````