Order Claim Dashboard

Retrieve Purchase Conversion Rate by Customer Journey (Dashboard)

post

Function Description

Retrieves purchase conversion rate information by customer journey for the BO(MD) dashboard.

Detailed Description

Provides order sales status information based on the current day / last 7 days / last 30 days.
If the site parameter is not set to "All", only information for the corresponding site is provided.
The purchase conversion rate is the ratio of completed orders to visits.

Revision History

Release v2.00_240827: Created purchase conversion rate by customer journey for dashboard

Header parameters

AuthorizationanyOptional

Access Token

Body

Search Dashboard Customer Journey Purchase Conversion Rate Section Request DTO

statusPeriodstringRequired

Search Period Type

Example: 0

siteNostringOptional

Site No.

Example: 1

Responses

200

Success

*/*

Search Dashboard Customer Journey Purchase Conversion Rate Section Response DTO

mainnumber · doubleRequired

Purchase Conversion Rate of Main Page Visits

Example: 30

mainRatenumber · doubleRequired

Increase Rate of Purchase Conversion Rate of Main Page Visits

Example: 30

goodsDetailnumber · doubleRequired

Purchase Conversion Rate of Product Detail Page Visits

Example: 30

goodsDetailRatenumber · doubleRequired

Increase Rate of Purchase Conversion Rate of Product Detail Page Visits

Example: 30

basketnumber · doubleRequired

Purchase Conversion Rate of Cart Page Visits

Example: 30

basketRatenumber · doubleRequired

Increase Rate of Purchase Conversion Rate of Cart Page Visits

Example: 30

orderSheetnumber · doubleRequired

Purchase Conversion Rate of Order Page Visits

Example: 30

orderSheetRatenumber · doubleRequired

Increase Rate of Purchase Conversion Rate of Order Page Visits

Example: 30

900

Business processing error details

*/*

post/v1/dashboard/getVisitToOrderDashBoard

POST /api/order/v1/dashboard/getVisitToOrderDashBoard HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "statusPeriod": "0",
  "siteNo": "1"
}

{
  "main": 30,
  "mainRate": 30,
  "goodsDetail": 30,
  "goodsDetailRate": 30,
  "basket": 30,
  "basketRate": 30,
  "orderSheet": 30,
  "orderSheetRate": 30,
  "recentWeeklyList": [
    {
      "agrtDt": "20230816",
      "visitMain": 100,
      "visitGoodsDetail": 100,
      "visitBasket": 100,
      "visitOrderSheet": 100
    }
  ]
}

Retrieve Dashboard Overview

post

Function Description

Looks up the BO dashboard overview information.

Detailed Description

Provides order/sales status information for today / the last 7 days / the last 30 days.
If the site parameter is not "all", provides information only for the corresponding site.
Number of purchasing customers is the number of users who placed orders. (Returns and cancellations are not counted.)
Number of visits is the number of visitors to FO.
Purchase conversion rate is the ratio of order completions to visits.
Sign-up conversion rate is the ratio of sign-ups to visits.
Average order is the average amount of all customer orders during the lookup period.

Revision History

Release v2.00_240827: Created dashboard overview

Header parameters

AuthorizationanyOptional

Access Token

Body

Search Dashboard Overview Section Request DTO

statusPeriodstringRequired

Search Period Type

Example: 0

siteNostringOptional

Site No.

Example: 1

Responses

200

Success

*/*

Dashboard Overview Section Retrieval Response DTO

ordManCntinteger · int32Required

Number of Purchasing Customers

Example: 100

ordManCntRatenumber · doubleRequired

Increase Rate of Purchasing Customers vs. Previous Day

Example: 10

visitManCntinteger · int32Required

Number of Visits

Example: 100

visitManCntRatenumber · doubleRequired

Increase Rate of Visits vs. Previous Day

Example: 10

visitToOrdernumber · doubleRequired

Purchase Conversion Rate per Visit

Example: 30

visitToOrderRatenumber · doubleRequired

Increase Rate of Purchase Conversion Rate per Visit vs. Previous Day

Example: 10

visitToJoinnumber · doubleRequired

Registration Conversion Rate per Visit

Example: 30

visitToJoinRatenumber · doubleRequired

Increase Rate of Registration Conversion Rate vs. Previous Day

Example: 10

orderAveragenumber · doubleRequired

Average Order Amount

Example: 15000

orderAverageRatenumber · doubleRequired

Increase Rate of Average Order Amount vs. Previous Day

Example: 10

900

Business processing error details

*/*

post/v1/dashboard/getOverviewDashBoard

POST /api/order/v1/dashboard/getOverviewDashBoard HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "statusPeriod": "0",
  "siteNo": "1"
}

{
  "ordManCnt": 100,
  "ordManCntRate": 10,
  "visitManCnt": 100,
  "visitManCntRate": 10,
  "visitToOrder": 30,
  "visitToOrderRate": 10,
  "visitToJoin": 30,
  "visitToJoinRate": 10,
  "orderAverage": 15000,
  "orderAverageRate": 10
}

Order Sales Status

post

Function Description

Looks up order/sales status information.

Detailed Description

Aggregation type code (agrtGb) is a required parameter.
If the requested aggregation type code is '01', provides order status information.
If the requested aggregation type code is '02', provides sales status information.
Provides order/sales status information for today / the last 7 days / the last 30 days.
If the site parameter is not "all", provides information only for the corresponding site.
When entering via PO, provides information only for the corresponding vendor.

