> 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/sales-order-status-by-coupon.md).

# Sales/Order Status By Coupon

## Retrieve Order/Sales Status List by Coupon

> \## Function Description\
> \* This function retrieves the order/sales status list by coupon.\
> \---\
> \## Detailed Description\
> \* Called when the search button is clicked on the \[BO] Statistics > Marketing Analysis > Order/Sales Status by Coupon page.\
> \* \*\*Aggregation Type Code, Search Period (Start Date, End Date)\*\* are required search conditions.\
> \* - Aggregation Type Code 01: Order, 02: Sales\
> \* \*\*Site No., Coupon No., Vendor No.\*\* are optional search conditions.\
> \---<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":{"CouponStatusRequest":{"type":"object","description":"Sales/Order Status by Brand DTO","properties":{"startDate":{"type":"string","format":"date","description":"Search Period (Start Date)"},"endDate":{"type":"string","format":"date","description":"Search Period (End Date)"},"cpnNo":{"type":"string","description":"Coupon No."},"entrNo":{"type":"string","description":"Vendor No."},"agrtGb":{"type":"string","description":"Aggregation Type"}}},"RealGridListResponseCouponStatusResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/CouponStatusResponse"}}}},"CouponStatusResponse":{"type":"object","description":"Order/Sales Status by Coupon DTO","properties":{"cpnNo":{"type":"string","description":"Coupon No."},"cpnNm":{"type":"string","description":"Coupon Name"},"agrtGb":{"type":"string","description":"Aggregation Type"},"issuCnt":{"type":"string","description":"Issuance Count"},"useCnt":{"type":"string","description":"Applied Count"},"purchaseRate":{"type":"number","format":"float","description":"Purchase Conversion Rate"},"entrNm":{"type":"string","description":"Vendor Name"},"siteNm":{"type":"string","description":"Site"},"ordAmt":{"type":"number","description":"Order Amount"},"cnclAmt":{"type":"number","description":"Cancellation Amount"},"netOrdAmt":{"type":"integer","format":"int64","description":"Net Order Amount"},"ordQty":{"type":"integer","format":"int32","description":"Order Quantity"},"cnclQty":{"type":"integer","format":"int32","description":"Cancellation Quantity"},"netOrdQty":{"type":"integer","format":"int32","description":"Net Order Quantity"}}},"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/statistics/couponStatus/getCouponStatusList":{"get":{"tags":["Sales/Order Status by Coupon"],"summary":"Retrieve Order/Sales Status List by Coupon","description":"## Function Description\n* This function retrieves the order/sales status list by coupon.\n---\n## Detailed Description\n* Called when the search button is clicked on the [BO] Statistics > Marketing Analysis > Order/Sales Status by Coupon page.\n* **Aggregation Type Code, Search Period (Start Date, End Date)** are required search conditions.\n* - Aggregation Type Code 01: Order, 02: Sales\n* **Site No., Coupon No., Vendor No.** are optional search conditions.\n---\n","operationId":"getCouponStatusList","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/CouponStatusRequest"}},{"name":"startDate","in":"query","description":"Search Start Date","required":true,"schema":{"type":"LocalDate"}},{"name":"endDate","in":"query","description":"Search End Date","required":true,"schema":{"type":"LocalDate"}},{"name":"siteNo","in":"query","description":"Site No.","schema":{"type":"String"}},{"name":"cpnNo","in":"query","description":"Coupon No.","schema":{"type":"String"}},{"name":"entrNo","in":"query","description":"Vendor No.","schema":{"type":"String"}},{"name":"agrtGb","in":"query","description":"Aggregation Type","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Successfully retrieved sales/order status list by brand","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseCouponStatusResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Batch Excel Download of Order/Sales Status by Coupon

> \## Function Description\
> \* Generates and downloads the order/sales status list by coupon as an Excel file.\
> \---\
> \## Detailed Description\
> \* The displayed items are the same as the grid list.\
> \* Retrieves all data matching the search conditions without paging.\
> \---\
> \## Revision History\
> \* Release v2.00\_240827 : Initial creation<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":{"CouponStatusRequest":{"type":"object","description":"Sales/Order Status by Brand DTO","properties":{"startDate":{"type":"string","format":"date","description":"Search Period (Start Date)"},"endDate":{"type":"string","format":"date","description":"Search Period (End Date)"},"cpnNo":{"type":"string","description":"Coupon No."},"entrNo":{"type":"string","description":"Vendor No."},"agrtGb":{"type":"string","description":"Aggregation Type"}}},"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/statistics/couponStatus/downloadCouponStatusExcel":{"get":{"tags":["Sales/Order Status by Coupon"],"summary":"Batch Excel Download of Order/Sales Status by Coupon","description":"## Function Description\n* Generates and downloads the order/sales status list by coupon as an Excel file.\n---\n## Detailed Description\n* The displayed items are the same as the grid list.\n* Retrieves all data matching the search conditions without paging.\n---\n## Revision History\n* Release v2.00_240827 : Initial creation\n","operationId":"downloadCouponStatusExcel","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/CouponStatusRequest"}},{"name":"startDate","in":"query","description":"Search Start Date","required":true,"schema":{"type":"LocalDate"}},{"name":"endDate","in":"query","description":"Search End Date","required":true,"schema":{"type":"LocalDate"}},{"name":"siteNo","in":"query","description":"Site No.","schema":{"type":"String"}},{"name":"cpnNo","in":"query","description":"Coupon No.","schema":{"type":"String"}},{"name":"entrNo","in":"query","description":"Vendor No.","schema":{"type":"String"}},{"name":"agrtGb","in":"query","description":"Aggregation Type","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Excel Download Successful"},"900":{"description":"Excel Download Failed","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```