> 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/system-bo-api/postal-code-management.md).
# Postal Code Management
## Save/Modify/Delete Postal Code
> \## Function Description\
> \* Saves, modifies, and deletes postal code information.\
> \---\
> \## Detailed Description\
> \* When saving or modifying, Province Name, City/District Name, Administrative District Name, Land Lot Main No., Land Lot Sub No., and Road Name are required values.\
> \* When deleting, the Postal Code Sequence No. to delete is a required value.
```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":{"RealGridCUDRequestZipNoMgmtCudRequest":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/ZipNoMgmtCudRequest"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/ZipNoMgmtCudRequest"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/ZipNoMgmtCudRequest"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/ZipNoMgmtCudRequest"}}}},"ZipNoMgmtCudRequest":{"type":"object","description":"Postal Code Registration/Modification/Deletion Request DTO","properties":{"zipNoSeq":{"type":"integer","format":"int32","description":"Postal Code Sequence No."},"zipNo":{"type":"string","description":"Postal Code"},"ctpNm":{"type":"string","description":"Province/City Name"},"sigNm":{"type":"string","description":"City/County/District Name"},"hemdNm":{"type":"string","description":"Administrative District Name"},"lnbrMnnm":{"type":"string","description":"Lot Main Number"},"lnbrSlno":{"type":"string","description":"Lot Sub Number"},"roadNm":{"type":"string","description":"Road Name"},"buldMnnm":{"type":"string","description":"Building Primary Number"},"buldSlno":{"type":"string","description":"Building Secondary Number"},"bdMgtSn":{"type":"string","description":"Building Management No."},"posBulNm":{"type":"string","description":"District Building Name"}}},"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/system/zipNoMgmt/saveZipNoList":{"post":{"tags":["Postal Code Management"],"summary":"Save/Modify/Delete Postal Code","description":"## Function Description\n* Saves, modifies, and deletes postal code information.\n---\n## Detailed Description\n* When saving or modifying, Province Name, City/District Name, Administrative District Name, Land Lot Main No., Land Lot Sub No., and Road Name are required values.\n* When deleting, the Postal Code Sequence No. to delete is a required value.\n","operationId":"saveZipNoList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealGridCUDRequestZipNoMgmtCudRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve Postal Code List
> \## Function Description\
> \* Retrieves the postal code list matching the province name, city/district name, and search term passed from the screen.\
> \---\
> \## Detailed Description\
> \* Retrieves the postal code list matching the province name, city/district name, and search term passed from the screen.\
> \* Province Name (ctpNmParam), City/District Name (sigNmParam), and Search Term (param1) are all required values.
```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":{"ZipNoMgmtRequest":{"type":"object","properties":{"ctpNmParam":{"type":"string","minLength":1},"sigNmParam":{"type":"string","minLength":1},"param1":{"type":"string","minLength":1},"param2":{"type":"string"}},"required":["ctpNmParam","param1","sigNmParam"]},"RealGridListResponseZipNoMgmtResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/ZipNoMgmtResponse"}}}},"ZipNoMgmtResponse":{"type":"object","description":"Postal Code Management Retrieval Response","properties":{"zipNoSeq":{"type":"string","description":"Postal Code Sequence No."},"zipNo":{"type":"string","description":"Postal Code"},"ctpNm":{"type":"string","description":"Province/City Name"},"sigNm":{"type":"string","description":"City/County/District Name"},"hemdNm":{"type":"string","description":"Administrative District Name"},"lnbrMnnm":{"type":"string","description":"Lot Main Number"},"lnbrSlno":{"type":"string","description":"Lot Sub Number"},"roadNm":{"type":"string","description":"Road Name"}}},"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":{"/v2/system/zipNoMgmt/getZipNoList":{"get":{"tags":["Postal Code Management"],"summary":"Retrieve Postal Code List","description":"## Function Description\n* Retrieves the postal code list matching the province name, city/district name, and search term passed from the screen.\n---\n## Detailed Description\n* Retrieves the postal code list matching the province name, city/district name, and search term passed from the screen.\n* Province Name (ctpNmParam), City/District Name (sigNmParam), and Search Term (param1) are all required values.\n","operationId":"getZipNoList","parameters":[{"name":"req","in":"query","required":true,"schema":{"$ref":"#/components/schemas/ZipNoMgmtRequest"}},{"name":"ctpNmParam","in":"query","description":"Province/City Name","required":true,"schema":{"type":"string"}},{"name":"sigNmParam","in":"query","description":"City/County/District Name","required":true,"schema":{"type":"string"}},{"name":"param1","in":"query","description":"Search Term","required":true,"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/RealGridListResponseZipNoMgmtResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve Province/City Name List
> \## Function Description\
> \* Retrieves the list of province/city names.\
> \---\
> \## Detailed Description\
> \* Returns the province/city code and province/city name.
```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":{"EtSidoGugunInfoResponse":{"type":"object","description":"District Retrieval Response","properties":{"sidoCd":{"type":"string","description":"Province/City Code"},"sidoGugunCd":{"type":"string","description":"District Code"},"sidoNm":{"type":"string","description":"Province/City Name"},"sidoGugunNm":{"type":"string","description":"City/County/District Name"}}},"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/system/zipNoMgmt/getSidoList":{"get":{"tags":["Postal Code Management"],"summary":"Retrieve Province/City Name List","description":"## Function Description\n* Retrieves the list of province/city names.\n---\n## Detailed Description\n* Returns the province/city code and province/city name.\n","operationId":"getSidoList","responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EtSidoGugunInfoResponse"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve District Name List
> \## Function Description\
> \* Retrieves the district name list.\
> \---\
> \## Detailed Description\
> \* Returns the province/city code, province/city name, district code, and district name for the province/city name passed from the screen.\
> \* Province/city name is required.
```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":{"EtSidoGugunInfoResponse":{"type":"object","description":"District Retrieval Response","properties":{"sidoCd":{"type":"string","description":"Province/City Code"},"sidoGugunCd":{"type":"string","description":"District Code"},"sidoNm":{"type":"string","description":"Province/City Name"},"sidoGugunNm":{"type":"string","description":"City/County/District Name"}}},"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/system/zipNoMgmt/getGugunList":{"get":{"tags":["Postal Code Management"],"summary":"Retrieve District Name List","description":"## Function Description\n* Retrieves the district name list.\n---\n## Detailed Description\n* Returns the province/city code, province/city name, district code, and district name for the province/city name passed from the screen.\n* Province/city name is required.\n","operationId":"getGuginList","parameters":[{"name":"sidoNm","in":"query","description":"Province/City Name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EtSidoGugunInfoResponse"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```