Revision History

Release v2.00_240711: Fixed so that the number-of-orders count is no longer multiplied into the base order/cancellation amount displayed
Release v2.00_240827: Modified due to full dashboard renewal

Code Reference

Aggregation type code (agrtGb) : 01: Order status aggregation code, 02: Sales status aggregation code

Header parameters

AuthorizationanyOptional

Access Token

Body

Search Order/Sales Status Request DTO

agrtGbstringRequired

Aggregation Type

Example: 01

statusPeriodstringRequired

Search Period Type

Example: 0

entrNostringOptional

Vendor No.

Example: 1000002

siteNostringOptional

Site No.

Example: 1

Responses

200

Success

*/*

Search Order/Sales Status Response DTO

ordSaleAmtinteger · int64Required

Today's Order/Sales Amount

Example: 100

ordSaleAmtRatenumber · doubleRequired

Increase Rate of Order/Sales vs. Previous Day

Example: 10

ordSaleCntinteger · int64Required

Today's Order/Sales Count

Example: 100

ordSaleCntRatenumber · doubleRequired

Increase Rate of Order/Sales Count vs. Previous Day

Example: 10

cnclRtnAmtinteger · int64Required

Today's Cancellation/Return Amount

Example: 100

cnclRtnAmtRatenumber · doubleRequired

Increase Rate of Cancellation/Return Amount vs. Previous Day

Example: 10

cnclRtnCntinteger · int64Required

Cancellation/Return Count vs. Previous Day

Example: 100

cnclRtnCntRatenumber · doubleRequired

Increase Rate of Cancellation/Return Count vs. Previous Day

Example: 10

900

Business processing error details

*/*

post/v1/dashboard/getOrderSalesDashBoard

POST /api/order/v1/dashboard/getOrderSalesDashBoard HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "agrtGb": "01",
  "statusPeriod": "0",
  "entrNo": "1000002",
  "siteNo": "1"
}

{
  "ordSaleAmt": 100,
  "ordSaleAmtRate": 10,
  "ordSaleCnt": 100,
  "ordSaleCntRate": 10,
  "cnclRtnAmt": 100,
  "cnclRtnAmtRate": 10,
  "cnclRtnCnt": 100,
  "cnclRtnCntRate": 10,
  "recentWeeklyList": [
    {
      "agrtDt": "20230816",
      "ordSaleAmt": 100,
      "cnclRtnAmt": 100
    }
  ]
}

Order/Claim Status

post

Function Description

Provides order status/claim status information in PO.

Detailed Description

Order/claim classification (ordCntGb) and vendor name (entrNo) are required parameters.
If order/claim classification (ordCntGb) is order (O), displays the count for the following order history status codes (OM005).
- Order Completed (12), Delivery Instructed (21), Shipment Instructed (22), Awaiting Shipment (23), Shipment Completed (26)
If order/claim classification (ordCntGb) is claim (C), displays the count for the following order history status codes (OM005).
- Claim Received (32), Collection Instructed (34), Collection Confirmed (35)

Notes

Looks up the corresponding status information only when order/claim classification (ordCntGb) is order (O) or claim (C).

Revision History

Release v2.00_240827 : Added condition based on order received datetime within the most recent 30 days

Header parameters

AuthorizationanyOptional

Access Token

Body

Order Status/Claim Status Request DTO

ordCntGbstringRequired

Order/Claim Type O: Order, C: Claim

Default: OExample: O

entrNostringOptional

Vendor No.

Example: 1000002

Responses

200

Success

*/*

Order Status/Claim Status Response DTO

ordDtlStatNmstringOptional

Order Claim Status Name

Example: 주문완료

ordDtlStatCdstring · enumOptional

OM005 (Order Detail Status Code) 10: REPAY_REQ(Repayment Requested) ,11: ORDER_ACCEPT(Order Accepted) ,12: ORDER_COMPLETE(Order Completed) ,13: ORDER_CANCEL(Order Cancelled) ,21: DELIVERY_ORDER(Delivery Instructed) ,22: SHIPPING_ORDER(Shipment Instructed) ,23: SHIPPING_WAIT(Awaiting Shipment) ,25: SHIPPING_CONFIRM(Shipment Confirmed) ,26: SHIPPING_FINISH(Shipment Completed) ,27: DELIVERY_FINISH(Delivery Completed) ,31: RETURN_APPLY(Payment Pending) ,32: RETURN_ACCEPT(Return Accepted) ,33: RETURN_CANCEL(Return Cancelled) ,34: WITHDRAWAL_ORDER(Collection Instructed) ,35: WITHDRAWAL_CONFIRM(Collection Confirmed) ,36: WITHDRAWAL_FINISH(Collection Completed) ,37: RETURN_FINISH(Return Completed)

Example: 10Possible values:

cntinteger · int32Optional

Quantity by Order Claim Status

Example: 0

900

Business processing error details

*/*

post/v1/dashboard/getDashBoardOrderClaimCount

POST /api/order/v1/dashboard/getDashBoardOrderClaimCount HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "ordCntGb": "O",
  "entrNo": "1000002"
}

[
  {
    "ordDtlStatNm": "주문완료",
    "ordDtlStatCd": "10",
    "cnt": 0
  }
]

PreviousDelivery

NextSeparate Storage

Last updated 1 month ago