> 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/settlement-bo-api/delivery-fee-lookup.md).

# Delivery Fee Lookup

## Retrieve Delivery Fee List by Vendor

> \## Function Description\
> \* Retrieves the delivery fee list according to the vendor selected on the screen.\
> \---\
> \## Detailed Description\
> \* Retrieves the delivery fee list according to the vendor selected on the screen.\
> \---\
> \## Revision History\
> \* Release v1.05\_231204: Initial development of delivery fee inquiry\
> \* Release v2.00\_240613: Improved period search condition<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":{"AcDeliveryAmountRequest":{"type":"object","description":"Retrieve Delivery Fee Request","properties":{"salesStrDt":{"type":"string","format":"date","description":"Sales Start Date"},"salesEndDt":{"type":"string","format":"date","description":"Sales End Date"},"entrNo":{"type":"string","description":"Vendor No."},"ordNo":{"type":"string","description":"Order No."},"deliTypCd":{"type":"string","description":"Delivery Type (LO002)"},"deliProcTypCd":{"type":"string","description":"Delivery Processing Type (PR008)"},"ordCostGbCd":{"type":"string","description":"Cost Classification Code (OM043)"},"adtnOcurGbCd":{"type":"string","description":"Occurrence Classification Code (OM017)"}}},"RealGridListResponseAcDeliveryAmountDetailResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/AcDeliveryAmountDetailResponse"}}}},"AcDeliveryAmountDetailResponse":{"type":"object","description":"Retrieve Delivery Fee Response","properties":{"entrNo":{"type":"string","description":"Vendor No."},"entrNm":{"type":"string","description":"Vendor Name"},"adjStdDt":{"type":"string","description":"Sales Date"},"ordNo":{"type":"string","description":"Order No."},"claimNo":{"type":"string","description":"Claim No."},"deliTypNm":{"type":"string","description":"Delivery Type (LO002)"},"ordCostGbCd":{"type":"string","description":"Cost Classification Code (OM043)"},"ordCostGbNm":{"type":"string","description":"Cost Type Name"},"adtnOcurGbCd":{"type":"string","description":"Occurrence Classification Code (OM017)"},"adtnOcurGbNm":{"type":"string","description":"Occurrence Type Name"},"deliProcTypNm":{"type":"string","description":"Delivery Processing Type (PR008)"},"deliAmt":{"type":"integer","format":"int64","description":"Delivery Fee"},"entrFreeDlexAmt":{"type":"integer","format":"int64","description":"Vendor Burden Amount (Free Delivery Coupon)"},"ourFreeDlexAmt":{"type":"integer","format":"int64","description":"Company Burden Amount (Free Delivery Coupon)"},"entrFreeRtnDlexAmt":{"type":"integer","format":"int64","description":"Vendor Burden Amount (Free Return Coupon)"},"ourFreeRtnDlexAmt":{"type":"integer","format":"int64","description":"Company Burden Amount (Free Return Coupon)"},"sumCal":{"type":"integer","format":"int64","description":"Subtotal"},"siteNo":{"type":"string","description":"Site No."},"siteNm":{"type":"string","description":"Site 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/adjust/acDeliveryAmount/getAcDeliveryAmountDetailList":{"get":{"tags":["Delivery Fee Lookup"],"summary":"Retrieve Delivery Fee List by Vendor","description":"## Function Description\n* Retrieves the delivery fee list according to the vendor selected on the screen.\n---\n## Detailed Description\n* Retrieves the delivery fee list according to the vendor selected on the screen.\n---\n## Revision History\n* Release v1.05_231204: Initial development of delivery fee inquiry\n* Release v2.00_240613: Improved period search condition\n","operationId":"getAcDeliveryAmountDetailList","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/AcDeliveryAmountRequest"}},{"name":"salesStrDt","in":"query","description":"Sales Start Date","schema":{"type":"string"}},{"name":"salesEndDt","in":"query","description":"Sales End Date","schema":{"type":"string"}},{"name":"entrNo","in":"query","description":"Vendor No.","schema":{"type":"string"}},{"name":"ordNo","in":"query","description":"Order No.","schema":{"type":"string"}},{"name":"deliTypCd","in":"query","description":"Delivery Type (LO002)","schema":{"type":"string"}},{"name":"deliProcTypCd","in":"query","description":"Delivery Processing Type (PR008)","schema":{"type":"string"}},{"name":"ordCostGbCd","in":"query","description":"Cost Classification Code (OM043)","schema":{"type":"string"}},{"name":"adtnOcurGbCd","in":"query","description":"Occurrence Classification Code (OM017)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseAcDeliveryAmountDetailResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Delivery Fee Summary List by Vendor

