웹훅 스키마

​

Schema

​

Subscription

• SubscriptionPaymentMethod paymentMethod 필드에는 SubscriptionPaymentMethod 객체 포함되어 있습니다. 이 객체의 구조는 다음과 같습니다.

  변수명	타입	설명	Nullable
  paymentGateway	PaymentGateway	사용한 PG (허용 값) - DANAL: 다날 - KAKAO: 카카오페이 - KG: KG이니시스 - NICE: 나이스페이 - GOOGLE: 구글플레이 - BANKPAY (deprecated, “뱅크페이”로 변경된 BLUE_WALNUT을 사용하세요.): 뱅크페이 - BLUEWALNUT: 블루월넛 - KSNET: KSNET - TOSS: 토스 - EXIMBAY: 엑심베이 - SETTLE: 세틀뱅크 - NICE_V2: 나이스페이 v2 - STRIPE: 스트라이프 - PAYPLE: 페이플 - PAYPLE_GLOBAL: 페이플 글로벌 - UNKNOWN: 알 수 없음	Yes
  paymentInfo	String	결제수단 정보(카드번호 등)	Yes

• SubscriptionItem items 필드에는 SubscriptionItem 객체의 배열이 포함되어 있습니다. 이 객체의 구조는 다음과 같습니다.

  변수명	타입	설명	Nullable
  subscriptionItemId	Long	구독 항목 번호	No
  productName	String	상품명	No
  featuredImageUrl	String	이미지 URL	Yes
  selectedProductOptionIds	List (Long)	선택한 옵션 번호 목록	No
  price	Decimal	가격	No
  quantity	Int	수량	No
  isAdditional	Boolean	추가 구매 상품인지 여부	No
  keepWhenRenew	Boolean	갱신될 때 유지되는 항목인지 여부	No
  maximumPurchaseQuantity	Int	최대 구매 가능 수량	Yes
  productCode	String	상품 코드	Yes
  priceCode	String	가격 플랜 코드	Yes
  type	OrderItemType	OrderItemType: 항목 유형 - SKU: 재고관리 상품 - TAX: 세금 - SHIPPING: 배송비 - DISCOUNT: 할인 - OFFLINE: POS 연동 - FEE: 기타 요금(도입비, 기본료 등) - ADDS: 아이템 추가/삭제 시 정산용 추가값	No
  claimMethodType	ClaimMethodType	선불인지 후불인지 정보 - PRE: 선불 - POST: 후불	Yes
  priceType	PriceType	PriceType: 가격 유형 - ONE_TIME: 단건 상품, 1회성 구매 - FLAT: 구독, 정액제 템플릿 - UNIT_BASED: 건당 과금 템플릿 - USAGE_BASED: 사용량 기반 - BUNDLE: 번들 가격 플랜	No
  selectedOptions	List (Long)	선택된 옵션 번호	No

• Period trialPeriod , currentPeriod 필드에는 Period 객체가 포함되어 있습니다. 이 객체의 구조는 다음과 같습니다.

  변수명	타입	설명	Nullable
  startDateTime	LocalDateTime	시작 시점	No
  endDateTime	LocalDateTime	끝 시점	No

​

Usage

• recordQuotas recordQuotas 필드에는 객체의 배열이 포함되어 있습니다. 이 객체의 구조는 다음과 같습니다.

  변수명	타입	설명	Nullable
  id	Long	사용량 기록 번호	No
  deltaQuota	Long	Quota 증감량	No
  deltaRecord	Long	Record 증감량	No
  accumulateQuota	Long	해당 시점의 누적 Quota (후불 일 경우 null)	Yes
  accumulateRecord	Long	해당 시점의 누적 Record	No
  influxDate	LocalDateTime	기록시간	No
  via	Actor	Actor: 기록 주체 (허용 값) - V1: API로 기록 시 - MANAGER: 포탈에서 기록 시 - SYSTEM: 최초 구독 생성 및 갱신 결제 시 - CUSTOMER: 구독매니저에서 변경 시	No

• JSON Example

