createAppointment

mutation · in the family Appointment

What it does

Request an appointment — a service booking (names the service product) or an order pickup (names the order), against one or more resources at a location.

Request an Appointment; requires the unrestricted capability.

What happens

Born requested — no capacity is held yet; confirm reserves the slot. The lead-time and maximum-advance policies gate the window.

Who may call it

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

• Owner
• Manager
• Associate Manager
• Sales Associate
• Cashier
• An API key whose scope allows api:createAppointment

Arguments

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 ExampleCreateAppointment($input: NewAppointmentInput!) {
  createAppointment(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    organizationId
    purpose
    variantId
    orderId
    resourceIds
    startAt
    durationMinutes
    noShowAt
    successorAppointmentId
    predecessorAppointmentId
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "logicalFacilityId": "01900000-0000-7000-8000-8026f71c0000",
    "purpose": "service",
    "resourceIds": [
      "01900000-0000-7000-8000-0fbb2cf90000"
    ],
    "startAt": "2027-01-31T00:00:00.000Z",
    "durationMinutes": 1
  }
}

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

Example response

{
  "data": {
    "createAppointment": {
      "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

• VALIDATION/INVALID — Something in the request is not valid. (VALIDATION)
• AUTHN/REQUIRED — Sign in to do this. (AUTHN)
• AUTHZ/FORBIDDEN — Your role does not allow this action. (AUTHZ)
• RATE_LIMIT/THROTTLED — Too many requests in a short time. (RATE_LIMIT)
• NOT_FOUND/* — That record could not be found. (NOT_FOUND)
• CONFLICT/* — The record’s state, or a change made in the meantime, does not allow this; the codes are on the CONFLICT page. (CONFLICT)
• VALIDATION/VERSION_REQUIRED — The request did not say which app version it came from. (VALIDATION)

Dry run

Add dryRun: true to the request envelope (extensions.at) to rehearse this call: every check runs, the write is rehearsed against the current records and nothing is stored; the answer is the refusal a real call would give, or the record it would create. Every response to a rehearsal carries dryRun: true, so a rehearsed record is never mistaken for a saved one.

Used in

• Offer appointments on a bookable resource