AlmondTill/G3N API

On this page

startAppointment

mutation · in the family Appointment

What it does

Start a confirmed appointment — the service or pickup is underway; the no-show clock disarms.

Start a confirmed Appointment; requires the unrestricted capability + the record's CURRENT revision (OCC).

Who may call it

Capability area: Selling — Ringing sales, serving customers and issuing invoices.

Arguments

NameTypeRequiredNotes
idID ID!yesThe id of the record.
revisionID ID!yesThe revision id you read on the record; the change is refused if an edit landed in the meantime.
reasonStringnoNo further notes.

Returns

Appointment Appointment! — An Appointment — a booking of 1..8 SchedulableResources at an LF for a time window: a service-type product sale (purpose service — variantId REQUIRED, the styleType walk gates it) OR an order pickup (purpose pickup — orderId REQUIRED, the order being collected). The ratified lifecycle VERBATIM: confirm reserves capacity (the RESBOOK calendar rows; the gate is CAPACITY-ONLY — CONFLICT/DOUBLE_BOOKED unless the appointment.overbook_allowed policy admits); no_show fires from the scheduler ONLY (noShowAt = startAt + the appointment.no_show_window_minutes policy, stamped at confirm — NO caller op); rescheduled = a DOOMED terminal superseded by the linked successor (born requested — ITS confirm re-runs the capacity gate); completed may LINK an order for billing (the complete-time orderId — auto-minting a line is a named growth). durationMinutes ≤ 1440 (24h — the overlap-lookback bound). The create-time gates: appointment.lead_time_minutes + appointment.max_advance_days.

Example request

mutation ExampleStartAppointment($id: ID!, $revision: ID!, $reason: String) {
  startAppointment(id: $id, revision: $revision, reason: $reason) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    organizationId
    purpose
    variantId
    orderId
    resourceIds
    startAt
    durationMinutes
    noShowAt
    successorAppointmentId
    predecessorAppointmentId
  }
}

Variables:

{
  "id": "01900000-0000-7000-8000-37386ae00000",
  "revision": "01900000-0000-7000-8000-b7960e180000",
  "reason": "Correcting a miscount."
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "startAppointment": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "AP-EXMP-0000-000F",
      "type": "Appointment",
      "caption": "Blue jeans",
      "status": "requested",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "organizationId": "01900000-0000-7000-8000-44b781470000",
      "purpose": "service",
      "variantId": "01900000-0000-7000-8000-8415e73b0000",
      "orderId": "01900000-0000-7000-8000-f6d8263a0000",
      "resourceIds": [
        "01900000-0000-7000-8000-0fbb2cf90000"
      ],
      "startAt": "2027-01-31T00:00:00.000Z",
      "durationMinutes": 1,
      "noShowAt": "2027-01-31T00:00:00.000Z",
      "successorAppointmentId": "01900000-0000-7000-8000-66ae038f0000",
      "predecessorAppointmentId": "01900000-0000-7000-8000-c8b7f8160000"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer