VCVCMS API Corpus

쿼리 레퍼런스

전체 86개 쿼리를 도메인별로 정리했습니다. 인자, 반환 타입, 필수 여부를 인라인으로 확인할 수 있습니다.

accommodation

숙소 관리 (3)

readAccommodation

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: Accommodation

인자타입필수
idULID!

readAccommodationForIntegration

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: AccommodationForIntegration

인자타입필수
idULID!

readAccommodations

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [Accommodation!]!목록

인자타입필수
userIdULID
audit

감사 로그 (2)

readAudits

@roleGuard(role: ADMIN, access: READ): Only the user with the role of 'ADMIN' and the access permission of 'READ' can access this object (field).

반환: AuditConnection! · 페이지네이션: cursor

인자타입필수
firstInt
lastInt
afterString
beforeString
skipInt
takeInt
filtersAuditFilters
ordersAuditOrders
accommodationIdULID

readRecentInviteUserAuditsByActorId

@roleGuard(role: MANAGER, access: READ): Only the user with the role of 'MANAGER' and the access permission of 'READ' can access this object (field).

반환: [Audit!]!목록

인자타입필수
actorIdULID!
timeInt!
billing

빌링 및 결제 (6)

previewSubscriptionBilling

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: SubscriptionBillingPreview!

인자타입필수
billingQuotas[BillingQuotaInput!]!
paymentCurrencyBillingCurrency!
accommodationIdULID

readBilling

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: Billing!

인자타입필수
typeBillingType
accommodationIdULID

readBillingDiscountAllocations

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [BillingDiscountAllocation!]!목록

인자타입필수
accommodationIdULID

readBillingDiscounts

@roleGuard(role: ROOT, access: READ): Only the user with the role of 'ROOT' and the access permission of 'READ' can access this object (field).

반환: [BillingDiscount!]!목록

인자타입필수
isActiveBoolean

readBillingPaymentMethods

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [BillingPaymentMethod!]!목록

인자타입필수
accommodationIdULID

readBillingTransactions

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: BillingTransactionConnection! · 페이지네이션: cursor

인자타입필수
billingIdULID!
firstInt
lastInt
afterString
beforeString
skipInt
takeInt
filtersBillingTransactionFilters
ordersBillingTransactionOrders
booking

예약 관리 (13)

checkBookingExists

@roleGuard(role: ROOT, access: READ): Only the user with the role of 'ROOT' and the access permission of 'READ' can access this object (field).

반환: [BookingExistence!]!목록

인자타입필수
identifiers[String!]!
accommodationIdULID!

countBookings

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: Int!

인자타입필수
accommodationIdULID!
stayTypeStayType!
startDateDateTime!
endDateDateTime!

countBookingsForIntegration

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: Int!

인자타입필수
accommodationIdULID!
stayTypeStayType!
startDateDateTime!
endDateDateTime!

readBooking

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: Booking

인자타입필수
idULID!

readBookingForIntegration

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: BookingForIntegration

인자타입필수
idULID!

readBookingUpdateHistories

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [BookingUpdateHistory!]!목록

인자타입필수
bookingIdULID!

readBookingUpdateHistoriesForIntegration

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [BookingUpdateHistoryForIntegration!]!목록

인자타입필수
bookingIdULID!

readBookings

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: BookingConnection! · 페이지네이션: cursor

인자타입필수
firstInt
lastInt
afterString
beforeString
skipInt
takeInt
filtersBookingFilters
orders[BookingOrders!]
accommodationIdULID

readBookingsByIdentifiers

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [Booking!]!목록

인자타입필수
identifiers[String!]!
accommodationIdULID!

readBookingsByIdentifiersForIntegration

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [BookingForIntegration!]!목록

인자타입필수
identifiers[String!]!
accommodationIdULID!

readBookingsByPartialIdentifier

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [Booking!]!목록

인자타입필수
identifierString!
accommodationIdULID!

readBookingsByPartialIdentifierForIntegration

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [BookingForIntegration!]!목록

인자타입필수
identifierString!
accommodationIdULID!

readBookingsForIntegration

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: BookingConnectionForIntegration!

인자타입필수
firstInt
lastInt
afterString
beforeString
skipInt
takeInt
filtersBookingFilters
orders[BookingOrders!]
accommodationIdULID
channel

채널 연동 (12)

readAvailableChannelProperties

@roleGuard(role: ROOT, access: READ): Only the user with the role of 'ROOT' and the access permission of 'READ' can access this object (field).

반환: [ChannelProperty!]!목록

readChannelAccount

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: ChannelAccount!

인자타입필수
idULID!
aggregatePropertiesBoolean

