Start reservation booking workflow
POST
/reservation-booking-workflow-starts
const url = 'https://example.com/reservation-booking-workflow-starts';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"reservationBookingRequestId":"example","branchProfileId":"example","serviceOfferingKey":"example","serviceAddressReferenceId":"example","priceQuoteReference":"example","motherProfile":{"memberId":"example","email":"example","name":"example","phone":"example","birthday":"example"},"serviceAddress":{"sido":"example","sigungu":"example","bname":"example","addressEvidenceSourceKind":"external_lookup","zonecode":"example","roadAddress":"example","jibunAddress":"example","addressLevelDetail":"example","evidencePayloadFingerprint":"example"},"branchContext":{"branchId":1,"branchCode":"example","branchName":"example","headquartersId":1,"branchOperatorId":1,"caregiverIds":[1]},"caregiverCandidates":[{"caregiverId":1,"name":"example","distanceKm":1,"availabilityWindows":[{"startAt":"2026-04-15T12:00:00Z","endAt":"2026-04-15T12:00:00Z"}],"ratingScore":1,"careerMonths":1,"preferenceMatchScore":1,"gradeCode":"example","acceptsPetHousehold":true,"petAllergySpeciesCodes":["example"]}],"caregiverProfiles":[{"caregiverId":"example","active":true,"licenseTitles":["example"],"trainingTopics":["example"],"serviceAreas":[{"addressLevel1":"example","addressLevel2":"example","addressLevel3":"example"}],"unavailableWindows":[{"startAt":"2026-04-15T12:00:00Z","endAt":"2026-04-15T12:00:00Z"}],"ratingScores":[1],"scoreByMember":1}],"careEnvironment":{"pets":[{"speciesCode":"example","count":1,"sizeCode":"example","isolatedFromNewborn":true}]},"serviceStartAt":"2026-04-15T12:00:00Z","serviceEndAt":"2026-04-15T12:00:00Z","paymentMethodCode":"example","serviceTypeDetailId":1,"serviceDay":1,"workingTypeId":1,"serviceDayListId":1,"reservationAmountHint":1,"selectedCaregiverId":1,"acceptedPriceCatalogQuote":{"catalogCode":"example","versionLabel":"example","entryCode":"example","program":"voucher_care","serviceTierCode":"example","serviceTierName":"example","serviceDayCount":1,"quotedOn":"2026-04-15","grossServiceAmountKrw":1,"customerPayableAmountKrw":1,"customerSubsidyAmountKrw":1,"customerCreditAmountKrw":1,"caregiverCompensationAmountKrw":1,"branchSettlementAmountKrw":1,"platformFeeAmountKrw":1,"lines":[{"componentCode":"example","componentName":"example","role":"customer_charge","basis":"per_reservation","amountKrw":1,"quantity":1}]},"acceptedRegionalBenefitDecision":{"lines":[{"benefitCode":"example","displayName":"example","amountComponentCode":"example","amountComponentLabel":"example","discountAmountKrw":1,"regionalBenefitProfileKey":"example","sourceEvidenceKey":"example","serviceDayBonusCount":1,"settlementParticipationCode":"example"}]},"acceptedServiceOfferingAvailabilityDecision":{"offeringKey":"example","availabilityState":"available","handoffKind":"pre_reservation_payment","unavailableReasonCodes":["example"],"messageKeys":["example"],"policyRevisionKey":"example","sourceEvidenceKeys":["example"]},"acceptedServiceTermPlan":{"policyKey":"example","serviceStartOn":"2026-04-15","duration":{"quantity":1,"unit":"example","serviceDaysPerWeek":1,"durationProfileKey":"example","serviceWeekProfile":{"profileKey":"example","serviceDaysPerWeek":1,"weekendWorkdayIndexes":[1],"sourceReference":"example"},"sourceReference":"example"},"serviceAreaKey":"example","holidayRegistry":{"entries":[{"holidayKey":"example","calendarProfileKey":"example","observedOn":"2026-04-15","nonWorkingDayKind":"example","serviceAvailableByDefault":true,"substituteOfHolidayKey":"example","sourceReference":"example"}]},"serviceAreaProfiles":{"profiles":[{"profileKey":"example","serviceAreaKey":"example","calendarProfileKey":"example","effectiveFrom":"2026-04-15","effectiveUntil":"2026-04-15","nonWorkingWeekdays":[1],"durationExtensionDays":1,"sourceReference":"example"}]},"selectedAdditionalServiceDays":[{"selectionKey":"example","serviceOn":"2026-04-15","dayKind":"example","sourceReference":"example","chargeable":true}],"sourceReference":"example"},"bookingServiceTermSideEffects":{"acceptedServiceTermSnapshotKey":"example","acceptedServiceTermSnapshotRevision":1,"reservationServiceCalendarQuoteKey":"example","reservationServiceCalendarQuoteRevision":1,"selectedAddOptionSelectionKeys":["example"],"addOptionChargeIntents":[{"addOptionSelectionKey":"example","chargeComponentCode":"example","sourceEvidenceKeys":["example"]}],"consumerImpactFacts":[{"impactFactKey":"example","consumerContextCode":"example","invalidationTargetCode":"example","invalidationTargetReference":"example","reasonCode":"example","sourceProjectionKey":"example","sourceEvidenceKeys":["example"]}],"requiredConsumerContextCodes":["example"],"sourceEvidenceKeys":["example"]}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/reservation-booking-workflow-starts \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "reservationBookingRequestId": "example", "branchProfileId": "example", "serviceOfferingKey": "example", "serviceAddressReferenceId": "example", "priceQuoteReference": "example", "motherProfile": { "memberId": "example", "email": "example", "name": "example", "phone": "example", "birthday": "example" }, "serviceAddress": { "sido": "example", "sigungu": "example", "bname": "example", "addressEvidenceSourceKind": "external_lookup", "zonecode": "example", "roadAddress": "example", "jibunAddress": "example", "addressLevelDetail": "example", "evidencePayloadFingerprint": "example" }, "branchContext": { "branchId": 1, "branchCode": "example", "branchName": "example", "headquartersId": 1, "branchOperatorId": 1, "caregiverIds": [ 1 ] }, "caregiverCandidates": [ { "caregiverId": 1, "name": "example", "distanceKm": 1, "availabilityWindows": [ { "startAt": "2026-04-15T12:00:00Z", "endAt": "2026-04-15T12:00:00Z" } ], "ratingScore": 1, "careerMonths": 1, "preferenceMatchScore": 1, "gradeCode": "example", "acceptsPetHousehold": true, "petAllergySpeciesCodes": [ "example" ] } ], "caregiverProfiles": [ { "caregiverId": "example", "active": true, "licenseTitles": [ "example" ], "trainingTopics": [ "example" ], "serviceAreas": [ { "addressLevel1": "example", "addressLevel2": "example", "addressLevel3": "example" } ], "unavailableWindows": [ { "startAt": "2026-04-15T12:00:00Z", "endAt": "2026-04-15T12:00:00Z" } ], "ratingScores": [ 1 ], "scoreByMember": 1 } ], "careEnvironment": { "pets": [ { "speciesCode": "example", "count": 1, "sizeCode": "example", "isolatedFromNewborn": true } ] }, "serviceStartAt": "2026-04-15T12:00:00Z", "serviceEndAt": "2026-04-15T12:00:00Z", "paymentMethodCode": "example", "serviceTypeDetailId": 1, "serviceDay": 1, "workingTypeId": 1, "serviceDayListId": 1, "reservationAmountHint": 1, "selectedCaregiverId": 1, "acceptedPriceCatalogQuote": { "catalogCode": "example", "versionLabel": "example", "entryCode": "example", "program": "voucher_care", "serviceTierCode": "example", "serviceTierName": "example", "serviceDayCount": 1, "quotedOn": "2026-04-15", "grossServiceAmountKrw": 1, "customerPayableAmountKrw": 1, "customerSubsidyAmountKrw": 1, "customerCreditAmountKrw": 1, "caregiverCompensationAmountKrw": 1, "branchSettlementAmountKrw": 1, "platformFeeAmountKrw": 1, "lines": [ { "componentCode": "example", "componentName": "example", "role": "customer_charge", "basis": "per_reservation", "amountKrw": 1, "quantity": 1 } ] }, "acceptedRegionalBenefitDecision": { "lines": [ { "benefitCode": "example", "displayName": "example", "amountComponentCode": "example", "amountComponentLabel": "example", "discountAmountKrw": 1, "regionalBenefitProfileKey": "example", "sourceEvidenceKey": "example", "serviceDayBonusCount": 1, "settlementParticipationCode": "example" } ] }, "acceptedServiceOfferingAvailabilityDecision": { "offeringKey": "example", "availabilityState": "available", "handoffKind": "pre_reservation_payment", "unavailableReasonCodes": [ "example" ], "messageKeys": [ "example" ], "policyRevisionKey": "example", "sourceEvidenceKeys": [ "example" ] }, "acceptedServiceTermPlan": { "policyKey": "example", "serviceStartOn": "2026-04-15", "duration": { "quantity": 1, "unit": "example", "serviceDaysPerWeek": 1, "durationProfileKey": "example", "serviceWeekProfile": { "profileKey": "example", "serviceDaysPerWeek": 1, "weekendWorkdayIndexes": [ 1 ], "sourceReference": "example" }, "sourceReference": "example" }, "serviceAreaKey": "example", "holidayRegistry": { "entries": [ { "holidayKey": "example", "calendarProfileKey": "example", "observedOn": "2026-04-15", "nonWorkingDayKind": "example", "serviceAvailableByDefault": true, "substituteOfHolidayKey": "example", "sourceReference": "example" } ] }, "serviceAreaProfiles": { "profiles": [ { "profileKey": "example", "serviceAreaKey": "example", "calendarProfileKey": "example", "effectiveFrom": "2026-04-15", "effectiveUntil": "2026-04-15", "nonWorkingWeekdays": [ 1 ], "durationExtensionDays": 1, "sourceReference": "example" } ] }, "selectedAdditionalServiceDays": [ { "selectionKey": "example", "serviceOn": "2026-04-15", "dayKind": "example", "sourceReference": "example", "chargeable": true } ], "sourceReference": "example" }, "bookingServiceTermSideEffects": { "acceptedServiceTermSnapshotKey": "example", "acceptedServiceTermSnapshotRevision": 1, "reservationServiceCalendarQuoteKey": "example", "reservationServiceCalendarQuoteRevision": 1, "selectedAddOptionSelectionKeys": [ "example" ], "addOptionChargeIntents": [ { "addOptionSelectionKey": "example", "chargeComponentCode": "example", "sourceEvidenceKeys": [ "example" ] } ], "consumerImpactFacts": [ { "impactFactKey": "example", "consumerContextCode": "example", "invalidationTargetCode": "example", "invalidationTargetReference": "example", "reasonCode": "example", "sourceProjectionKey": "example", "sourceEvidenceKeys": [ "example" ] } ], "requiredConsumerContextCodes": [ "example" ], "sourceEvidenceKeys": [ "example" ] } }'Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
ReservationBookingWorkflowStartInput
object
sponsoredReservationContractAcceptanceId
string | null
reservationBookingRequestId
required
string
branchProfileId
required
string
serviceOfferingKey
required
string
serviceAddressReferenceId
required
string
priceQuoteReference
required
string
motherProfile
required
object
memberId
required
string
email
required
string
name
required
string
phone
required
string
birthday
required
string
key
additional properties
serviceAddress
required
object
sido
required
string
sigungu
required
string | null
bname
required
string | null
addressEvidenceSourceKind
required
string
zonecode
required
string | null
roadAddress
required
string | null
jibunAddress
required
string | null
addressLevelDetail
required
string | null
evidencePayloadFingerprint
required
string | null
key
additional properties
branchContext
required
object
branchId
required
integer
branchCode
required
string
branchName
required
string
headquartersId
required
integer | null
branchOperatorId
required
integer | null
caregiverIds
required
Array<integer>
key
additional properties
caregiverCandidates
required
Array<object>
object
caregiverId
required
integer
name
required
string
distanceKm
required
number | null
availabilityWindows
required
Array<object>
object
startAt
required
string format: date-time
endAt
required
string format: date-time
key
additional properties
ratingScore
required
number
careerMonths
required
integer
preferenceMatchScore
required
number
gradeCode
required
string | null
acceptsPetHousehold
required
boolean
petAllergySpeciesCodes
required
Array<string>
key
additional properties
caregiverProfiles
required
Array<object>
object
caregiverId
required
string
active
required
boolean
licenseTitles
required
Array<string>
trainingTopics
required
Array<string>
serviceAreas
required
Array<object>
object
addressLevel1
required
string
addressLevel2
required
string
addressLevel3
required
string
key
additional properties
unavailableWindows
required
Array<object>
object
startAt
required
string format: date-time
endAt
required
string format: date-time
key
additional properties
ratingScores
required
Array<number>
scoreByMember
required
number | null
key
additional properties
careEnvironment
required
object
pets
required
Array<object>
object
speciesCode
required
string
count
required
integer
sizeCode
required
string | null
isolatedFromNewborn
required
boolean
key
additional properties
key
additional properties
serviceStartAt
required
string format: date-time
serviceEndAt
required
string format: date-time
paymentMethodCode
required
string
serviceTypeDetailId
required
integer
serviceDay
required
integer
workingTypeId
required
integer
serviceDayListId
required
integer
reservationAmountHint
required
integer
selectedCaregiverId
required
integer
acceptedPriceCatalogQuote
required
object
catalogCode
required
string
versionLabel
required
string
entryCode
required
string
program
required
string
serviceTierCode
required
string
serviceTierName
required
string
serviceDayCount
required
integer
quotedOn
required
string format: date
grossServiceAmountKrw
required
integer
customerPayableAmountKrw
required
integer
customerSubsidyAmountKrw
required
integer
customerCreditAmountKrw
required
integer
caregiverCompensationAmountKrw
required
integer
branchSettlementAmountKrw
required
integer
platformFeeAmountKrw
required
integer
lines
required
Array<object>
object
componentCode
required
string
componentName
required
string
role
required
string
basis
required
string
amountKrw
required
integer
quantity
required
integer
key
additional properties
key
additional properties
acceptedRegionalBenefitDecision
One of:
object
lines
required
Array<object>
object
benefitCode
required
string
displayName
required
string
amountComponentCode
required
string | null
amountComponentLabel
required
string | null
discountAmountKrw
required
integer
regionalBenefitProfileKey
required
string | null
sourceEvidenceKey
required
string | null
serviceDayBonusCount
required
integer
settlementParticipationCode
required
string | null
key
additional properties
key
additional properties
null
acceptedServiceOfferingAvailabilityDecision
required
object
offeringKey
required
string
availabilityState
required
string
handoffKind
required
string
unavailableReasonCodes
Array<string>
messageKeys
Array<string>
policyRevisionKey
required
string
sourceEvidenceKeys
required
Array<string>
key
additional properties
acceptedServiceTermPlan
One of:
object
policyKey
required
string
serviceStartOn
required
string format: date
duration
required
object
quantity
required
integer
unit
required
string
serviceDaysPerWeek
required
integer
durationProfileKey
required
string | null
serviceWeekProfile
required
sourceReference
required
string | null
key
additional properties
serviceAreaKey
required
string
holidayRegistry
required
object
entries
required
Array<object>
object
holidayKey
required
string
calendarProfileKey
required
string
observedOn
required
string format: date
nonWorkingDayKind
required
string
serviceAvailableByDefault
required
boolean
substituteOfHolidayKey
required
string | null
sourceReference
required
string | null
key
additional properties
key
additional properties
serviceAreaProfiles
required
object
profiles
required
Array<object>
object
profileKey
required
string
serviceAreaKey
required
string
calendarProfileKey
required
string
effectiveFrom
required
string format: date
effectiveUntil
required
string | null format: date
nonWorkingWeekdays
required
Array<integer>
durationExtensionDays
required
integer
sourceReference
required
string | null
key
additional properties
key
additional properties
selectedAdditionalServiceDays
required
Array<object>
object
selectionKey
required
string
serviceOn
required
string format: date
dayKind
required
string
sourceReference
required
string | null
chargeable
required
boolean
key
additional properties
sourceReference
required
string | null
key
additional properties
object
policyKey
required
string
serviceAreaProfileKey
required
string
serviceAreaKey
required
string
calendarProfileKey
required
string
serviceStartOn
required
string format: date
serviceEndOn
required
string format: date
duration
required
object
quantity
required
integer
unit
required
string
serviceDaysPerWeek
required
integer
durationProfileKey
required
string | null
serviceWeekProfile
required
sourceReference
required
string | null
key
additional properties
serviceDays
required
Array<object>
object
serviceOn
required
string format: date
dayKind
required
string
occurrenceKind
required
string
serviceSequence
required
integer | null
nonWorkingDayKind
required
string | null
holidayKeys
required
Array<string>
additionalSelectionKey
required
string | null
key
additional properties
selectedAdditionalServiceDays
required
Array<object>
object
selectionKey
required
string
serviceOn
required
string format: date
dayKind
required
string
sourceReference
required
string | null
chargeable
required
boolean
key
additional properties
policyFingerprint
required
string
sourceReference
required
string | null
baseServiceDayCount
required
integer
additionalServiceDayCount
required
integer
skippedNonWorkingDayCount
required
integer
occurrenceDates
required
Array<string>
key
additional properties
null
bookingServiceTermSideEffects
One of:
object
acceptedServiceTermSnapshotKey
required
string
acceptedServiceTermSnapshotRevision
required
integer
reservationServiceCalendarQuoteKey
required
string
reservationServiceCalendarQuoteRevision
required
integer
selectedAddOptionSelectionKeys
required
Array<string>
addOptionChargeIntents
required
Array<object>
object
addOptionSelectionKey
required
string
chargeComponentCode
required
string
sourceEvidenceKeys
required
Array<string>
key
additional properties
consumerImpactFacts
required
Array<object>
object
impactFactKey
required
string
consumerContextCode
required
string
invalidationTargetCode
required
string
invalidationTargetReference
required
string
reasonCode
required
string
sourceProjectionKey
required
string
sourceEvidenceKeys
required
Array<string>
key
additional properties
requiredConsumerContextCodes
required
Array<string>
sourceEvidenceKeys
required
Array<string>
key
additional properties
null
Responses
Section titled “Responses”Reservation booking workflow accepted
Media typeapplication/json
ReservationBookingWorkflowStartResponse
object
workflowStateEngine
required
string
workflowName
required
string
workflowKey
required
string
handlerName
required
string
invocationId
required
string
workflowStatus
required
string
reservationBookingRequestId
required
string | null
key
additional properties
Supabase bearer token is required
Actor cannot submit reservation booking request
Reservation booking workflow runtime is unavailable