개발자센터

인보이스 메일 템플릿 API

고객에게 보내는 인보이스 메일의 발신자 정보와 로고, 보낼 메일 유형에 관한 API 입니다.

상점의 인보이스 메일 템플릿 리스트를 조회합니다.

인보이스 메일 템플릿을 생성합니다. 생성한 템플릿은 비활성 상태입니다.

주어진 아이디로 인보이스 메일 템플릿을 조회합니다.

인보이스 메일 템플릿을 삭제합니다. 활성 템플릿은 비활성화한 뒤 삭제할 수 있습니다.

인보이스 메일 템플릿을 수정합니다. 입력하지 않은 필드는 기존 값을 유지합니다.

템플릿을 활성화합니다. 상점의 다른 활성 템플릿은 비활성화됩니다.

템플릿을 비활성화합니다. 활성 템플릿이 없으면 인보이스 메일을 보내지 않습니다.

타입 정의

API 요청/응답의 각 필드에서 사용되는 타입 정의들을 확인할 수 있습니다
ActivateSubscriptionInvoiceEmailTemplateError: ForbiddenError | InvalidRequestError | SubscriptionInvoiceEmailTemplateNotFoundError | ...
ActivateSubscriptionInvoiceEmailTemplateResponse: { invoiceEmailTemplate }
인보이스 메일 템플릿 활성화 성공 응답
CreateSubscriptionInvoiceEmailTemplateBody: { storeId, name, logoImageUrl, ... }
인보이스 메일 템플릿 생성 입력 정보
CreateSubscriptionInvoiceEmailTemplateError: ForbiddenError | InvalidRequestError | UnauthorizedError
CreateSubscriptionInvoiceEmailTemplateResponse: { invoiceEmailTemplate }
인보이스 메일 템플릿 생성 성공 응답
DeactivateSubscriptionInvoiceEmailTemplateError: ForbiddenError | InvalidRequestError | SubscriptionInvoiceEmailTemplateNotFoundError | ...
DeactivateSubscriptionInvoiceEmailTemplateResponse: { invoiceEmailTemplate }
인보이스 메일 템플릿 비활성화 성공 응답
DeleteSubscriptionInvoiceEmailTemplateError: ForbiddenError | InvalidRequestError | SubscriptionInvoiceEmailTemplateActiveError | ...
DeleteSubscriptionInvoiceEmailTemplateResponse: { invoiceEmailTemplateId }
인보이스 메일 템플릿 삭제 성공 응답
ForbiddenError: { type, message }
요청이 거절된 경우
GetSubscriptionInvoiceEmailTemplateError: ForbiddenError | InvalidRequestError | SubscriptionInvoiceEmailTemplateNotFoundError | ...
GetSubscriptionInvoiceEmailTemplateResponse: { invoiceEmailTemplate }
인보이스 메일 템플릿 조회 성공 응답
GetSubscriptionInvoiceEmailTemplatesBody: { storeId, page }
인보이스 메일 템플릿 다건 조회 입력 정보
GetSubscriptionInvoiceEmailTemplatesError: ForbiddenError | InvalidRequestError | UnauthorizedError
GetSubscriptionInvoiceEmailTemplatesResponse: { items, page }
인보이스 메일 템플릿 다건 조회 성공 응답
InvalidRequestError: { type, message }
요청된 입력 정보가 유효하지 않은 경우

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

PageInfo: { number, size, totalCount }
반환된 페이지 결과 정보
PageInput: { number, size }
다건 조회 API 에 사용되는 페이지 입력 정보
SubscriptionInvoiceEmailEventType: "PAID" | "REFUNDED"
인보이스 메일 유형
SubscriptionInvoiceEmailSender: { companyName, businessRegistrationNumber, address, ... }
인보이스 메일 발신자 정보

메일 본문 하단에 표시됩니다. 이메일은 회신 주소로도 씁니다.

SubscriptionInvoiceEmailSenders: { koKr, enUs, jaJp }
메일 언어별 발신자 정보

영어·일본어 정보가 없거나 필드가 비어 있으면 한국어 값을 씁니다.

SubscriptionInvoiceEmailTemplate: { id, name, logoImageUrl, ... }
인보이스 메일 템플릿

상점에 여러 개 둘 수 있고 활성 템플릿은 상점당 하나입니다. 활성 템플릿이 없으면 인보이스 메일을 보내지 않습니다.

SubscriptionInvoiceEmailTemplateActiveError: { type, message }
활성 인보이스 메일 템플릿이라 삭제할 수 없는 경우
SubscriptionInvoiceEmailTemplateNotFoundError: { type, message }
요청된 인보이스 메일 템플릿이 존재하지 않는 경우
UnauthorizedError: { type, message }
인증 정보가 올바르지 않은 경우
UpdateSubscriptionInvoiceEmailTemplateBody: { storeId, name, logoImageUrl, ... }
인보이스 메일 템플릿 수정 입력 정보
UpdateSubscriptionInvoiceEmailTemplateBodySender: { companyName, businessRegistrationNumber, address, ... }
인보이스 메일 발신자 정보 수정 입력

입력한 필드만 고칩니다. null을 보내면 그 필드를 지웁니다.

UpdateSubscriptionInvoiceEmailTemplateBodySenders: { koKr, enUs, jaJp }
메일 언어별 발신자 정보 수정 입력

언어마다 입력한 필드만 고칩니다. 정보가 없던 언어는 입력한 값으로 새로 만듭니다.

UpdateSubscriptionInvoiceEmailTemplateError: ForbiddenError | InvalidRequestError | SubscriptionInvoiceEmailTemplateNotFoundError | ...
UpdateSubscriptionInvoiceEmailTemplateResponse: { invoiceEmailTemplate }
인보이스 메일 템플릿 수정 성공 응답