프로모션 관련 API

프로모션과 관련된 API 기능을 제공합니다.

타입 정의

API 요청/응답의 각 필드에서 사용되는 타입 정의들을 확인할 수 있습니다
CardPromotion: { type, id, storeId, ... }
카드 프로모션

카드 프로모션

Currency: "KRW" | "USD" | "JPY" | ...
통화 단위

통화 단위

ForbiddenError: { type, message }
요청이 거절된 경우

요청이 거절된 경우

GetPromotionError: ForbiddenError | InvalidRequestError | PromotionNotFoundError | ...
GetPromotionError
InvalidRequestError: { type, message }
요청된 입력 정보가 유효하지 않은 경우

허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

Promotion: CardPromotion
프로모션

프로모션

PromotionAmountDiscountScheme: { type, amount }
PromotionAmountDiscountScheme
PromotionCardCompany: "WOORI_CARD" | "BC_CARD" | "SAMSUNG_CARD" | ...
프로모션 적용 가능한 카드사

프로모션 적용 가능한 카드사

PromotionDiscountPartition: { amountFrom, scheme }
금액 구간별 프로모션 할인 정책

금액 구간별 프로모션 할인 정책

PromotionDiscountPolicy: { partitions }
프로모션 할인 정책

프로모션 할인 정책

PromotionDiscountScheme: PromotionAmountDiscountScheme | PromotionPercentDiscountScheme
PromotionDiscountScheme
PromotionNotFoundError: { type, message }
프로모션이 존재하지 않는 경우

프로모션이 존재하지 않는 경우

PromotionPercentDiscountScheme: { type, percent }
PromotionPercentDiscountScheme
PromotionRecoverOption: PromotionRecoverOptionNoRecover | PromotionRecoverOptionRecover
PromotionRecoverOption
PromotionRecoverOptionNoRecover: { type, spareBudget }
결제 취소 시 프로모션 예산 미복구

결제 취소 시 프로모션 예산 미복구

PromotionRecoverOptionRecover: { type }
결제 취소 시 프로모션 예산 복구

결제 취소 시 프로모션 예산 복구

PromotionSpareBudget: PromotionSpareBudgetAmount | PromotionSpareBudgetPercent
PromotionSpareBudget
PromotionSpareBudgetAmount: { type, amount }
PromotionSpareBudgetAmount
PromotionSpareBudgetPercent: { type, percent }
PromotionSpareBudgetPercent
PromotionStatus: "SCHEDULED" | "IN_PROGRESS" | "PAUSED" | ...
PromotionStatus
UnauthorizedError: { type, message }
인증 정보가 올바르지 않은 경우

인증 정보가 올바르지 않은 경우