Skip to content
Sanmopia Modernization

Apply one authorized reservation operation for the authenticated branch operator

Switch to Zen Mode
POST
/branch-reservation-operation-commands/{reservationId}
curl --request POST \
  --url https://example.com/branch-reservation-operation-commands/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --data '{ "expectedRevision": 1, "operationCommand": "start_consultation", "operationReasonCode": "example", "operationNote": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
reservationId
required
string
>= 1 characters

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
required
string
>= 1 characters <= 255 characters /.*\S.*/

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
BranchReservationOperationCommand
object
expectedRevision
required
integer
>= 1
operationCommand
required
string
Allowed values: start_consultation confirm_service_schedule begin_care_delivery prepare_settlement complete_reservation cancel_reservation stop_care_delivery approve_extension resume_care_delivery register_offline_reservation request_reservation_change request_care_stop approve_cancellation_request expire_virtual_account_reservation record_virtual_account_deposit assign_primary_caregiver replace_primary_caregiver assign_assistant_caregiver remove_assistant_caregiver record_caregiver_attendance record_care_delivery record_daily_care_report record_caregiver_service_balance_receipt transfer_reservation_branch change_reservation_price_version
operationReasonCode
string
>= 1 characters <= 100 characters /^[a-z][a-z0-9_]*$/
operationNote
string
>= 1 characters <= 2000 characters /.*\S.*/
key
additional properties

Responses

Section titled “Responses”

200

Section titled “200”

Reservation status and revision committed atomically, or the identical result replayed

Media typeapplication/json
BranchReservationOperationCommandResult
object
reservationId
required
string
>= 1 characters
operationCommand
required
string
Allowed values: start_consultation confirm_service_schedule begin_care_delivery prepare_settlement complete_reservation cancel_reservation stop_care_delivery approve_extension resume_care_delivery register_offline_reservation request_reservation_change request_care_stop approve_cancellation_request expire_virtual_account_reservation record_virtual_account_deposit assign_primary_caregiver replace_primary_caregiver assign_assistant_caregiver remove_assistant_caregiver record_caregiver_attendance record_care_delivery record_daily_care_report record_caregiver_service_balance_receipt transfer_reservation_branch change_reservation_price_version
actorKind
required
string
Allowed values: branch_operator hq_admin
fromStatus
required
string
Allowed values: draft reserved awaiting_deposit consulting scheduled in_progress settling completed change_requested cancellation_requested cancelled stop_requested stopped extended offline
toStatus
required
string
Allowed values: draft reserved awaiting_deposit consulting scheduled in_progress settling completed change_requested cancellation_requested cancelled stop_requested stopped extended offline
followUpActions
required
Array<string>
unique items
expectedRevision
required
integer
>= 1
committedRevision
required
integer
>= 2
replayed
required
boolean
followUpWorkflowRequestId
string
>= 1 characters
stateTransition
object
allowed
required
boolean
trigger
required
string
>= 1 characters
fromState
required
string
>= 1 characters
catalogVersionLabel
required
string
>= 1 characters
transitionId
string
>= 1 characters
toState
string
>= 1 characters
missingGuards
required
Array<string>
unique items
followUpActions
required
Array<string>
unique items
disabledReason
string
>= 1 characters
key
additional properties
key
additional properties

400

Section titled “400”

Command input is invalid

401

Section titled “401”

Supabase bearer token is required

403

Section titled “403”

Authenticated actor cannot operate the reservation branch

404

Section titled “404”

Reservation booking was not found

409

Section titled “409”

Revision, state projection, or idempotency intent conflicts

503

Section titled “503”

Reservation operation command handler is unavailable