readChannelAccounts

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [ChannelAccount!]!목록

인자타입필수
accommodationIdULID
aggregatePropertiesBoolean

readChannelPackage

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: ChannelPackage!

인자타입필수
idULID!

readChannelPackageByUnique

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: ChannelPackage!

인자타입필수
identifierString!
stayTypeStayType!
channelPropertyIdULID!
accommodationIdULID!

readChannelPackageForIntegration

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: ChannelPackageForIntegration!

인자타입필수
idULID!

readChannelPackages

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [ChannelPackage!]!목록

인자타입필수
packageIdULID
channelPropertyIdULID
accommodationIdULID
includeIntegrationBoolean
isHiddenBoolean

readChannelProperties

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [ChannelProperty!]!목록

인자타입필수
channelAccountIdULID
accommodationIdULID

readChannelPropertiesByChannelKeyAndCredential

@roleGuard(role: ROOT, access: READ): Only the user with the role of 'ROOT' and the access permission of 'READ' can access this object (field).

반환: [ChannelProperty!]!목록

인자타입필수
channelKeyString!
credentialJSON!

readChannels

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [Channel!]!목록

readConnectedChannelAccounts

@roleGuard(role: ROOT, access: READ): Only the user with the role of 'ROOT' and the access permission of 'READ' can access this object (field).

반환: [ChannelAccount!]!목록

인자타입필수
aggregatePropertiesBoolean

readPendingChannelAccounts

@roleGuard(role: ROOT, access: READ): Only the user with the role of 'ROOT' and the access permission of 'READ' can access this object (field).

반환: [ChannelAccount!]!목록

인자타입필수
aggregatePropertiesBoolean
currency

통화 관리 (2)

readCurrencies

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [CurrencySet!]!목록

인자타입필수
timezoneTimeZone

readCurrencyExchange

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: CurrencyExchange!

인자타입필수
currencyCurrency!
inclusion

포함 항목 (2)

readInclusions

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [Inclusion!]!목록

인자타입필수
accommodationIdULID
tags[ULID!]

readInclusionsForIntegration

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [InclusionForIntegration!]!목록

인자타입필수
accommodationIdULID
tags[ULID!]
integration

외부 연동 (5)

readIntegration

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: Integration!

인자타입필수
idULID!

readIntegrationAdapterForIntegration

@roleGuard(role: ADMIN, access: READ): Only the user with the role of 'ADMIN' and the access permission of 'READ' can access this object (field).

반환: IntegrationAdapter!

인자타입필수
idULID!

readIntegrationAdapters

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [IntegrationAdapter!]!목록

인자타입필수
accommodationIdULID

readIntegrationByReference

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: Integration!

인자타입필수
aggregateIntegrationAggregate!
keyString!

readIntegrations

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [Integration!]!목록

인자타입필수
aggregateIntegrationAggregate
inventory

재고 관리 (5)

readCalculatedInventories

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [CalculatedInventory!]!목록

인자타입필수
startDateLocalDate!
endDateLocalDate
daysOfWeek[DayOfWeek!]
countInt
includeChannelPackageBoolean
accommodationIdULID
stayTypeStayType

readCalculatedInventoriesForIntegration

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [CalculatedInventory!]!목록

인자타입필수
startDateLocalDate!
endDateLocalDate
daysOfWeek[DayOfWeek!]
countInt
includeChannelPackageBoolean
accommodationIdULID
stayTypeStayType

readInventories

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [Inventory!]!목록

인자타입필수
startDateLocalDate!
endDateLocalDate!
accommodationIdULID

readInventory

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: Inventory!

인자타입필수
startDateLocalDate!
endDateLocalDate!
idULID!
accommodationIdULID

readInventoryByRoomTypeId

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: Inventory!

인자타입필수
startDateLocalDate!
endDateLocalDate!
roomTypeIdULID!
accommodationIdULID
notification

알림 (3)

readNotificationAlarmHistories

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: NotificationAlarmHistoryConnection! · 페이지네이션: cursor

인자타입필수
notificationAlarmIdULID!
firstInt
lastInt
afterString
beforeString
skipInt
takeInt
filtersNotificationAlarmHistoryFilters
ordersNotificationAlarmHistoryOrders

readNotificationAlarms

@roleGuard(role: MANAGER, access: READ): Only the user with the role of 'MANAGER' and the access permission of 'READ' can access this object (field).

반환: [NotificationAlarm!]!목록

인자타입필수
accommodationIdULID

readNotifications

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: NotificationConnection! · 페이지네이션: cursor

