> 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/statistics-bo-api/seller-statistics.md).

# Seller Statistics

## Vendor Sales Grade Statistics List (Monthly)

> &#x20; \## Function Description\
> &#x20; \* Retrieves the sales grade by vendor on a monthly basis.\
> &#x20; \---\
> &#x20; \## Detailed Description\
> &#x20; \* Retrieves the sales grade by vendor on a monthly basis.\
> &#x20; \* The search is by year on an annual basis, and data can be retrieved up to 5 years prior to the current year.\
> &#x20; \* Vendor/MD ID can be added to the search conditions.\
> &#x20; \## Revision History\
> &#x20; \* Release v2.00\_240613: New development of monthly sales grade statistics by vendor<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":{"SalesGradeStatisticsRequest":{"type":"object","properties":{"period":{"type":"string","description":"Period (Year)"},"companyNo":{"type":"string","description":"Vendor No."},"companyName":{"type":"string","description":"Vendor Name"},"periodMonth":{"type":"string","description":"Period (Year-Month)"},"mdUserId":{"type":"string","description":"MD ID"},"partnerNoList":{"type":"array","description":"Vendor No. List","items":{"type":"string"}}}},"RealGridListResponseSalesGradeStatisticsResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/SalesGradeStatisticsResponse"}}}},"SalesGradeStatisticsResponse":{"type":"object","properties":{"companyNo":{"type":"string","description":"Vendor No."},"companyName":{"type":"string","description":"Vendor Name"},"items":{"type":"string","description":"Evaluation Item"},"period":{"type":"string","description":"Period"},"yearAverage":{"type":"string","description":"Annual Average"},"jan":{"type":"string","description":"January"},"feb":{"type":"string","description":"February"},"mar":{"type":"string","description":"March"},"apr":{"type":"string","description":"April"},"may":{"type":"string","description":"May"},"jun":{"type":"string","description":"June"},"jul":{"type":"string","description":"July"},"aug":{"type":"string","description":"August"},"sep":{"type":"string","description":"September"},"oct":{"type":"string","description":"October"},"nov":{"type":"string","description":"November"},"dec":{"type":"string","description":"December"},"gradeCd":{"type":"string","description":"Grade Code"},"janColor":{"type":"string","description":"January Color"},"febColor":{"type":"string","description":"February Color"},"marColor":{"type":"string","description":"March Color"},"aprColor":{"type":"string","description":"April Color"},"mayColor":{"type":"string","description":"May Color"},"junColor":{"type":"string","description":"June Color"},"julColor":{"type":"string","description":"July Color"},"augColor":{"type":"string","description":"August Color"},"sepColor":{"type":"string","description":"September Color"},"octColor":{"type":"string","description":"October Color"},"novColor":{"type":"string","description":"November Color"},"decColor":{"type":"string","description":"December Color"}}},"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/seller/searchSalesGradeStatisticsMonth":{"get":{"tags":["Seller Statistics"],"summary":"Vendor Sales Grade Statistics List (Monthly)","description":"  ## Function Description\n  * Retrieves the sales grade by vendor on a monthly basis.\n  ---\n  ## Detailed Description\n  * Retrieves the sales grade by vendor on a monthly basis.\n  * The search is by year on an annual basis, and data can be retrieved up to 5 years prior to the current year.\n  * Vendor/MD ID can be added to the search conditions.\n  ## Revision History\n  * Release v2.00_240613: New development of monthly sales grade statistics by vendor\n","operationId":"searchSalesGradeStatisticsMonth","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/SalesGradeStatisticsRequest"}},{"name":"periodMonth","in":"query","description":"Search Period","required":true,"schema":{"type":"String"}},{"name":"companyNo","in":"query","description":"Vendor No.","schema":{"type":"String"}},{"name":"mdUserId","in":"query","description":"Assigned MD","schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseSalesGradeStatisticsResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Sales Grade Daily Statistics Status (Grid)