{
  "id": 1,
  "subscriptionItemId": 1,
  "accumulatedRecord": 1000,
  "recordQuotas": [
    {
      "id": 1,
      "deltaRecord": 0,
      "influxDate": "2023-07-07T01:35:42",
      "accumulateRecord": 0,
      "via": "SYSTEM"
    },
    {
      "id": 2,
      "deltaRecord": 1000,
      "influxDate": "2023-07-07T02:38:47",
      "accumulateRecord": 1000,
      "via": "MANAGER"
    }
  ]
}

​

Invoice

​

 Order

• Shipping shipping 필드에는 Shipping 객체가 포함됩니다. 이 객체의 구조는 다음과 같습니다.

  변수명	타입	설명	Nullable
  name	String	수령인 이름	No
  phone	String	수령인 전화번호	No
  postcode	String	우편번호	No
  address1	String	주소	No
  address2	String	세부 주소	No
  state	String	주 정보	Yes
  city	String	도시 정보	Yes
  countryCode	String	국가 코드	Yes

• OrderItem items 필드에는 OrderItem 객체의 배열이 포함되어 있습니다. 이 객체의 구조는 다음과 같습니다.

  변수명	타입	설명	Nullable
  id	Long	주문 항목 번호	No
  code	String	주문 항목 코드	No
  type	OrderItemType	OrderItemType: 주문 항목 유형 (허용 값) - SKU: 재고관리 상품 - TAX: 세금 - SHIPPING: 배송비 - DISCOUNT: 할인 - OFFLINE: POS 연동 - FEE: 기타 요금(도입비, 기본료 등) - ADDS: 아이템 추가/삭제 시 정산용 추가값	Yes
  status	OrderItemStatus	OrderItemStatus: 주문 항목 상태 (허용 값) - CREATED: 결제 대기중 - DEPOSIT_WAITING: 입금 대기 - CANCELLED: 취소 완료 - PAID: 결제 완료 - CANCELLATION_REQUEST: 취소 요청 - CANCELLATION_REQUEST_CANCELLED: 취소 요청 취소 - CANCELLATION_REQUEST_DENIED: 취소 요청 거부 - CANCELLATION_REFUNDING: 환불 진행 중 - CANCELLATION_REFUNDED: 전액 환불 - CANCELLATION_REFUNDED_PARTIALLY: 부분 환불 - ORDER_DELIVERY_PREPARING: 배송 준비 중 - ORDER_DELIVERY_SUSPENDED: 배송 준비 중 중지하고 취소로 갈 경우 - ORDER_DELIVERY_ON_THE_WAY: 배송 중 - ORDER_DELIVERY_COMPLETED: 배송 완료 - EXCHANGE_REQUEST: 교환 요청 - EXCHANGE_REQUEST_CANCELLED: 교환 요청 취소 - EXCHANGE_REQUEST_REJECTED: 교환 요청 거부 - EXCHANGE_COLLECTION_PREPARING: 수거 준비중 - EXCHANGE_COLLECTION_ON_THE_WAY: 교환 수거중 - EXCHANGE_COLLECTION_COMPLETED: 교환 수거 완료 - EXCHANGE_DELIVERY_PREPARING: 교환 재배송 준비중 - EXCHANGE_DELIVERY_ON_THE_WAY: 교환 재배송 진행중 - EXCHANGE_DELIVERY_COMPLETED: 교환 재배송 완료 - EXCHANGE_REJECT_DELIVERY_PREPARING: 교환 재배송 준비중 - EXCHANGE_REJECT_DELIVERY_ON_THE_WAY: 교환 재배송 진행중 - EXCHANGE_REJECT_DELIVERY_COMPLETED: 교환 재배송 완료 - EXCHANGE_PENDING: 교환 보류 - EXCHANGE_REJECTED: 교환 거부 - RETURN_REQUEST: 반품 요청 - RETURN_REQUEST_CANCELLED: 반품 요청 취소 - RETURN_REQUEST_REJECTED: 반품 요청 거부 - RETURN_COLLECTION_PREPARING: 수거 준비중 - RETURN_COLLECTION_ON_THE_WAY: 반품 수거중 - RETURN_COLLECTION_COMPLETED: 반품 수거 완료 - RETURN_REJECT_DELIVERY_PREPARING: 반품 재배송 준비중 - RETURN_REJECT_DELIVERY_ON_THE_WAY: 반품 재배송 진행중 - RETURN_REJECT_DELIVERY_COMPLETED: 반품 재배송 완료 - RETURN_PENDING: 반품 보류 - RETURN_REJECTED: 반품 거부 - RETURN_REFUNDING: 환불 진행중 - RETURN_REFUNDED: 환불 완료 - RETURN_REFUNDED_PARTIALLY: 부분 환불 - PAYMENT_FAILURE: 결제 실패 - FINISHED_EXCHANGE_AVAILABLE: 교환/반품 가능 1주일 - FINISHED_RETURN_AVAILABLE: 교환/반품 가능 1개월 - FINISHED_SUCCESSFULLY: 구매 완료	No
  createdAt	LocalDateTime	생성된 시점	Yes
  modifiedAt	LocalDateTime	수정된 시점	Yes
  canceledDateTime	LocalDateTime	취소 시점	Yes
  paidAmount	Decimal	결제 금액	No
  currency	String	통화 코드	No
  quantity	Int	수량	No
  priceCode	String	가격 플랜 코드	Yes
  productCode	String	상품 코드	Yes
  productType	ProductType	주문 시점의 상품 타입 ProductType: 제품 유형 (허용 값) - BOX: 배송상품 - SOFTWARE: 무형의 상품(서비스 포함) - BUNDLE: 포함해서 판매하는 상품 (배송이 필요할 수도, 필요하지 않을 수도 있음. 현재 사용되지 않음.) - INVOICE: 청구서 페이지에서 생성될 때 설정되는 상품 유형 - DRAFT: 초안	No
  productName	String	주문 시점의 상품 이름	No
  featuredImageUrl	String	상품 이미지 URL	Yes
  selectedProductOptionLabel	String	선택한 상품 옵션	Yes
  selectedProductOptionIds	List (Long)	선택한 옵션 ID 목록	No
  planName	String	주문 시점의 가격 플랜 이름	No
  discountName	String	할인 타입(주문 항목 타입이 DISCOUNT인 경우)	Yes
  relatedOrderItemId	Long	연관된 주문 항목 (주문 항목 타입이 DISCOUNT인 경우)	Yes
  priceSetupType	PriceOptionType	기본료 주문 항목인 경우 1회 또는 정기적으로 구분하는 타입 PriceOptionType: 가격 옵션 유형 (허용 값) - INITIALLY: 1회 - PERIODIC: 주기적	Yes
  demoCycle	DemoCycle	무료체험이 적용됐는지 적용 여부 및 기간 (하단 참조)	Yes
  minimumQuantity	Int	최소 구매 가능 수량	Yes
  parentOrderItemCode	String	파생 주문 아이템의 부모(번들) 주문 아이템 코드	Yes

