ALPHA 카탈로그 - 전시 규칙

상품, 옵션 등 매장의 카탈로그에 대한 전시 규칙을 관리할 수 있습니다.

전시 규칙 기능이 보이지 않아요

ALPHA 전시 규칙 기능은 현재 일부 매장에만 지원 중인 기능입니다.

전시 규칙은 주문 과정에서 특정 상품이나 선택지를 골랐을 때 그에 맞추어 동적으로 전시 화면을 변경하는 정책을 표현합니다. 예를 들어, 카페 업종에서 다음과 같은 상황을 생각해 봅시다.

• 고객이 음료 주문 시 온도에서 ICE 선택지를 선택한 경우, 얼음 양(많이/적게)을 함께 고르도록 표시되어야 한다.

이 예시의 경우, 다음과 같은 전시 규칙으로 표현합니다.

{
    "id": "42",  // 전시 규칙 ID

    /* 조건: '온도' 옵션에서 'ICE' 선택지를 고른 경우 */
    "conditions": [
        {
            "type": "RESOURCE_SELECTED",
            "operator": "ANY",
            "targets": [
                { "type": "OPTION_CHOICE", "id": "30" } // 'ICE' 선택지의 ID
            ]
        }
    ],
    "conditionsOperator": "AND",

    /* 효과: '얼음 양' 옵션을 표시한다 */
    "targets": [
        { "type": "OPTION_SET", "id": "10" } // '얼음 양' 옵션의 ID
    ],
    "effect": "DISPLAY",
}

Types

ALPHA 전시 규칙 (CatalogRule)

Name	Type	Required	Description	Example
id	String	✅	전시 규칙 ID	42
conditions	CatalogRuleCondition[]	✅	전시 규칙 조건 목록	[{"type": "RESOURCE_SELECTED", "operator": "ANY", "targets": [{"type": "OPTION_CHOICE", "id": "10"}]}]
conditionsOperator	CatalogRuleConditionOperator	✅	전시 규칙 조건 목록 간 연산자	"AND"
targets	CatalogRuleResourceTarget[]	✅	전시 규칙 적용 대상 목록	[{"type": "OPTION_SET", "id": "30"}]
effect	CatalogRuleEffectType	✅	전시 규칙 효과 종류	"DISPLAY"
createdAt	timestamp	✅	생성 시각	"2025-09-01T00:00:00Z"
updatedAt	timestamp	✅	수정 시각	"2025-09-01T00:00:00Z"

ALPHA 전시 규칙 대상 (CatalogRuleResourceTarget)

전시 규칙이 적용되거나 조건에서 참조되는 대상을 정의합니다.

Name	Type	Required	Description	Example
type	CatalogRuleResourceType	✅	대상 종류	"OPTION_SET"
id	String	✅	대상 ID	"42"

ALPHA 전시 규칙 대상 종류 (CatalogRuleResourceType)

Value	Description
"OPTION_SET"	옵션
"OPTION_CHOICE"	옵션 선택지
"UNDEFINED"

ALPHA 전시 규칙 조건 (CatalogRuleCondition)

전시 규칙이 적용되기 위한 조건을 정의합니다. 현재 아래 조건을 지원합니다.

• "RESOURCE_SELECTED": 고객이 대상을 선택했을 때

"RESOURCE_SELECTED" 조건

Name	Type	Required	Description	Example
type	String	✅	조건 종류	"RESOURCE_SELECTED"
operator	String	✅	조건 대상 간 연산자 (ANY 고정)	"ANY"
targets	CatalogRuleResourceTarget[]	✅	조건 대상 목록	[{"type": "OPTION_CHOICE", "id": "10"}]

ALPHA 전시 규칙 조건 연산자 (CatalogRuleConditionOperator)

Value	Description
"AND"	모든 조건이 만족되면 조건 만족
"OR"	조건 중 하나라도 만족되면 조건 만족
"UNDEFINED"

ALPHA 전시 규칙 효과 (CatalogRuleEffectType)

Value	Description
"DISPLAY"	조건 만족 시 적용 대상을 화면에 노출
"UNDEFINED"

Methods

ALPHA 전시 규칙 단건 조회

Property	Value
Method	GET
Path	/api-public/openapi/v1/merchants/{merchantId}/catalog/rules/{ruleId}
Response Type	CatalogRule
Description	매장의 전시 규칙 하나를 조회합니다.

요청 파라미터

Parameter	Location	Type	Required	Description
merchantId	Path	Long	✅	매장 ID
ruleId	Path	String	✅	전시 규칙 ID

ALPHA 전시 규칙 복수건 조회

Property	Value
Method	GET
Path	/api-public/openapi/v1/merchants/{merchantId}/catalog/rules/by-ids
Response Type	CatalogRule[]
Description	ID를 통해 매장의 전시 규칙 여러 건을 조회합니다. 최대 25건까지 조회 가능합니다.

요청 파라미터

Parameter	Location	Type	Required	Description
merchantId	Path	Long	✅	매장 ID
ids	Query	String[]	✅	전시 규칙 ID 목록

ALPHA 전시 규칙 목록 조회

Property	Value
Method	GET
Path	/api-public/openapi/v1/merchants/{merchantId}/catalog/rules
Response Type	CatalogRule[]
Description	매장의 전시 규칙 목록을 조회합니다.

요청 파라미터

Parameter	Location	Type	Required	Default	Description
merchantId	Path	Long	✅	-	매장 ID
page	Query	Int		1	조회할 페이지
size	Query	Int		100	페이지 크기