> \## Function Description\
> \* Retrieves the delivery fee summary list by vendor according to the conditions selected on the screen.\
> \---\
> \## Detailed Description\
> \* Retrieves the delivery fee summary list by vendor according to the conditions selected on the screen.\
> \* When entering via PO, validates the vendor number passed in the Request against the user's vendor number to restrict inquiries for other vendors.\
> \---\
> \## Revision History\
> \* Release v1.05\_231204: Initial development of delivery fee inquiry\
> \* Release v2.00\_240613: Improved period search condition<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":{"AcDeliveryAmountSummaryRequest":{"type":"object","properties":{"salesStrDt":{"type":"string","format":"date","description":"Sales Start Date"},"salesEndDt":{"type":"string","format":"date","description":"Sales End Date"},"entrNo":{"type":"string","description":"Vendor No."},"ordNo":{"type":"string","description":"Order No."},"deliTypCd":{"type":"string","description":"Delivery Type (LO002)"},"deliProcTypCd":{"type":"string","description":"Delivery Processing Type (PR008)"},"ordCostGbCd":{"type":"string","description":"Cost Classification Code (OM043)"},"adtnOcurGbCd":{"type":"string","description":"Occurrence Classification Code (OM017)"},"userGbCd":{"type":"string","description":"User Type Code (UR001)"},"userEntrNo":{"type":"string","description":"User's Vendor No."}}},"AcDeliveryAmountSummaryResponse":{"type":"object","description":"Retrieve Delivery Fee Summary Response","properties":{"adjStdDt":{"type":"string","description":"Sales Date"},"entrNo":{"type":"string","description":"Vendor No."},"entrNm":{"type":"string","description":"Vendor Name"},"deliCnt":{"type":"integer","format":"int32","description":"Count"},"deliAmt":{"type":"integer","format":"int64","description":"Delivery Fee"},"freeDlexAmt":{"type":"integer","format":"int64","description":"Free Delivery Fee"},"freeRtnDlexAmt":{"type":"integer","format":"int64","description":"Free Return Fee"},"sumCal":{"type":"integer","format":"int64","description":"Total"},"siteNm":{"type":"string","description":"Site 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/adjust/acDeliveryAmount/getAcDeliveryAmountSummaryList":{"get":{"tags":["Delivery Fee Lookup"],"summary":"Retrieve Delivery Fee Summary List by Vendor","description":"## Function Description\n* Retrieves the delivery fee summary list by vendor according to the conditions selected on the screen.\n---\n## Detailed Description\n* Retrieves the delivery fee summary list by vendor according to the conditions selected on the screen.\n* When entering via PO, validates the vendor number passed in the Request against the user's vendor number to restrict inquiries for other vendors.\n---\n## Revision History\n* Release v1.05_231204: Initial development of delivery fee inquiry\n* Release v2.00_240613: Improved period search condition\n","operationId":"getAcDeliveryAmountSummaryList","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/AcDeliveryAmountSummaryRequest"}},{"name":"salesStrDt","in":"query","description":"Sales Start Date","schema":{"type":"string"}},{"name":"salesEndDt","in":"query","description":"Sales End Date","schema":{"type":"string"}},{"name":"entrNo","in":"query","description":"Vendor No.","schema":{"type":"string"}},{"name":"ordNo","in":"query","description":"Order No.","schema":{"type":"string"}},{"name":"deliTypCd","in":"query","description":"Delivery Type (LO002)","schema":{"type":"string"}},{"name":"deliProcTypCd","in":"query","description":"Delivery Processing Type (PR008)","schema":{"type":"string"}},{"name":"ordCostGbCd","in":"query","description":"Cost Classification Code (OM043)","schema":{"type":"string"}},{"name":"adtnOcurGbCd","in":"query","description":"Occurrence Classification Code (OM017)","schema":{"type":"string"}},{"name":"userGbCd","in":"query","description":"User Type Code (UR001)","schema":{"type":"string"}},{"name":"userEntrNo","in":"query","description":"User's Vendor No.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AcDeliveryAmountSummaryResponse"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Download Delivery Fee List by Vendor as Excel

> \## Function Description\
> \* Downloads the delivery fee list by vendor selected on the screen as an Excel file.\
> \---\
> \## Detailed Description\
> \* Downloads the delivery fee list by vendor selected on the screen as an Excel file with unpaged data.\
> \---\
> \## Revision History\
> \* Release v1.05\_231204: Initial development of delivery fee inquiry\
> \* Release v2.00\_240613: Improved period search condition<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":{"AcDeliveryAmountRequest":{"type":"object","description":"Retrieve Delivery Fee Request","properties":{"salesStrDt":{"type":"string","format":"date","description":"Sales Start Date"},"salesEndDt":{"type":"string","format":"date","description":"Sales End Date"},"entrNo":{"type":"string","description":"Vendor No."},"ordNo":{"type":"string","description":"Order No."},"deliTypCd":{"type":"string","description":"Delivery Type (LO002)"},"deliProcTypCd":{"type":"string","description":"Delivery Processing Type (PR008)"},"ordCostGbCd":{"type":"string","description":"Cost Classification Code (OM043)"},"adtnOcurGbCd":{"type":"string","description":"Occurrence Classification Code (OM017)"}}},"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/adjust/acDeliveryAmount/downloadAcDeliveryAmountExcel":{"get":{"tags":["Delivery Fee Lookup"],"summary":"Download Delivery Fee List by Vendor as Excel","description":"## Function Description\n* Downloads the delivery fee list by vendor selected on the screen as an Excel file.\n---\n## Detailed Description\n* Downloads the delivery fee list by vendor selected on the screen as an Excel file with unpaged data.\n---\n## Revision History\n* Release v1.05_231204: Initial development of delivery fee inquiry\n* Release v2.00_240613: Improved period search condition\n","operationId":"downloadAcDeliveryAmountExcel","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/AcDeliveryAmountRequest"}},{"name":"salesStrDt","in":"query","description":"Sales Start Date","schema":{"type":"string"}},{"name":"salesEndDt","in":"query","description":"Sales End Date","schema":{"type":"string"}},{"name":"entrNo","in":"query","description":"Vendor No.","schema":{"type":"string"}},{"name":"ordNo","in":"query","description":"Order No.","schema":{"type":"string"}},{"name":"deliTypCd","in":"query","description":"Delivery Type (LO002)","schema":{"type":"string"}},{"name":"deliProcTypCd","in":"query","description":"Delivery Processing Type (PR008)","schema":{"type":"string"}},{"name":"ordCostGbCd","in":"query","description":"Cost Classification Code (OM043)","schema":{"type":"string"}},{"name":"adtnOcurGbCd","in":"query","description":"Occurrence Classification Code (OM017)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
