> 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/search-markup-management.md).
# Search Markup Management
## Edit Search Box Markup Usage Status
> \## Function Description\
> \* Edits the usage status value of search box markup on the search box markup management page.\
> \---\
> \## Detailed Description\
> \* Edits the usage status of the selected markups to used/not used.
```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":{"SearchMarkupYnRequest":{"type":"object","description":"Search Markup Usage Status Request","properties":{"schBaseWrdSeqList":{"type":"array","description":"Default Search Phrase Sequence No.","items":{"type":"string"}},"useYn":{"type":"string","description":"Usage Status"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/goods/searchMarkupMgmt/modifySearchMarkupUseYn":{"put":{"tags":["Search Markup Management"],"summary":"Edit Search Box Markup Usage Status","description":"## Function Description\n* Edits the usage status value of search box markup on the search box markup management page.\n---\n## Detailed Description\n* Edits the usage status of the selected markups to used/not used.\n","operationId":"modifySearchMarkupUseYn","parameters":[{"name":"request","in":"query","description":"Search Box Markup Enable/Disable Request","schema":{"type":"SearchMarkupYnRequest"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchMarkupYnRequest"}}},"required":true},"responses":{"200":{"description":"Search box markup usage status edited successfully","content":{"*/*":{"schema":{"type":"integer","format":"int32"}}}},"900":{"description":"Failed to edit search box markup usage status","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
```
## Edit Search Box Markup
> \## Function Description\
> \* Edits search box markup on the search box markup management page.\
> \---\
> \## Detailed Description\
> \* Edits and saves the entered markup information.
```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":{"SearchMarkupRequest":{"type":"object","description":"Search Markup Request","properties":{"schBaseWrdSeq":{"type":"string","description":"Default Search Phrase Sequence No."},"baseSchWrdWrd":{"type":"string","description":"Default Search Term Phrase"},"schWrd":{"type":"string","description":"Search Term"},"baseSchWrdWrdMl":{"type":"string","description":"Default Search Term Phrase (Multilingual)"},"schWrdMl":{"type":"string","description":"Search Term (Multilingual)"},"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"},"dataLangCd":{"type":"string","description":"Multilingual Registration Language Code (CM009)"},"linkUrlAddr":{"type":"string","description":"Linked URL"},"schWrdCondition":{"type":"string","description":"Search Term Condition Type"},"schWrdInput":{"type":"string","description":"Search Term Condition"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/goods/searchMarkupMgmt/modifySearchMarkupInfo":{"put":{"tags":["Search Markup Management"],"summary":"Edit Search Box Markup","description":"## Function Description\n* Edits search box markup on the search box markup management page.\n---\n## Detailed Description\n* Edits and saves the entered markup information.\n","operationId":"modifySearchMarkupInfo","parameters":[{"name":"request","in":"query","description":"Search Box Markup Edit Request","schema":{"type":"SearchMarkupRequest"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchMarkupRequest"}}},"required":true},"responses":{"200":{"description":"Search box markup edited successfully","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Failed to edit search box markup","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
```
## Register/Modify Multilingual Search Box Markup
> \## Function Description\
> \* Registers/modifies multilingual search box markup on the Search Box Markup Management page.\
> \---\
> \## Detailed Description\
> \* Saves the multilingual information of the entered markup.
```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":{"SearchMarkupRequest":{"type":"object","description":"Search Markup Request","properties":{"schBaseWrdSeq":{"type":"string","description":"Default Search Phrase Sequence No."},"baseSchWrdWrd":{"type":"string","description":"Default Search Term Phrase"},"schWrd":{"type":"string","description":"Search Term"},"baseSchWrdWrdMl":{"type":"string","description":"Default Search Term Phrase (Multilingual)"},"schWrdMl":{"type":"string","description":"Search Term (Multilingual)"},"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"},"dataLangCd":{"type":"string","description":"Multilingual Registration Language Code (CM009)"},"linkUrlAddr":{"type":"string","description":"Linked URL"},"schWrdCondition":{"type":"string","description":"Search Term Condition Type"},"schWrdInput":{"type":"string","description":"Search Term Condition"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/goods/searchMarkupMgmt/registSearchMarkupMultiLang":{"post":{"tags":["Search Markup Management"],"summary":"Register/Modify Multilingual Search Box Markup","description":"## Function Description\n* Registers/modifies multilingual search box markup on the Search Box Markup Management page.\n---\n## Detailed Description\n* Saves the multilingual information of the entered markup.\n","operationId":"registSearchMarkupMultiLang","parameters":[{"name":"request","in":"query","description":"Register/Modify Multilingual Search Box Markup Request","schema":{"type":"SearchMarkupRequest"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchMarkupRequest"}}},"required":true},"responses":{"200":{"description":"Register/Modify Multilingual Search Box Markup Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Register/Modify Multilingual Search Box Markup Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
```
## Register Search Box Markup
> \## Function Description\
> \* Registers search box markup on the Search Box Markup Management page.\
> \---\
> \## Detailed Description\
> \* Saves the entered markup information as new.
```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":{"SearchMarkupRequest":{"type":"object","description":"Search Markup Request","properties":{"schBaseWrdSeq":{"type":"string","description":"Default Search Phrase Sequence No."},"baseSchWrdWrd":{"type":"string","description":"Default Search Term Phrase"},"schWrd":{"type":"string","description":"Search Term"},"baseSchWrdWrdMl":{"type":"string","description":"Default Search Term Phrase (Multilingual)"},"schWrdMl":{"type":"string","description":"Search Term (Multilingual)"},"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"},"dataLangCd":{"type":"string","description":"Multilingual Registration Language Code (CM009)"},"linkUrlAddr":{"type":"string","description":"Linked URL"},"schWrdCondition":{"type":"string","description":"Search Term Condition Type"},"schWrdInput":{"type":"string","description":"Search Term Condition"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/goods/searchMarkupMgmt/registSearchMarkupInfo":{"post":{"tags":["Search Markup Management"],"summary":"Register Search Box Markup","description":"## Function Description\n* Registers search box markup on the Search Box Markup Management page.\n---\n## Detailed Description\n* Saves the entered markup information as new.\n","operationId":"registSearchMarkupInfo","parameters":[{"name":"request","in":"query","description":"Register Search Box Markup Request","schema":{"type":"SearchMarkupRequest"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchMarkupRequest"}}},"required":true},"responses":{"200":{"description":"Register Search Box Markup Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Register Search Box Markup Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
```
## Search Search Box Markup List
> \## Function Description\
> \* Searches the search box markup list on the Search Box Markup Management page.\
> \---\
> \## Detailed Description\
> \* Searches the search phrase corresponding to the entered usage status, base search term phrase, and search term.\
> \* Searched in order of most recent application start date/time.\
> \---\
> \## Code Reference\
> \* \`\`\` Search Term Condition Type (schWrdCondition) \`\`\` : baseSchWrdWrd base search term phrase, schWrd search term
````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":{"SearchMarkupRequest":{"type":"object","description":"Search Markup Request","properties":{"schBaseWrdSeq":{"type":"string","description":"Default Search Phrase Sequence No."},"baseSchWrdWrd":{"type":"string","description":"Default Search Term Phrase"},"schWrd":{"type":"string","description":"Search Term"},"baseSchWrdWrdMl":{"type":"string","description":"Default Search Term Phrase (Multilingual)"},"schWrdMl":{"type":"string","description":"Search Term (Multilingual)"},"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"},"dataLangCd":{"type":"string","description":"Multilingual Registration Language Code (CM009)"},"linkUrlAddr":{"type":"string","description":"Linked URL"},"schWrdCondition":{"type":"string","description":"Search Term Condition Type"},"schWrdInput":{"type":"string","description":"Search Term Condition"}}},"SearchMarkupResponse":{"type":"object","description":"Search Markup Response","properties":{"totalCount":{"type":"integer","format":"int32"},"schBaseWrdSeq":{"type":"string","description":"Default Search Phrase Sequence No."},"baseSchWrdWrd":{"type":"string","description":"Default Search Term Phrase"},"schWrd":{"type":"string","description":"Search Term"},"baseSchWrdWrdMl":{"type":"string","description":"Default Search Term Phrase (Multilingual)"},"schWrdMl":{"type":"string","description":"Search Term (Multilingual)"},"linkUrlAddr":{"type":"string","description":"Linked URL"},"siteNm":{"type":"string","description":"Site Name"},"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"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/goods/searchMarkupMgmt/getSearchMarkupList":{"get":{"tags":["Search Markup Management"],"summary":"Search Search Box Markup List","description":"## Function Description\n* Searches the search box markup list on the Search Box Markup Management page.\n---\n## Detailed Description\n* Searches the search phrase corresponding to the entered usage status, base search term phrase, and search term.\n* Searched in order of most recent application start date/time.\n---\n## Code Reference\n* ``` Search Term Condition Type (schWrdCondition) ``` : baseSchWrdWrd base search term phrase, schWrd search term\n","operationId":"getSearchMarkupList","parameters":[{"name":"request","in":"query","description":"Search Box Markup Request","required":true,"schema":{"$ref":"#/components/schemas/SearchMarkupRequest"}}],"responses":{"200":{"description":"Search Search Box Markup List Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SearchMarkupResponse"}}}},"900":{"description":"Search Search Box Markup List Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
````
## Search Box Markup List Count
> \## Function Description\
> \* Searches the search box markup list count on the Search Box Markup Management page.\
> \---\
> \## Detailed Description\
> \* This is the total number of results from searching the search phrase corresponding to the entered usage status, base search term phrase, and search term.\
> \---\
> \## Code Reference\
> \* \`\`\` Search Term Condition Type (schWrdCondition) \`\`\` : baseSchWrdWrd base search term phrase, schWrd search term
````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":{"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/goods/searchMarkupMgmt/getSearchMarkupListCount":{"get":{"tags":["Search Markup Management"],"summary":"Search Box Markup List Count","description":"## Function Description\n* Searches the search box markup list count on the Search Box Markup Management page.\n---\n## Detailed Description\n* This is the total number of results from searching the search phrase corresponding to the entered usage status, base search term phrase, and search term.\n---\n## Code Reference\n* ``` Search Term Condition Type (schWrdCondition) ``` : baseSchWrdWrd base search term phrase, schWrd search term\n","operationId":"getSearchMarkupListCount","parameters":[{"name":"request","in":"query","description":"Search Box Markup List Count Request","required":true,"schema":{"type":"SearchMarkupRequest"}}],"responses":{"200":{"description":"Search Box Markup List Count Success","content":{"*/*":{"schema":{"type":"integer","format":"int32"}}}},"900":{"description":"Search Box Markup List Count Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
````
## Search Search Box Markup Detail
> \## Function Description\
> \* Searches the search box markup details on the Search Box Markup Management page.\
> \---\
> \## Detailed Description\
> \* Searches the base search phrase information of the corresponding markup.
```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":{"SearchMarkupRequest":{"type":"object","description":"Search Markup Request","properties":{"schBaseWrdSeq":{"type":"string","description":"Default Search Phrase Sequence No."},"baseSchWrdWrd":{"type":"string","description":"Default Search Term Phrase"},"schWrd":{"type":"string","description":"Search Term"},"baseSchWrdWrdMl":{"type":"string","description":"Default Search Term Phrase (Multilingual)"},"schWrdMl":{"type":"string","description":"Search Term (Multilingual)"},"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"},"dataLangCd":{"type":"string","description":"Multilingual Registration Language Code (CM009)"},"linkUrlAddr":{"type":"string","description":"Linked URL"},"schWrdCondition":{"type":"string","description":"Search Term Condition Type"},"schWrdInput":{"type":"string","description":"Search Term Condition"}}},"SearchMarkupResponse":{"type":"object","description":"Search Markup Response","properties":{"totalCount":{"type":"integer","format":"int32"},"schBaseWrdSeq":{"type":"string","description":"Default Search Phrase Sequence No."},"baseSchWrdWrd":{"type":"string","description":"Default Search Term Phrase"},"schWrd":{"type":"string","description":"Search Term"},"baseSchWrdWrdMl":{"type":"string","description":"Default Search Term Phrase (Multilingual)"},"schWrdMl":{"type":"string","description":"Search Term (Multilingual)"},"linkUrlAddr":{"type":"string","description":"Linked URL"},"siteNm":{"type":"string","description":"Site Name"},"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"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/goods/searchMarkupMgmt/getSearchMarkupInfo":{"get":{"tags":["Search Markup Management"],"summary":"Search Search Box Markup Detail","description":"## Function Description\n* Searches the search box markup details on the Search Box Markup Management page.\n---\n## Detailed Description\n* Searches the base search phrase information of the corresponding markup.\n","operationId":"getSearchMarkupInfo","parameters":[{"name":"searchMarkupRequest","in":"query","description":"Recommended Search Term Sequence No.","required":true,"schema":{"$ref":"#/components/schemas/SearchMarkupRequest"}}],"responses":{"200":{"description":"Search Search Box Markup Detail Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SearchMarkupResponse"}}}},"900":{"description":"Search Search Box Markup Detail Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
```