> &#x20; \## Function Description\
> &#x20; \* Used to retrieve the detailed status of a specific month from the vendor sales grade statistics list (monthly).\
> &#x20; \---\
> &#x20; \## Detailed Description\
> &#x20; \* Breaks down the section previously shown only as an integrated score into 3 items for review: Shipping Compliance, Order Fulfillment, and Response Lead Time.\
> &#x20; \## Revision History\
> &#x20; \* Release v2.00\_240613: New development of monthly sales grade statistics status<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":{"SalesGradeStatisticsRequest":{"type":"object","properties":{"period":{"type":"string","description":"Period (Year)"},"companyNo":{"type":"string","description":"Vendor No."},"companyName":{"type":"string","description":"Vendor Name"},"periodMonth":{"type":"string","description":"Period (Year-Month)"},"mdUserId":{"type":"string","description":"MD ID"},"partnerNoList":{"type":"array","description":"Vendor No. List","items":{"type":"string"}}}},"RealGridListResponseSalesGradeStatisticsResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/SalesGradeStatisticsResponse"}}}},"SalesGradeStatisticsResponse":{"type":"object","properties":{"companyNo":{"type":"string","description":"Vendor No."},"companyName":{"type":"string","description":"Vendor Name"},"items":{"type":"string","description":"Evaluation Item"},"period":{"type":"string","description":"Period"},"yearAverage":{"type":"string","description":"Annual Average"},"jan":{"type":"string","description":"January"},"feb":{"type":"string","description":"February"},"mar":{"type":"string","description":"March"},"apr":{"type":"string","description":"April"},"may":{"type":"string","description":"May"},"jun":{"type":"string","description":"June"},"jul":{"type":"string","description":"July"},"aug":{"type":"string","description":"August"},"sep":{"type":"string","description":"September"},"oct":{"type":"string","description":"October"},"nov":{"type":"string","description":"November"},"dec":{"type":"string","description":"December"},"gradeCd":{"type":"string","description":"Grade Code"},"janColor":{"type":"string","description":"January Color"},"febColor":{"type":"string","description":"February Color"},"marColor":{"type":"string","description":"March Color"},"aprColor":{"type":"string","description":"April Color"},"mayColor":{"type":"string","description":"May Color"},"junColor":{"type":"string","description":"June Color"},"julColor":{"type":"string","description":"July Color"},"augColor":{"type":"string","description":"August Color"},"sepColor":{"type":"string","description":"September Color"},"octColor":{"type":"string","description":"October Color"},"novColor":{"type":"string","description":"November Color"},"decColor":{"type":"string","description":"December Color"}}},"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/seller/getSalesGradePartnerCompanyDetail":{"get":{"tags":["Seller Statistics"],"summary":"Sales Grade Daily Statistics Status (Grid)","description":"  ## Function Description\n  * Used to retrieve the detailed status of a specific month from the vendor sales grade statistics list (monthly).\n  ---\n  ## Detailed Description\n  * Breaks down the section previously shown only as an integrated score into 3 items for review: Shipping Compliance, Order Fulfillment, and Response Lead Time.\n  ## Revision History\n  * Release v2.00_240613: New development of monthly sales grade statistics status\n","operationId":"getSalesGradePartnerCompanyDetail","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/SalesGradeStatisticsRequest"}},{"name":"companyNo","in":"query","description":"Vendor No.","required":true,"schema":{"type":"String"}},{"name":"period","in":"query","description":"Search Period (Start Year-Month)","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseSalesGradeStatisticsResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Sales Grade Daily Statistics Status (Grid)

> &#x20; \## Function Description\
> &#x20; \* Displays the monthly data from the evaluation item statistics list broken down by date.\
> &#x20; \---\
> &#x20; \## Detailed Description\
> &#x20; \* Builds and displays accumulated data from the daily aggregation table.\
> &#x20; \## Revision History\
> &#x20; \* Release v2.00\_240613: New development of daily sales grade statistics<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":{"SalesGradeStatisticsRequest":{"type":"object","properties":{"period":{"type":"string","description":"Period (Year)"},"companyNo":{"type":"string","description":"Vendor No."},"companyName":{"type":"string","description":"Vendor Name"},"periodMonth":{"type":"string","description":"Period (Year-Month)"},"mdUserId":{"type":"string","description":"MD ID"},"partnerNoList":{"type":"array","description":"Vendor No. List","items":{"type":"string"}}}},"RealGridListResponseSalesGradeDetailStatisticsResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/SalesGradeDetailStatisticsResponse"}}}},"SalesGradeDetailStatisticsResponse":{"type":"object","properties":{"period":{"type":"string","description":"Period"},"gradeIntergratedScore":{"type":"string","description":"Integrated Score"},"gradeShipScore":{"type":"string","description":"Shipping Compliance"},"gradeOrdScore":{"type":"string","description":"Order Fulfillment"},"gradeAnswerScore":{"type":"string","description":"Response Lead Time"},"gradeShipScoreColor":{"type":"string","description":"Shipping Compliance Color"},"gradeOrdScoreColor":{"type":"string","description":"Order Fulfillment Color"},"gradeAnswerScoreColor":{"type":"string","description":"Response Lead Time Color"},"gradeIntergratedScoreColor":{"type":"string","description":"Integrated Score Color"}}},"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/seller/getSalesGradePartnerCompanyDetailOfDay":{"get":{"tags":["Seller Statistics"],"summary":"Sales Grade Daily Statistics Status (Grid)","description":"  ## Function Description\n  * Displays the monthly data from the evaluation item statistics list broken down by date.\n  ---\n  ## Detailed Description\n  * Builds and displays accumulated data from the daily aggregation table.\n  ## Revision History\n  * Release v2.00_240613: New development of daily sales grade statistics\n","operationId":"getSalesGradePartnerCompanyDetailOfDay","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/SalesGradeStatisticsRequest"}},{"name":"companyNo","in":"query","description":"Vendor No.","required":true,"schema":{"type":"String"}},{"name":"periodMonth","in":"query","description":"Search Period (Start Year-Month)","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseSalesGradeDetailStatisticsResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
