정책 관련 API

파트너 정산에 적용할 정책에 관한 API 입니다.

타입 정의

API 요청/응답의 각 필드에서 사용되는 타입 정의들을 확인할 수 있습니다
ArchivePlatformAdditionalFeePolicyError: ForbiddenError | InvalidRequestError | PlatformAdditionalFeePolicyNotFoundError | ...
ArchivePlatformAdditionalFeePolicyError
ArchivePlatformAdditionalFeePolicyResponse: { additionalFeePolicy }
추가 수수료 정책 보관 성공 응답

추가 수수료 정책 보관 성공 응답

ArchivePlatformContractError: ForbiddenError | InvalidRequestError | PlatformCannotArchiveScheduledContractError | ...
ArchivePlatformContractError
ArchivePlatformContractResponse: { contract }
계약 보관 성공 응답

계약 보관 성공 응답

ArchivePlatformDiscountSharePolicyError: ForbiddenError | InvalidRequestError | PlatformCannotArchiveScheduledDiscountSharePolicyError | ...
ArchivePlatformDiscountSharePolicyError
ArchivePlatformDiscountSharePolicyResponse: { discountSharePolicy }
할인 분담 보관 성공 응답

할인 분담 보관 성공 응답

CreatePlatformAdditionalFeePolicyBody: { id, name, fee, ... }
추가 수수료 정책 생성을 위한 입력 정보

추가 수수료 정책 생성을 위한 입력 정보

CreatePlatformAdditionalFeePolicyError: ForbiddenError | InvalidRequestError | PlatformAdditionalFeePolicyAlreadyExistsError | ...
CreatePlatformAdditionalFeePolicyError
CreatePlatformAdditionalFeePolicyResponse: { additionalFeePolicy }
플랫폼 생성 성공 응답 정보

플랫폼 생성 성공 응답 정보

CreatePlatformContractBody: { id, name, memo, ... }
계약 객체 생성을 위한 입력 정보

계약 객체 생성을 위한 입력 정보

CreatePlatformContractError: ForbiddenError | InvalidRequestError | PlatformContractAlreadyExistsError | ...
CreatePlatformContractError
CreatePlatformContractResponse: { contract }
계약 객체 생성 성공 응답

계약 객체 생성 성공 응답

CreatePlatformDiscountSharePolicyBody: { id, name, partnerShareRate, ... }
할인 분담 정책 생성을 위한 입력 정보

할인 분담 정책 생성을 위한 입력 정보

CreatePlatformDiscountSharePolicyError: ForbiddenError | InvalidRequestError | PlatformDiscountSharePolicyAlreadyExistsError | ...
CreatePlatformDiscountSharePolicyError
CreatePlatformDiscountSharePolicyResponse: { discountSharePolicy }
할인 분담 정책 생성 성공 응답

할인 분담 정책 생성 성공 응답

DayOfWeek: "SUN" | "MON" | "TUE" | ...
요일

요일

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

요청이 거절된 경우

GetPlatformAdditionalFeePoliciesBody: { page, filter }
추가 수수료 정책 다건 조회를 위한 입력 정보

추가 수수료 정책 다건 조회를 위한 입력 정보

GetPlatformAdditionalFeePoliciesError: ForbiddenError | InvalidRequestError | PlatformNotEnabledError | ...
GetPlatformAdditionalFeePoliciesError
GetPlatformAdditionalFeePoliciesResponse: { items, page }
추가 수수료 정책 다건 조회 성공 응답 정보

추가 수수료 정책 다건 조회 성공 응답 정보

GetPlatformAdditionalFeePolicyError: ForbiddenError | InvalidRequestError | PlatformAdditionalFeePolicyNotFoundError | ...
GetPlatformAdditionalFeePolicyError
GetPlatformContractError: ForbiddenError | InvalidRequestError | PlatformContractNotFoundError | ...
GetPlatformContractError
GetPlatformContractsBody: { page, filter }
계약 다건 조회를 위한 입력 정보

계약 다건 조회를 위한 입력 정보

