대시보드 주문, 매출, 클레임

주문/클레임현황

get

기능 설명

• PO에서 주문현황/클레임현황 정보를 제공합니다.

---

상세 설명

• 주문/클레임구분(ordCntGb), **협력사명(entrNo)**은 필수 파라미터 입니다.

• **주문/클레임구분(ordCntGb)**이 주문(O) 일경우 다음의 **주문내역상태코드(OM005)**의 건 수를 노출한다.

  • 주문완료(12), 배송지시(21), 출고지시(22), 출고대기(23), 출고완료(26)

• **주문/클레임구분(ordCntGb)**이 클레임(C) 일경우 다음의 **주문내역상태코드(OM005)**의 건 수를 노출한다.

  • 클레임접수(32), 회수지시(34), 회수확인(35)

---

특이 사항

• **주문/클레임구분(ordCntGb)**이 **주문(O)**이거나 **클레임(C)**일 경우에만 해당 현황정보를 조회합니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

Responses

200

성공

*/*

주문현황/클레임현황 응답 DTO

ordDtlStatNmstringOptional

주문클레임상태명

ordDtlStatCdstringOptional

주문클레임상태코드

cntinteger · int32Optional

주문클레임상태별 수량

900

업무처리 오류 내용

*/*

get

/v2/dashboard/order/payment-return-status

HTTPcURLJavaScriptPython

GET /api/bo/v2/dashboard/order/payment-return-status?orderClaimDashBoardRequest=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "ordDtlStatNm": "text",
    "ordDtlStatCd": "text",
    "cnt": 1
  }
]

대시보드 overview 조회

get

기능설명

• BO 대시보드의 overview 정보를 조회합니다.

---

상세설명

• 당일 기준 / 최근 7일 / 최근 30일 간 주문 매출 현황 정보를 제공합니다.

• 사이트 파라미터가 전체가 아닌 경우 해당 사이트에 해당하는 정보만 제공합니다.

• 구매고객수는 주문한 사용자의 수 입니다.(반품,취소는 카운트하지 않습니다.)

• 방문수는 FO에 방문한 수 입니다.

• 구매전환율은 방문수 대비 주문완료 비율입니다.

• 가입전환율은 FO에 방문한 방문객 대비 회원가입 비율입니다.

• 주문평균은 조회기간 동안 발생한 모든 고객 주문의 평균 금액입니다.

---

수정번호

• Release v2.00_240827: 대시보드 overview 생성

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

Responses

200

성공

*/*

대시보드 overview영역 조회 응답 DTO

ordManCntinteger · int32Required

구매구객수

Example: 100

ordManCntRatenumber · doubleRequired

전일대비 구매구객수 증가율

Example: 10

visitManCntinteger · int32Required

방문수

Example: 100

visitManCntRatenumber · doubleRequired

전일대비 방문수 증가율

Example: 10

visitToOrdernumber · doubleRequired

방문대비 구매전환율

Example: 30

visitToOrderRatenumber · doubleRequired

전일대비 방문대비 구매전환율 증가율

Example: 10

visitToJoinnumber · doubleRequired

방문대비 가입전환율

Example: 30

visitToJoinRatenumber · doubleRequired

전일대비 가입전환율 증가율

Example: 10

orderAveragenumber · doubleRequired

주문금액평균

Example: 15000

orderAverageRatenumber · doubleRequired

전일대비 주문금액평균 증가율

Example: 10

900

업무처리 오류 내용

*/*

get

/v2/dashboard/order/overview

HTTPcURLJavaScriptPython

GET /api/bo/v2/dashboard/order/overview?overviewDashBoardRequest=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

주문매출현황

get

기능설명

• 주문매출현황 정보를 조회합니다.

---

상세설명

• **집계구분코드(agrtGb)**는 필수 파라미터 입니다.

• 요청 집계구분코드가 '01'일 경우, 주문 현황 정보를 제공합니다.

• 요청 집계구분코드가 '02'일 경우, 매출 현황 정보를 제공합니다.

• 당일 기준 / 최근 7일 / 최근 30일 간 주문 매출 현황 정보를 제공합니다.

• 사이트 파라미터가 전체가 아닌 경우 해당 사이트에 해당하는 정보만 제공합니다.

• PO 진입 시 해당 협력사에 해당하는 정보만 제공합니다.

---

수정번호

• Release v2.00_240827: 대시보드 전체 리뉴얼에 따른 수정

---

코드정리

• 집계구분코드(agrtGb) : 01 : 주문현황집계코드, 02 : 매출현황집계코드

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

Responses

200

성공

*/*

ordSaleAmtinteger · int64Required

당일 주문/매출 금액

Example: 100

ordSaleAmtRatenumber · doubleRequired

전일대비 주문/매출 증가율

Example: 10

ordSaleCntinteger · int64Required

당일 주문/매출 건수

Example: 100

ordSaleCntRatenumber · doubleRequired

전일대비 주문/매출 건수 증가율

Example: 10

cnclRtnAmtnumberRequired

당일 취소/반품 금액

Example: 100

cnclRtnAmtRatenumber · doubleRequired

전일대비 취소/반품 금액 증가율

Example: 10

cnclRtnCntinteger · int64Required

전일대비 취소/반품 건수

Example: 100

cnclRtnCntRatenumber · doubleRequired

전일대비 취소/반품 건수 증가율

Example: 10

900

업무처리 오류 내용

*/*

get

/v2/dashboard/order/order-sales-status

HTTPcURLJavaScriptPython

GET /api/bo/v2/dashboard/order/order-sales-status?orderSalesDashBoardRequest=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

대시보드 고객 여정별 구매전환율 조회

get

기능설명

• BO(MD) 대시보드의 고객 여정별 구매전환율 정보를 조회합니다.

---

상세설명

• 당일 기준 / 최근 7일 / 최근 30일 간 주문 매출 현황 정보를 제공합니다.

• 사이트 파라미터가 전체가 아닌 경우 해당 사이트에 해당하는 정보만 제공합니다.

• 구매전환율은 방문수 대비 주문완료 비율입니다.

---

수정번호

• Release v2.00_240827: 대시보드 고객 여정별 구매전환율 생성

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

Responses

200

성공

*/*

mainnumber · doubleRequired

메인 방문수의 구매전환율

Example: 30

mainRatenumber · doubleRequired

메인 방문수의 구매전환율 증가율

Example: 30

goodsDetailnumber · doubleRequired

상품상세 방문수의 구매전환율

Example: 30

goodsDetailRatenumber · doubleRequired

상품상세 방문수의 구매전환율 증가율

Example: 30

basketnumber · doubleRequired

장바구니 방문수의 구매전환율

Example: 30

basketRatenumber · doubleRequired

장바구니 방문수의 구매전환율 증가율

Example: 30

orderSheetnumber · doubleRequired

주문서 방문수의 구매전환율

Example: 30

orderSheetRatenumber · doubleRequired

주문서 방문수의 구매전환율 증가율

Example: 30

900

업무처리 오류 내용

*/*

get

/v2/dashboard/order/customer-journey-conversion-rate

HTTPcURLJavaScriptPython

GET /api/bo/v2/dashboard/order/customer-journey-conversion-rate?visitToOrderDashBoardRequest=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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
    }
  ]
}