> 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/popup-bo-api/vendor-common-popup.md).

# Vendor Common Popup

## Retrieve Vendor List

> \## Function Description\
> \* This is the API for retrieving the vendor list.\
> \---\
> \## Detailed Description\
> \* Retrieves the vendor information list.\
> &#x20;   \* Sorted by vendor number descending.<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":[]}],"paths":{"/v1/popup/enteranceMgmt/getEtEntrBaseList":{"get":{"tags":["Vendor Common Popup"],"summary":"Retrieve Vendor List","description":"## Function Description\n* This is the API for retrieving the vendor list.\n---\n## Detailed Description\n* Retrieves the vendor information list.\n    * Sorted by vendor number descending.\n","operationId":"getEtEntrBaseList","parameters":[{"name":"entrGbCd","in":"query","description":"Vendor Type Code (VD001)","required":true,"schema":{"type":"string"}},{"name":"trdStatCd","in":"query","description":"Transaction Status Code (VD003)","required":true,"schema":{"type":"string"}},{"name":"entrNo","in":"query","description":"Vendor No.","required":true,"schema":{"type":"string"}},{"name":"entrNm","in":"query","description":"Vendor Name","required":true,"schema":{"type":"string"}},{"name":"trdTypCd","in":"query","description":"Transaction Type Code (VD002)","schema":{"type":"string"}}],"responses":{"200":{"description":"Retrieve Vendor List Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseRealGridListResponseEnEntrBaseResponse"}}}},"900":{"description":"Retrieve Vendor List Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}},"components":{"schemas":{"ResponseRealGridListResponseEnEntrBaseResponse":{"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/RealGridListResponseEnEntrBaseResponse","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"RealGridListResponseEnEntrBaseResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/EnEntrBaseResponse"}}}},"EnEntrBaseResponse":{"type":"object","description":"Vendor Basic Information Response","properties":{"entrNo":{"type":"string","description":"Vendor No."},"entrNm":{"type":"string","description":"Vendor Name"},"entrGbCd":{"type":"string","description":"Vendor Classification Code (VD001) 10: Product Supplier, 20: Affiliate Partner"},"latt":{"type":"number","format":"double","description":"Latitude"},"lngt":{"type":"number","format":"double","description":"Longitude"},"trdTypCd":{"type":"string","description":"Transaction Type Code (VD002) 10: Direct Purchase, 20: Consignment Sale, 30: Affiliate"},"buyTypCdNm":{"type":"string","description":"Purchase Type Code Name"},"trdStatCd":{"type":"string","description":"Transaction Status Code (VD003) 10: Pending Transaction, 20: In Transaction, 30: Transaction Ended"},"lgcEntrNo":{"type":"string","description":"Core System Vendor No."},"rpstmnNm":{"type":"string","description":"Representative Name"},"bmanNo":{"type":"string","description":"Business Registration No."},"bmanKindNm":{"type":"string","description":"Business Type Code Name"},"corpnNo":{"type":"string","description":"Corporate Registration No."},"btyp":{"type":"string","description":"Business Type"},"bkind":{"type":"string","description":"Business Category"},"contStrtDy":{"type":"string","format":"date","description":"Contract Start Date"},"contEndDy":{"type":"string","format":"date","description":"Contract End Date"},"aempNm":{"type":"string","description":"Person in Charge Name"},"aempTelRgnNo":{"type":"string","description":"Contact Person's Phone Area Code"},"aempTelTxnoNo":{"type":"string","description":"Contact Person's Phone Exchange Code"},"aempTelEndNo":{"type":"string","description":"Contact Person's Phone Last Digits"},"aempCellSctNo":{"type":"string","description":"Contact Person's Mobile Phone Prefix Code"},"aempCellTxnoNo":{"type":"string","description":"Contact Person's Mobile Phone Exchange Code"},"aempCellEndNo":{"type":"string","description":"Contact Person's Mobile Phone Last Digits"},"faxRgnNo":{"type":"string","description":"Fax Area Code"},"faxTxnoNo":{"type":"string","description":"Fax Exchange Code"},"faxEndNo":{"type":"string","description":"Fax Last Digits"},"bmanKindCd":{"type":"string","description":"Business Type Code (VD004) 10: Tax-Exempt Business, 20: General Taxable Business"},"zipNoSeq":{"type":"integer","format":"int64","description":"Postal Code Sequence No."},"zipNo":{"type":"string","description":"Postal Code"},"zipAddr":{"type":"string","description":"Postal Address"},"dtlAddr":{"type":"string","description":"Detailed Address"},"rmkCont":{"type":"string","description":"Remarks"},"mrgnRateGbCd":{"type":"string","description":"Margin Rate Classification Code (VD008) 10: Fixed Margin, 20: Tiered Margin"},"mrgnRate1":{"type":"number","description":"Margin Rate 1"},"mrgnRate2":{"type":"number","description":"Margin Rate 2"},"singleMrgnRate":{"type":"number","description":"Single Margin Rate"},"intervalMrgnRate1":{"type":"number","description":"Tiered Margin Rate 1"},"intervalMrgnRate2":{"type":"number","description":"Tiered Margin Rate 2"},"ecpnUseYn":{"type":"string","description":"E-Coupon Usage Status"},"ecpnLinkGbCd":{"type":"string","description":"E-Coupon Integration Type Code"},"ecpnLinkGbNm":{"type":"string","description":"E-Coupon Integration Type Name"},"entrGbNm":{"type":"string","description":"Vendor Type Name"},"trdStatNm":{"type":"string","description":"Transaction Status Name"},"itmSaleStatCd":{"type":"string","description":"Item Sales Status","enum":["TEMPORARY_STORAGE","WAITING_FOR_APPROVAL","COMPANION","SALES","SOLD_OUT","SALE_END"]},"saleStatChgCausCd":{"type":"string","description":"Sales Status Change Reason Code","enum":["SALES","SOLD_OUT","SUSPEND","SALE_END","PARTNER_SALE_END"]},"rtGrpNo":{"type":"string","description":"Authorization Group No."},"endPage":{"type":"boolean","description":"Last Page Status"},"totalCount":{"type":"integer","format":"int32","description":"Total Count"},"endPartnerSaleAndAuthGroup":{"type":"string","writeOnly":true}}},"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"}}}}}}
```