매출 조회

브랜드의 기간 합산 매출을 반환합니다. 댓글몽 브랜드 리뷰 현황 화면과 동일한 일별 집계를 소스로 씁니다.

GET /partner/v1/brands/{brand_code}/sales

Request

curl -H 'x-partner-api-key: YOUR_API_KEY' \
  'https://api.lemong.ai/partner/v1/brands/BRAND100/sales?from=2026-08-01&to=2026-08-31&group_by=shop'

쿼리 파라미터

파라미터	타입	설명
from	YYYY-MM-DD	집계 시작일 (KST, 포함). 생략 시 to 기준 30일 전
to	YYYY-MM-DD	집계 종료일 (KST, 포함). 생략 시 오늘
group_by	enum	집계 단위. 기본 shop. 추이는 date / week
platform	enum	BAEMIN, CPEATS, YOGIYO
platform_shop_id	string	특정 매장만
page	number	기본 1
limit	number	기본 20, 최대 100

Response

shop / platform / user 는 매출액 내림차순, date / week 는 최신순입니다.

{
  "status": "SUCCESS",
  "status_code": 200,
  "message": "OK",
  "data": {
    "items": [
      {
        "group_by": "shop",
        "date": null,
        "week_start": null,
        "platform_shop_id": "12345678",
        "shop_name": "몽도시락 강남점",
        "platform": "BAEMIN",
        "user": {
          "user_code": "UK7M2QX4TVB",
          "display_name": "몽도시락 강남점"
        },
        "sales_amount": 12500000
      },
      {
        "group_by": "shop",
        "date": null,
        "week_start": null,
        "platform_shop_id": "123456789",
        "shop_name": "몽도시락 역삼점",
        "platform": "CPEATS",
        "user": {
          "user_code": "UP4RJ8NZQM2",
          "display_name": "몽도시락 역삼점"
        },
        "sales_amount": 8320000
      }
    ],
    "page": 1,
    "limit": 20,
    "has_next": false
  }
}

Description

필드	타입	설명
group_by	enum	집계 단위
date	string | null	집계 일자 (KST). date 단위에서만
week_start	string | null	주 시작일, 월요일 (KST). week 단위에서만
platform_shop_id	string | null	플랫폼 측 매장 id
shop_name	string | null	매장명
platform	enum | null	플랫폼
user	object | null	유저. 필드는 브랜드 유저 조회 참고
sales_amount	number	기간 합산 매출액 (원)

platform 값

값	플랫폼
BAEMIN	배달의민족
CPEATS	쿠팡이츠
YOGIYO	요기요

집계 단위(group_by)

값	집계 기준
shop	매장별 (기본값)
platform	플랫폼별
user	브랜드 유저별
date	일자별
week	주별 (월요일 시작)

필드 존재 여부

집계 단위에 따라 채워지는 필드가 달라집니다.

필드	shop	platform	user	date	week
sales_amount	O	O	O	O	O
platform	O	O	-	-	-
platform_shop_id, shop_name	O	-	-	-	-
user	O	-	O	-	-
date	-	-	-	O	-
week_start	-	-	-	-	O

주 단위 예시입니다. 기간 양 끝의 주는 조회 기간에 걸친 날만 합산되므로, 온전한 한 주가 아닐 수 있습니다.

{ "group_by": "week", "week_start": "2026-08-24", "sales_amount": 31200000 }

집계 데이터의 한계

• 주문 데이터를 집계한 집계데이터는 하루 한 번 갱신되며, 연동한 매장의 데이터는 당일에 집계되지 않습니다.
• 일 단위로 집계된 스냅샷을 합산한 값이며, 플랫폼 정산액과 정확히 일치하지 않을 수 있습니다.
• 집계가 없는 대상은 응답에 나오지 않습니다.

Error Case

{
  "status": "PARTNER_API_INVALID_PARAMETER",
  "status_code": 400,
  "message": "요청을 처리할 수 없습니다."
}

status_code	status	이 API 에서 발생하는 경우
400	PARTNER_API_INVALID_PARAMETER	날짜 형식 오류, from 이 to 보다 늦음, 잘못된 group_by
401	PARTNER_API_KEY_REQUIRED	x-partner-api-key 헤더 누락
401	PARTNER_API_KEY_INVALID	등록되지 않은 키
401	PARTNER_API_KEY_INACTIVE	폐기된 키
401	PARTNER_API_KEY_EXPIRED	만료된 키
403	PARTNER_API_FORBIDDEN	비활성화된 협력사 (담당자 문의)
404	PARTNER_API_BRAND_NOT_FOUND	brand_code 가 없거나 이 키의 범위 밖
404	PARTNER_API_NOT_FOUND	잘못된 URL 경로
429	PARTNER_API_RATE_LIMITED	호출 제한 초과 (분당 100회)
500	PARTNER_API_INTERNAL_ERROR	서버 오류