> ## Documentation Index
> Fetch the complete documentation index at: https://docs.notifly.tech/llms.txt
> Use this file to discover all available pages before exploring further.

# 카페24 데이터 설명

> 카페24 쇼핑몰의 유저 정보가 노티플라이에 어떤 방식으로 적재되는지, 그리고 어떠한 정보를 실제로 캠페인에 어떻게 활용할 수 있는지에 대해 설명합니다. 또한, 쇼핑몰에서 유저의 이벤트가 발생했을 때, 어떠한 이벤트가 수신되는지에 대해서도 설명합니다.

## 유저 프로퍼티

활용 가능한 유저 프로퍼티는 다음과 같습니다. 유저 프로퍼티는 비회원일 경우 활용하실 수 없으며, 회원인 경우에만 활용 가능합니다.

| 프로퍼티 명 | 변수 타입 | 설명 |
| - | - | - |
| `name` | Text | 이름 |
| `nick_name` | Text | 닉네임 |
| `shop_no` | Int | 쇼핑몰 번호 (멀티 쇼핑몰이 아닐 경우 `1` 이 기본값) |
| `job` | Text | 직업명 |
| `job_class` | Text | 직종 |
| `sms` | Text | SMS 수신 동의 여부 T : 동의 / F : 미동의 |
| `news_mail` | Text | 뉴스레터 (이메일) 수신 동의 여부 T : 동의 / F : 미동의 |
| `member_type` | Text | 회원타입 p: 개인 / c: 사업자 / f: 외국인 |
| `member_authority` | Text | 회원 권한 구분 C : 일반회원 / P : 대표 운영자 / A : 부운영자 / S : 공급사 |
| `country_code` | Text | 회원이 가입 시 입력한 국가 코드 (한국 - KOR) |
| `city` | Text | 도시명 |
| `lifetime_member` | Text | 평생회원 여부 T : 평생회원 / F : 일반회원 |
| `gender` | Text | 성별 M : 남성 / F : 여성 |
| `birthday` | Text | 생년월일 (YYYY-MM-DD) |
| `group_no` | Int | 그룹 번호 |
| `group_name` | Text | 그룹명 |
| `interest` | Text | 관심사 |
| `created_date` | Text | 가입일시 (ISO8601 Format) |
| `last_login_date` | Text | 마지막 로그인 일시 (ISO8601 Format) |
| `member_authentication` | Text | T : 인증 / F : 미인증 / B : 특별관리회원 / J : 14세미만회원 |
| `use_blacklist` | Text | T : 블랙리스트 / F : 블랙리스트 아님 |
| `join_path` | Text | 가입경로, P: PC / M: Mobile |
| `available_points` | Int | 가용 적립금 |
| `returned_points` | Int | 환불 예정 적립금 |
| `total_points` | Int | 총 적립금 |
| `unavailable_points` | Int | 미가용 적립금 |
| `used_points` | Int | 사용 적립금 |
| `all_credits` | Int | 가용 예치금 |
| `member_total_credits` | Int | 회원테이블에 있는 예치금 |
| `refund_wait_credits` | Int | 환불요청된 예치금 |
| `total_credits` | Int | 총 예치금 |
| `used_credits` | Int | 사용된 예치금 |

## BUILT-IN 이벤트

카페24에서 발생하는 모든 이벤트는 `cafe24__` 접두사가 붙습니다. 활용 가능한 이벤트는 다음과 같습니다.

> [!WARNING]
>
> 카페24 플랫폼 제약 사항으로 인해, 몇 가지 이벤트는 유저가 쇼핑몰에 접속하는 브라우저 상에서 발생하는 이벤트가 아닌 서버 상에서 발생하는 이벤트입니다. 따라서, 해당 이벤트가 발생했을 때 팝업을 트리거할 수 없습니다. 이벤트 목록에 `팝업 트리거 가능 여부` 컬럼을 참고해주세요.

