Lemong Partner API

Appearance

매장 조회 ​

브랜드에 연동된 매장 목록을 반환합니다.

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

Request ​

bash
curl -H 'x-partner-api-key: YOUR_API_KEY' \
  'https://api.lemong.ai/partner/v1/brands/BRAND100/shops'

쿼리 파라미터 ​

파라미터타입설명
pagenumber기본 1
limitnumber기본 20, 최대 100

Response ​

json
{
  "status": "SUCCESS",
  "status_code": 200,
  "message": "OK",
  "data": {
    "items": [
      {
        "name": "몽도시락 강남점",
        "platform": "BAEMIN",
        "platform_shop_id": "14839218",
        "category_name": "도시락",
        "status": "ACTIVE",
        "user": {
          "user_code": "UK7M2QX4TVB",
          "display_name": "몽도시락 강남점"
        },
        "managers": [
          { "display_name": "박담당", "role": "SUPERVISOR" },
          { "display_name": "정담당", "role": "MANAGER" }
        ],
        "critical_review_alerts": [
          {
            "phone_number": "010-1234-5678",
            "enabled": true,
            "manager": { "display_name": "김본사", "role": "OWNER" }
          },
          {
            "phone_number": "010-2345-6789",
            "enabled": false,
            "manager": { "display_name": "박담당", "role": "SUPERVISOR" }
          }
        ]
      },
      {
        "name": "몽도시락 강남점",
        "platform": "NAVER",
        "platform_shop_id": "998877",
        "category_name": "한식",
        "status": "FAILED",
        "user": {
          "user_code": "UK7M2QX4TVB",
          "display_name": "몽도시락 강남점"
        },
        "managers": [],
        "critical_review_alerts": []
      }
    ],
    "page": 1,
    "limit": 20,
    "has_next": false
  }
}

Description ​

필드타입설명
namestring매장명 (플랫폼 등록 기준)
platformenum연동 플랫폼
platform_shop_idstring플랫폼 측 매장 id. 리뷰의 같은 필드와 매칭
category_namestring플랫폼 카테고리
statusenum연동 상태
userobject | null매장이 속한 브랜드 유저. 필드는 브랜드 유저 조회 참고
managersobject[]이 매장을 담당하는 본사 관리자. 없으면 빈 배열
critical_review_alertsobject[]이 매장에 등록된 불만족 리뷰 알림 번호. 없으면 빈 배열

managers ​

이 매장을 담당하도록 배정된 본사 관리자입니다. 본사 소속이며 가맹점주가 아닙니다.

필드타입설명
display_namestring담당자 이름
roleenum | nullOWNER / MANAGER / SUPERVISOR

배정 정보이므로 이 담당자가 알림을 받는다는 뜻은 아닙니다. 알림 수신은 아래 critical_review_alerts 를 보세요.

critical_review_alerts ​

이 매장에 등록된 불만족 리뷰 알림 번호입니다. 매장당 최대 3개입니다.

필드타입설명
phone_numberstring알림 수신 번호
enabledboolean수신 활성 여부. false 면 등록만 되어 있고 발송 안 됨
managerobject | null번호 주인 담당자. 관리자가 아닌 번호면 null
  • 번호 인증은 브랜드 단위이고, 매장에 등록하는 것은 별개 단계입니다. 그래서 managers 에 없는 사람의 번호가 등록되어 있을 수 있습니다. 실제 알림 수신자는 이 배열이 정본입니다.
  • 반대로 managers 에 있어도 번호를 등록하지 않았다면 여기 나오지 않습니다.

status 값 ​

값의미
ACTIVE정상 연동 중. 리뷰가 수집됩니다.
INACTIVE연동 중지. 리뷰나 매출이 수집되지 않습니다.
FAILED연동 실패. 플랫폼 로그인 오류로 수집되지 않습니다.

platform 값 ​

값플랫폼
BAEMIN배달의민족
CPEATS쿠팡이츠
YOGIYO요기요
DDANGYO땡겨요
NAVER네이버 플레이스
MUKKEBI먹깨비

TIP

ACTIVE 가 아닌 매장은 리뷰나 매출이 갱신되지 않습니다.

Error Case ​

json
{
  "status": "PARTNER_API_BRAND_NOT_FOUND",
  "status_code": 404,
  "message": "요청을 처리할 수 없습니다."
}
status_codestatus이 API 에서 발생하는 경우
401PARTNER_API_KEY_REQUIREDx-partner-api-key 헤더 누락
401PARTNER_API_KEY_INVALID등록되지 않은 키
401PARTNER_API_KEY_INACTIVE폐기된 키
401PARTNER_API_KEY_EXPIRED만료된 키
403PARTNER_API_FORBIDDEN비활성화된 협력사 (담당자 문의)
404PARTNER_API_BRAND_NOT_FOUNDbrand_code 가 없거나 이 키의 범위 밖
404PARTNER_API_NOT_FOUND잘못된 URL 경로
429PARTNER_API_RATE_LIMITED호출 제한 초과 (분당 100회)
500PARTNER_API_INTERNAL_ERROR서버 오류