GetPlatformContractsError: ForbiddenError | InvalidRequestError | PlatformNotEnabledError | ...
GetPlatformContractsError
GetPlatformContractsResponse: { items, page }
계약 다건 조회 성공 응답

계약 다건 조회 성공 응답

GetPlatformDiscountSharePoliciesBody: { page, filter }
할인 분담 정책 다건 조회를 위한 입력 정보

할인 분담 정책 다건 조회를 위한 입력 정보

GetPlatformDiscountSharePoliciesError: ForbiddenError | InvalidRequestError | PlatformNotEnabledError | ...
GetPlatformDiscountSharePoliciesError
GetPlatformDiscountSharePoliciesResponse: { items, page }
할인 분담 정책 다건 조회 성공 응답 정보

할인 분담 정책 다건 조회 성공 응답 정보

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

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

MonthDay: { month, day }
월 및 일자 정보

월 및 일자 정보

PageInfo: { number, size, totalCount }
반환된 페이지 결과 정보

반환된 페이지 결과 정보

PageInput: { number, size }
다건 조회 API 에 사용되는 페이지 입력 정보

다건 조회 API 에 사용되는 페이지 입력 정보

PlatformAdditionalFeePolicy: { id, graphqlId, name, ... }
추가 수수료 정책

추가 수수료 정책는 고객사의 주문건에 대한 중개수수료에 별도로 추가로 부여되는 수수료입니다. 대표적인 사용 예시로 풀필먼트 수수료, 로켓배송 수수료, 마케팅 채널 수수료등이 있습니다.

PlatformAdditionalFeePolicyAlreadyExistsError: { type, message }
PlatformAdditionalFeePolicyAlreadyExistsError
PlatformAdditionalFeePolicyFilterInput: { isArchived, vatPayers, keyword }
추가 수수료 정책 다건 조회를 위한 필터 조건

추가 수수료 정책 다건 조회를 위한 필터 조건

PlatformAdditionalFeePolicyFilterInputKeyword: { name, id, fee }
검색 키워드 입력 정보

검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 추가 수수료 정책만 조회합니다. 하위 필드는 명시된 값 중 한 가지만 적용됩니다.

PlatformAdditionalFeePolicyNotFoundError: { type, message }
PlatformAdditionalFeePolicyNotFoundError
PlatformArchivedAdditionalFeePolicyError: { type, message }
보관된 추가 수수료 정책을 업데이트하려고 하는 경우

보관된 추가 수수료 정책을 업데이트하려고 하는 경우

PlatformArchivedContractError: { type, message }
보관된 계약을 업데이트하려고 하는 경우

보관된 계약을 업데이트하려고 하는 경우

PlatformArchivedDiscountSharePolicyError: { type, message }
보관된 할인 분담 정책을 업데이트하려고 하는 경우

보관된 할인 분담 정책을 업데이트하려고 하는 경우

PlatformCannotArchiveScheduledAdditionalFeePolicyError: { type, message }
예약된 업데이트가 있는 추가 수수료 정책을 보관하려고 하는 경우

예약된 업데이트가 있는 추가 수수료 정책을 보관하려고 하는 경우

PlatformCannotArchiveScheduledContractError: { type, message }
예약된 업데이트가 있는 계약을 보관하려고 하는 경우

예약된 업데이트가 있는 계약을 보관하려고 하는 경우

PlatformCannotArchiveScheduledDiscountSharePolicyError: { type, message }
예약된 업데이트가 있는 할인 분담 정책을 보관하려고 하는 경우

예약된 업데이트가 있는 할인 분담 정책을 보관하려고 하는 경우

PlatformContract: { id, graphqlId, name, ... }
계약

계약은 플랫폼 고객사가 파트너에게 정산해줄 대금과 정산일을 계산하는 데 적용되는 정보입니다. 고객사의 플랫폼에서 재화 및 서비스를 판매하기 위한 중개수수료와 판매금에 대한 정산일로 구성되어 있습니다.

