> 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/display-bo-api/mall-information-management.md).

# Mall Information Management

## Register and Modify Mall Information Management

> \## Function Description\
> \* API for registering and modifying mall information.\
> \---\
> \## Detailed Description\
> \* Registers and modifies the corresponding site information via realGrid.\
> \* create : siteNo \*, dpmlNm \*, dispYn \*, linkUrlAddr \*, movFrmeCd \*, dispSeq \*\
> \* update : siteNo \*, dpmlNo, dpmlNm \*, dispYn \*, linkUrlAddr \*, movFrmeCd \*, dispSeq \*\
> \---\
> \### Code Reference\
> \* \`\`\` Display Status \`\`\` : Y,N<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":{"RealGridCUDRequestPrDpmlBase":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/PrDpmlBase"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/PrDpmlBase"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/PrDpmlBase"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/PrDpmlBase"}}}},"PrDpmlBase":{"type":"object","description":"Mall Basic","properties":{"siteNo":{"type":"string","description":"Site No."},"dpmlNo":{"type":"string","description":"Display Mall No."},"dpmlNm":{"type":"string","description":"Display Mall Name"},"dispYn":{"type":"string","description":"Display Status"},"linkUrlAddr":{"type":"string","description":"Linked URL"},"movFrmeCd":{"type":"string","description":"Navigation Frame Code (DP007)"},"dispSeq":{"type":"number","description":"Display Order"}}},"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"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/display/mallMgmt/saveMallBase":{"post":{"tags":["Mall Information Management"],"summary":"Register and Modify Mall Information Management","description":"## Function Description\n* API for registering and modifying mall information.\n---\n## Detailed Description\n* Registers and modifies the corresponding site information via realGrid.\n* create : siteNo *, dpmlNm *, dispYn *, linkUrlAddr *, movFrmeCd *, dispSeq *\n* update : siteNo *, dpmlNo, dpmlNm *, dispYn *, linkUrlAddr *, movFrmeCd *, dispSeq *\n---\n### Code Reference\n* ``` Display Status ``` : Y,N\n","operationId":"saveMallBase","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealGridCUDRequestPrDpmlBase"}}},"required":true},"responses":{"200":{"description":"Mall Information Register/Modify Successful","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"Mall Information Register/Modify Failed","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
````

## Retrieve Mall Name List

> \## Function Description\
> \* This API retrieves the list of mall names.\
> \---\
> \## Detailed Description\
> \* Retrieves the list of mall names.\
> \* The mall name list is displayed in ascending order of display order, then mall number.<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":{"PrDpmlBase":{"type":"object","description":"Mall Basic","properties":{"siteNo":{"type":"string","description":"Site No."},"dpmlNo":{"type":"string","description":"Display Mall No."},"dpmlNm":{"type":"string","description":"Display Mall Name"},"dispYn":{"type":"string","description":"Display Status"},"linkUrlAddr":{"type":"string","description":"Linked URL"},"movFrmeCd":{"type":"string","description":"Navigation Frame Code (DP007)"},"dispSeq":{"type":"number","description":"Display Order"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/display/mallMgmt/mallNmList":{"get":{"tags":["Mall Information Management"],"summary":"Retrieve Mall Name List","description":"## Function Description\n* This API retrieves the list of mall names.\n---\n## Detailed Description\n* Retrieves the list of mall names.\n* The mall name list is displayed in ascending order of display order, then mall number.\n","operationId":"getMallNmList","responses":{"200":{"description":"Mall name retrieved successfully","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PrDpmlBase"}}}},"900":{"description":"Failed to retrieve mall name","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
```

## Retrieve Mall Information List

> \## Function Description\
> \* This API retrieves the list of mall information.\
> \---\
> \## Detailed Description\
> \* If no site number is provided, retrieves the full list of malls.\
> \* The mall information list is displayed in ascending order of display order, then mall number.\
> \---\
> \## Revision History\
> \`\`\`Release v1.02\_231023\`\`\` : Sprint 2 PO1 defects/improvements<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":{"PrDpmlBase":{"type":"object","description":"Mall Basic","properties":{"siteNo":{"type":"string","description":"Site No."},"dpmlNo":{"type":"string","description":"Display Mall No."},"dpmlNm":{"type":"string","description":"Display Mall Name"},"dispYn":{"type":"string","description":"Display Status"},"linkUrlAddr":{"type":"string","description":"Linked URL"},"movFrmeCd":{"type":"string","description":"Navigation Frame Code (DP007)"},"dispSeq":{"type":"number","description":"Display Order"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/display/mallMgmt/getMallBaseList":{"get":{"tags":["Mall Information Management"],"summary":"Retrieve Mall Information List","description":"## Function Description\n* This API retrieves the list of mall information.\n---\n## Detailed Description\n* If no site number is provided, retrieves the full list of malls.\n* The mall information list is displayed in ascending order of display order, then mall number.\n---\n## Revision History\n```Release v1.02_231023``` : Sprint 2 PO1 defects/improvements\n","operationId":"getMallBaseList","parameters":[{"name":"siteNo","in":"query","description":"Site No.","schema":{"type":"string"}},{"name":"rowsPerPage","in":"query","description":"Rows per Page","required":true,"schema":{"type":"string"}},{"name":"pageIdx","in":"query","description":"Current Page","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Mall Information Retrieved Successfully","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PrDpmlBase"}}}},"900":{"description":"Mall Information Retrieval Failed","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
````