| 이벤트 명 | 이벤트 패러미터 | 트리거 타이밍 | 웹 팝업 사용 가능 여부 | 비고 |
| - | - | - | - | - |
| `cafe24__pageview_<pathname>` | 없음 | 유저가 페이지에 방문했을 때 | O | 곧 지원이 중단됩니다. |
| `cafe24__pv` | `full_url`: 전체 URL (Text)`pathname`: 페이지 경로 (Text)`search`: 쿼리스트링 (Text)`hash`: 해시 (Text)`hostname`: 페이지 호스트 이름 (Text)`protocol`: 프로토콜 (Text)`port`: 포트 번호 (Text)`origin`: 페이지 오리진 (Text)`query.<Key 이름>`: 쿼리스트링의 키와 값 (Text) | 유저가 페이지에 방문했을 때 | O | 2024.08.21 이후부터 지원됨 |
| `cafe24__sign_up` | 없음 | 유저가 회원가입을 하였을 때 | X | |
| `cafe24__login` | 없음 | 로그인 했을 때 | O | |
| `cafe24__add_cart` | `product_no` : 추가된 상품 번호 (Int)`product_price`: 추가된 상품 가격(Int)`variant_code`: 추가된 상품 코드(Text) | 장바구니에 상품이 추가되었을 때 | O | |
| `cafe24__add_wishlist` | 없음 | 상품이 관심 목록에 추가되었을 때 | O | |
| `cafe24__order_completed` | `shop_no` : 멀티쇼핑몰 번호 (Int)`currency`: 통화(Text)`order_date`: 주문 일시(Text)`name`: 구매자 이름(Text)`first_order`: 첫 주문 여부(Bool)`total_price`: 총 주문 금액 (Int)`membership_discount_price`: 회원 할인 금액 (Int)`actual_payment_price`: 실 결제 금액 (Int)`mileage_spent_price`:적립금 사용 금액`product_codes`: 주문 상품 코드 (Array)`product_names`: 주문 상품 이름 (Array)`product_names_text`: 텍스트화된 주문 상품 이름 (Text) `order_id`: 주문번호 (Text) `bank_account_no`: 계좌번호 (Text) | 주문이 완료되었을 때 | X | |
| `cafe24__order_canceled` | `cafe24__order_completed`의 모든 패러미터`cancel_date`: 취소 일시(Text) | 주문이 취소되었을 때 | X | |
| `cafe24__order_started` | `cart_items`: 주문서에 포함된 상품 번호 (Array of Int)`total_price`: 주문서에 포함된 상품의 총 가격(Int) | 주문서 작성 페이지에 방문하였을 때 | O | |
| `cafe24__user_group_changed` | `new_group`: 새로운 그룹명 (Text) | | | |
| `cafe24__shipping_in_progress` | `cafe24__order_completed`의 모든 패러미터`shipping_type`: 배송 유형(국내, 해외)`wished_delivery_date`: 희망배송일(yyyy-MM-dd)`store_pickup`: 매장수령여부(Bool)`shipping_message`: 배송 메시지(Text) | 배송이 시작되었을 때 | X | |
| `cafe24__shipping_completed` | `cafe24__shipping_in_progress`의 모든 패러미터 | 배송이 완료되었을 때 | X | |
| `cafe24__shipping_hold` | `cafe24__shipping_in_progress`의 모든 패러미터 | 배송이 보류되었을 때 | X | |

> [!WARNING]
>
> `cafe24__pageview_<pathname>` 이벤트는 곧 지원이 중단됩니다. 이를 대신하여, `cafe24__pv` 이벤트를 사용해주세요.
>
> `cafe24__pv` 이벤트는 `cafe24__pageview_<pathname>` 보다 더 많은 정보를 담고 있습니다. 자세한 이용 방법은 [캠페인 예시](https://docs.notifly.tech/ko/user-guide/integrations/cafe24/campaign-examples.md)를 참고해주세요.

> [!TIP]
>
> 예를 들어 `product_names` 이라는 프로퍼티는 주문 상품의 이름을 배열로 가지고 있습니다. 이 배열을 텍스트로 변환한 것이 `product_names_text` 입니다. 예를 들어, `product_names` 가 `['상품1', '상품2']` 라면, `product_names_text` 는 `'상품1, 상품2'` 가 됩니다. 텍스트가 너무 길어지는 것을 방지하기 위하여, 아이템 두 개까지만 Comma (`,`) 로 구분하여 표시됩니다. 두 개 이상의 아이템이 있는 경우, `외 n개` 라고 표시됩니다. 예를 들어, `product_names` 가 `['상품1', '상품2', '상품3']` 이라면, `product_names_text` 는 `상품1, 상품2 외 1개` 로 표시됩니다.

## 커스텀 이벤트 추가하기

Built-in 이벤트 외, 쇼핑몰에서 발생하는 커스텀 이벤트를 추가할 수 있습니다. 커스텀 이벤트 추가는 GTM(Google Tag Manager)를 통해 가능합니다. 커스텀 이벤트를 추가하는 방법은 [GTM을 이용한 커스텀 이벤트](https://docs.notifly.tech/ko/user-guide/integrations/cafe24/cafe24-gtm.md)를 참고해주세요.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.