인자타입필수
firstInt
lastInt
afterString
beforeString
skipInt
takeInt
filtersNotificationFilters
ordersNotificationOrders
accommodationIdULID
package

패키지 관리 (5)

readPackage

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: Package!

인자타입필수
idULID!

readPackageForIntegration

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: PackageForIntegration!

인자타입필수
idULID!

readPackageTimeTables

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [PackageTimeTable!]!목록

인자타입필수
accommodationIdULID

readPackages

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [Package!]!목록

인자타입필수
accommodationIdULID
includeIntegrationBoolean

readPackagesForIntegration

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [PackageForIntegration!]!목록

인자타입필수
accommodationIdULID
period

기간 설정 (1)

readPeriods

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [Period!]!목록

인자타입필수
accommodationIdULID
policy

정책 관리 (2)

readPolicies

@roleGuard(role: MANAGER, access: READ): Only the user with the role of 'MANAGER' and the access permission of 'READ' can access this object (field).

반환: [Policy!]!목록

인자타입필수
accommodationIdULID

readPolicy

@roleGuard(role: MANAGER, access: READ): Only the user with the role of 'MANAGER' and the access permission of 'READ' can access this object (field).

반환: Policy

인자타입필수
idULID!
rate

요금 관리 (8)

readCalculatedRates

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [CalculatedRate!]!목록

인자타입필수
accommodationIdULID
startDateLocalDate!
endDateLocalDate
daysOfWeek[DayOfWeek!]
countInt
includeChannelPackageBoolean
stayTypeStayType

readCalculatedRatesForIntegration

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [CalculatedRate!]!목록

인자타입필수
accommodationIdULID
startDateLocalDate!
endDateLocalDate
daysOfWeek[DayOfWeek!]
countInt
includeChannelPackageBoolean
stayTypeStayType

readRateChannelPackageAdjustment

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: RateChannelPackageAdjustment!

인자타입필수
idULID!

readRatePackageAdjustment

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: RatePackageAdjustment!

인자타입필수
idULID!

readRatePlan

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: RatePlan!

인자타입필수
idULID!

readRatePlans

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [RatePlan!]!목록

인자타입필수
accommodationIdULID

readRates

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [Rate!]!목록

인자타입필수
accommodationIdULID

readRatesByCurrency

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [Rate!]!목록

인자타입필수
currencyCurrency!
accommodationIdULID
role

역할 및 권한 (2)

readRole

@roleGuard(role: MANAGER, access: READ): Only the user with the role of 'MANAGER' and the access permission of 'READ' can access this object (field).

반환: Role!

인자타입필수
idULID!

readRoles

@roleGuard(role: MANAGER, access: READ): Only the user with the role of 'MANAGER' and the access permission of 'READ' can access this object (field).

반환: [Role!]!목록

인자타입필수
accommodationIdULID
room

객실 관리 (3)

readRoomType

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: RoomType!

인자타입필수
idULID!

readRoomTypes

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [RoomType!]!목록

인자타입필수
accommodationIdULID

readRoomTypesForIntegration

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [RoomTypeForIntegration!]!목록

service

부가 서비스 (2)

readServiceItemFigures

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [ServiceItemFigure!]!목록

readServiceKeys

@roleGuard(role: ROOT, access: READ): Only the user with the role of 'ROOT' and the access permission of 'READ' can access this object (field).

반환: [JSON!]!목록

tag

태그 관리 (2)

readInclusionTags

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [Tag!]!목록

인자타입필수
accommodationIdULID
inclusionIdULID

readTags

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: [Tag!]!목록

인자타입필수
accommodationIdULID
user

사용자 관리 (8)

readInvitations

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: InvitedUser!

인자타입필수
userIdULID

readInvitedUsers

@roleGuard(role: MANAGER, access: READ): Only the user with the role of 'MANAGER' and the access permission of 'READ' can access this object (field).

반환: [InvitedUser!]!목록

인자타입필수
accommodationIdULID

readUser

@roleGuard(role: USER, access: READ): Only the user with the role of 'USER' and the access permission of 'READ' can access this object (field).

반환: User!

인자타입필수
idULID!

readUsers

@roleGuard(role: MANAGER, access: READ): Only the user with the role of 'MANAGER' and the access permission of 'READ' can access this object (field).

반환: [User!]!목록

인자타입필수
accommodationIdULID

verifyEmail

반환: Boolean!

인자타입필수
emailString!
isUnsetBoolean

verifyPhone

반환: Boolean!

인자타입필수
phoneString!
isUnsetBoolean

verifyRefreshToken

반환: JSON!

인자타입필수
refreshTokenJWT!

verifyToken

반환: JSON!

인자타입필수
tokenJWT!