• demoCycle 필드에는 demoCycle 객체가 포함됩니다. 이 객체의 구조는 다음과 같습니다.

​

Payment

• Payer payer필드에는 Payer객체가 포함됩니다. 이 객체의 구조는 다음과 같습니다.

  변수명	타입	설명	Nullable
  userName	String	결제자 명	Yes
  email	String	결제자 이메일	Yes
  phone	String	결제자 휴대폰번호	Yes

• VBank

  변수명	타입	설명	Nullable
  bankCode	String	은행 코드	Yes
  bankName	String	은행 명	No
  accountNumber	String		No
  accountName	String		No
  bankDate	LocalDateTime		No

• NiceCms

• Cancel

  변수명	타입	설명	Nullable
  canceledAmount	Decimal	취소 금액	No
  lastCanceledDate	LocalDateTime	최종 취소 일시	Yes

​

Customer

• Shipping shipping 필드에는 Shipping 객체가 포함됩니다. 이 객체의 구조는 다음과 같습니다.

  변수명	타입	설명	Nullable
  name	String	수령인 이름	No
  phone	String	수령인 전화번호	No
  postcode	String	우편번호	No
  address1	String	주소	No
  address2	String	세부 주소	No
  state	String	주 정보	Yes
  city	String	도시 정보	Yes
  countryCode	String	국가 코드	Yes

​

Product