PlatformContractAlreadyExistsError: { type, message }
PlatformContractAlreadyExistsError
PlatformContractFilterInput: { platformFeePayers, cycleTypes, datePolicies, ... }
계약 다건 조회를 위한 필터 조건

계약 다건 조회를 위한 필터 조건

PlatformContractFilterInputKeyword: { id, name }
검색 키워드 입력 정보

검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 계약만 조회합니다. 하나의 하위 필드에만 값을 명시하여 요청합니다.

PlatformContractNotFoundError: { type, message }
PlatformContractNotFoundError
PlatformDiscountSharePolicy: { id, graphqlId, name, ... }
할인 분담 정책

할인 분담은 고객사의 주문건에 쿠폰 및 포인트와 같은 할인금액이 적용될 때, 파트너 정산 시 할인금액에 대한 분담 정책을 가지는 객체입니다. 할인 유형에 대한 아이디와 메모, 그리고 파트너 분담율을 가집니다.

PlatformDiscountSharePolicyAlreadyExistsError: { type, message }
PlatformDiscountSharePolicyAlreadyExistsError
PlatformDiscountSharePolicyFilterInput: { isArchived, partnerShareRates, keyword }
할인 분담 정책 다건 조회를 위한 필터 조건

할인 분담 정책 다건 조회를 위한 필터 조건

PlatformDiscountSharePolicyFilterInputKeyword: { id, name }
검색 키워드 입력 정보

검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 할인 분담 정책만 조회합니다. 하위 필드는 명시된 값 중 한 가지만 적용됩니다.

PlatformDiscountSharePolicyNotFoundError: { type, message }
PlatformDiscountSharePolicyNotFoundError
PlatformFee: PlatformFixedAmountFee | PlatformFixedRateFee
플랫폼 중개수수료 정보

플랫폼 중개수수료 정보

PlatformFeeInput: { fixedRate, fixedAmount }
수수료 계산 방식을 특정하기 위한 입력 정보

정률 수수료를 설정하고 싶은 경우 fixedRate 필드에, 정액 수수료를 설정하고 싶은 경우 fixedAmount 필드에 값을 명시해 요청합니다. 두 필드 모두 값이 들어있지 않은 경우 요청이 거절됩니다.

PlatformFixedAmountFee: { type, amount }
정액 수수료

총 금액에 무관하게 정해진 수수료 금액을 책정합니다.

PlatformFixedRateFee: { type, rate }
정률 수수료

총 금액에 정해진 비율을 곱한 만큼의 수수료를 책정합니다.

PlatformNotEnabledError: { type, message }
플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우

플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우

PlatformPayer: "PARTNER" | "MERCHANT"
금액 부담 주체

플랫폼에서 발생한 결제 수수료, 부가세 등 금액을 부담하는 주체를 나타냅니다.

PlatformSettlementCycle: { lagDays, datePolicy, method }
정산 주기

지체일, 정산일, 기준일로 구성되며, 해당 요소들의 조합으로 실제 정산일을 계산합니다.

PlatformSettlementCycleDatePolicy: "HOLIDAY_BEFORE" | "HOLIDAY_AFTER" | "CALENDAR_DAY"
플랫폼 정산 기준일

플랫폼 정산 기준일

PlatformSettlementCycleInput: { lagDays, datePolicy, method }
플랫폼 정산 주기 입력 정보

플랫폼 정산 주기 입력 정보

PlatformSettlementCycleMethod: PlatformSettlementCycleMethodDaily | PlatformSettlementCycleMethodManualDates | PlatformSettlementCycleMethodMonthly | ...
플랫폼 정산 주기 계산 방식

플랫폼 정산 주기 계산 방식

PlatformSettlementCycleMethodDaily: { type }
매일 정산

매일 정산

PlatformSettlementCycleMethodDailyInput: { }
PlatformSettlementCycleMethodDailyInput
PlatformSettlementCycleMethodInput: { daily, weekly, monthly, ... }
플랫폼 정산 주기 계산 방식 입력 정보

