주문클레임 대시보드

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

post

기능설명

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

상세설명

당일 기준 / 최근 7일 / 최근 30일 간 주문 매출 현황 정보를 제공합니다.
사이트 파라미터가 전체가 아닌 경우 해당 사이트에 해당하는 정보만 제공합니다.
구매전환율은 방문수 대비 주문완료 비율입니다.

수정번호

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

Header parameters

AuthorizationanyOptional

Access Token

Body

대시보드 고객 여정별 구매전환율 영역 조회 요청 DTO

statusPeriodstringRequired

조회기간구분

Example: 0

siteNostringOptional

사이트번호

Example: 1

Responses

200

성공

*/*

대시보드 고객 여정별 구매전환율 영역 조회 응답 DTO

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

업무처리 오류 내용

*/*

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

대시보드 overview 조회

post

기능설명

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

상세설명

당일 기준 / 최근 7일 / 최근 30일 간 주문 매출 현황 정보를 제공합니다.
사이트 파라미터가 전체가 아닌 경우 해당 사이트에 해당하는 정보만 제공합니다.
구매고객수는 주문한 사용자의 수 입니다.(반품,취소는 카운트하지 않습니다.)
방문수는 FO에 방문한 방문자수 입니다.
구매전환율은 방문수 대비 주문완료 비율입니다.
가입전환율은 방문수 대비 회원가입 비율입니다.
주문평균은 조회기간 동안 발생한 모든 고객 주문의 평균 금액입니다.

수정번호

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

Header parameters

AuthorizationanyOptional

Access Token

Body

대시보드 overview영역 조회 요청 DTO

statusPeriodstringRequired

조회기간구분

Example: 0

siteNostringOptional

사이트번호

Example: 1

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

업무처리 오류 내용

*/*

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
}

주문매출현황

post

기능설명

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

상세설명

**집계구분코드(agrtGb)**는 필수 파라미터 입니다.
요청 집계구분코드가 '01'일 경우, 주문 현황 정보를 제공합니다.
요청 집계구분코드가 '02'일 경우, 매출 현황 정보를 제공합니다.
당일 기준 / 최근 7일 / 최근 30일 간 주문 매출 현황 정보를 제공합니다.
사이트 파라미터가 전체가 아닌 경우 해당 사이트에 해당하는 정보만 제공합니다.
PO 진입 시 해당 협력사에 해당하는 정보만 제공합니다.

수정번호

Release v2.00_240711: 주문/취소금액을 표시할 때 기본 주문/취소금액에 건수를 곱하지 않도록 수정
Release v2.00_240827: 대시보드 전체 리뉴얼에 따른 수정

코드정리

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

Header parameters

AuthorizationanyOptional

Access Token

Body

주문매출현황 조회 요청 DTO

agrtGbstringRequired

집계구분

Example: 01

statusPeriodstringRequired

조회기간구분

Example: 0

entrNostringOptional

협력사번호

Example: 1000002

siteNostringOptional

사이트번호

Example: 1

Responses

200

성공

*/*

주문매출현황 조회 응답 DTO

ordSaleAmtinteger · int64Required

당일 주문/매출 금액

Example: 100

ordSaleAmtRatenumber · doubleRequired

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

Example: 10

ordSaleCntinteger · int64Required

당일 주문/매출 건수

Example: 100

ordSaleCntRatenumber · doubleRequired

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

Example: 10

cnclRtnAmtinteger · int64Required

당일 취소/반품 금액

Example: 100

cnclRtnAmtRatenumber · doubleRequired

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

Example: 10

cnclRtnCntinteger · int64Required

전일대비 취소/반품 건수

Example: 100

cnclRtnCntRatenumber · doubleRequired

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

Example: 10

900

업무처리 오류 내용

*/*

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

주문/클레임현황

post

기능 설명

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

상세 설명

주문/클레임구분(ordCntGb), **협력사명(entrNo)**은 필수 파라미터 입니다.
**주문/클레임구분(ordCntGb)**이 주문(O) 일경우 다음의 **주문내역상태코드(OM005)**의 건 수를 노출한다.
- 주문완료(12), 배송지시(21), 출고지시(22), 출고대기(23), 출고완료(26)
**주문/클레임구분(ordCntGb)**이 클레임(C) 일경우 다음의 **주문내역상태코드(OM005)**의 건 수를 노출한다.
- 클레임접수(32), 회수지시(34), 회수확인(35)

특이 사항

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

수정 번호

Release v2.00_240827 : 주문접수일시 최근 30일 기준 조건 추가

Header parameters

AuthorizationanyOptional

Access Token

Body

주문현황/클레임현황 요청 DTO

ordCntGbstringRequired

주문/클레임구분 O:주문, C:클레임

Default: OExample: O

entrNostringOptional

협력사번호

Example: 1000002

Responses

200

성공

*/*

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

ordDtlStatNmstringOptional

주문클레임상태명

Example: 주문완료

ordDtlStatCdstring · enumOptional

OM005(주문내역상태코드) 10: REPAY_REQ(재결제요청) ,11: ORDER_ACCEPT(주문접수) ,12: ORDER_COMPLETE(주문완료) ,13: ORDER_CANCEL(주문취소) ,21: DELIVERY_ORDER(배송지시) ,22: SHIPPING_ORDER(출고지시) ,23: SHIPPING_WAIT(출고대기) ,25: SHIPPING_CONFIRM(출고확정) ,26: SHIPPING_FINISH(출고완료) ,27: DELIVERY_FINISH(배송완료) ,31: RETURN_APPLY(결제대기) ,32: RETURN_ACCEPT(반품접수) ,33: RETURN_CANCEL(반품취소) ,34: WITHDRAWAL_ORDER(회수지시) ,35: WITHDRAWAL_CONFIRM(회수확인) ,36: WITHDRAWAL_FINISH(회수완료) ,37: RETURN_FINISH(반품완료)

Example: 10Possible values:

cntinteger · int32Optional

주문클레임상태별 수량

Example: 0

900

업무처리 오류 내용

*/*

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

이전배송

다음분리보관

마지막 업데이트 2개월 전