• ProductCategory categories 필드에는 ProductCategory 객체가 포함됩니다. 이 객체의 구조는 다음과 같습니다.

  변수명	타입	설명	Nullable
  categoryId	Long	카테고리 번호	No
  name	String	카테고리 이름	No

• ProductOptionGroup optionGroups 필드에는 ProductOptionGroup 객체가 포함됩니다. 이 객체의 구조는 다음과 같습니다.

  변수명	타입	설명	Nullable
  id	Long	옵션 그룹 번호	No
  name	String	옵션 그룹 이름	No
  options	List (ProductOption)	옵션 리스트	No

  • ProductOption options 필드에는 ProductOption 객체가 포함됩니다. 이 객체의 구조는 다음과 같습니다.

    변수명	타입	설명	Nullable
    id	Long	옵션 번호	No
    name	String	옵션 이름	No
    quantity	Int	수량	Yes
    price	Decimal	가격	No

​

Price

• SetupOption setupOption 필드에는 SetupOption 객체가 포함됩니다. 이 객체의 구조는 다음과 같습니다.

  Field Name	Type	Description	Nullable
  id	Long	기본료 번호	No
  name	String	기본료 이름	Yes
  type	PriceOptionType	기본료 타입 - INITIALLY: 최초 1회 - PERIODIC: 정기적	Yes
  price	Long	기본료 금액	No
  claimMethodType	ClaimMethodType	선불/후불 - PRE: 선불 - POST: 후불	No

• PriceAdditionalBilling additionalBilling 필드에는 PriceAdditionalBilling 객체가 포함됩니다. 이 객체의 구조는 다음과 같습니다.

  Field Name	Type	Description	Nullable
  id	Long	추가 과금 번호	No
  type	AdditionalBillingType	AdditionalBillingType: 추가 과금 유형 (허용 값) USAGE_BASED_WITH_RANGE: 구간별 건당 과금 USAGE_BASED_WITH_RANGE_AND_FIXED_PRICE: 구간별 고정 금액	No
  ranges	List (PriceAdditionalBillingRange)	추가 과금 범위 정보 (하단참조)	No

• PriceAdditionalBillingRange ranges 필드에는 PriceAdditionalBillingRange 객체가 포함됩니다. 이 객체의 구조는 다음과 같습니다.

  Field Name	Type	Description	Nullable
  id	Long	추가 과금 범위 번호	Yes
  until	Long	범위가 어디까지인지	Yes
  price	Decimal	범위에 적용되는 금액	Yes

• Interval recurring 필드에는 Interval 객체가 포함됩니다. 이 객체의 구조는 다음과 같습니다.

  Field Name	Type	Description	Nullable
  unit	DateUnitType	주기 단위 DateUnitType: 날짜 단위 타입 (허용 값) - DAY: 일 - WEEK: 주 - MONTH: 개월 - YEAR: 년	Yes
  count	Int	주기	Yes

• Plan plan 필드에는 Plan 객체가 포함됩니다. 이 객체의 구조는 다음과 같습니다.

  Field Name	Type	Description	Nullable
  name	String	플랜 이름	No
  description	String	플랜 설명	No
  detailDescription	String	자세히 보기	Yes
  isHiddenFromShop	Boolean	플랜 사용 여부	No
  adminName	String	어드민 플랜 이름	Yes

• Claim claim 필드에는 Claim 객체가 포함됩니다. 이 객체의 구조는 다음과 같습니다.

  Field Name	Type	Description	Nullable
  methodType	ClaimMethodType	선불/후불	No
  whenToClaimType	WhenToClaimType	후불인 경우, 청구 시점 - FIRST_PAYMENT: 최초 결제일 기준 반복 - DATE: 결제일 지정	No
  billingDate	Int	청구 시점 내 날짜 (익월 n일)	No
  provideStartDay	Int	서비스 제공 시작일	Yes

• PriceBundle bundlePrices 필드에는 PriceBundle 객체가 포함됩니다. 이 객체의 구조는 다음과 같습니다.

  Field Name	Type	Description	Nullable
  productCode	String	상품 코드	Yes
  priceCode	String	플랜 코드	Yes

​

Cover