하나의 하위 필드에만 값을 명시하여 요청합니다.

PlatformSettlementCycleMethodManualDates: { type, dates }
정해진 날짜(월, 일)에 정산

정해진 날짜(월, 일)에 정산

PlatformSettlementCycleMethodManualDatesInput: { dates }
PlatformSettlementCycleMethodManualDatesInput
PlatformSettlementCycleMethodMonthly: { type, daysOfMonth }
매월 정해진 날(일)에 정산

매월 정해진 날(일)에 정산

PlatformSettlementCycleMethodMonthlyInput: { daysOfMonth }
PlatformSettlementCycleMethodMonthlyInput
PlatformSettlementCycleMethodWeekly: { type, daysOfWeek }
매주 정해진 요일에 정산

매주 정해진 요일에 정산

PlatformSettlementCycleMethodWeeklyInput: { daysOfWeek }
PlatformSettlementCycleMethodWeeklyInput
PlatformSettlementCycleType: "DAILY" | "WEEKLY" | "MONTHLY" | ...
플랫폼 정산 주기 계산 방식

플랫폼 정산 주기 계산 방식

RecoverPlatformAdditionalFeePolicyError: ForbiddenError | InvalidRequestError | PlatformAdditionalFeePolicyNotFoundError | ...
RecoverPlatformAdditionalFeePolicyError
RecoverPlatformAdditionalFeePolicyResponse: { additionalFeePolicy }
추가 수수료 정책 복원 성공 응답

추가 수수료 정책 복원 성공 응답

RecoverPlatformContractError: ForbiddenError | InvalidRequestError | PlatformContractNotFoundError | ...
RecoverPlatformContractError
RecoverPlatformContractResponse: { contract }
계약 복원 성공 응답

계약 복원 성공 응답

RecoverPlatformDiscountSharePolicyError: ForbiddenError | InvalidRequestError | PlatformDiscountSharePolicyNotFoundError | ...
RecoverPlatformDiscountSharePolicyError
RecoverPlatformDiscountSharePolicyResponse: { discountSharePolicy }
할인 분담 복원 성공 응답

할인 분담 복원 성공 응답

UnauthorizedError: { type, message }
인증 정보가 올바르지 않은 경우

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

UpdatePlatformAdditionalFeePolicyBody: { fee, name, memo, ... }
추가 수수료 정책 업데이트를 위한 입력 정보

값이 명시하지 않은 필드는 업데이트되지 않습니다.

UpdatePlatformAdditionalFeePolicyError: ForbiddenError | InvalidRequestError | PlatformAdditionalFeePolicyNotFoundError | ...
UpdatePlatformAdditionalFeePolicyError
UpdatePlatformAdditionalFeePolicyResponse: { additionalFeePolicy }
추가 수수료 정책 업데이트 성공 응답

추가 수수료 정책 업데이트 성공 응답

UpdatePlatformContractBody: { name, memo, platformFee, ... }
계약 업데이트를 위한 입력 정보. 값이 명시되지 않은 필드는 업데이트되지 않습니다.

값이 명시되지 않은 필드는 업데이트되지 않습니다.

UpdatePlatformContractError: ForbiddenError | InvalidRequestError | PlatformArchivedContractError | ...
UpdatePlatformContractError
UpdatePlatformContractResponse: { contract }
계약 객체 업데이트 성공 응답

계약 객체 업데이트 성공 응답

UpdatePlatformDiscountSharePolicyBody: { name, partnerShareRate, memo }
할인 분담 정책 업데이트를 위한 입력 정보

값이 명시되지 않은 필드는 업데이트하지 않습니다.

UpdatePlatformDiscountSharePolicyError: ForbiddenError | InvalidRequestError | PlatformArchivedDiscountSharePolicyError | ...
UpdatePlatformDiscountSharePolicyError
UpdatePlatformDiscountSharePolicyResponse: { discountSharePolicy }
할인 분담 정책 업데이트 성공 응답

할인 분담 정책 업데이트 성공 응답