Create Scheduled Shift - Automate.ax

square.createScheduledShift creates a scheduled shift by providing draft shift details such as job ID, team member assignment, and start and end times.

Example

automations/square-create-scheduled-shift.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

export default automation("Create Square Scheduled Shift", () => {
  onDashboardRun({ title: "Create Square Scheduled Shift" })

  square.createScheduledShift({
    idempotencyKey: "HIDSNG5KS478L",
    scheduledShift: {
      draftShiftDetails: {
        teamMemberId: "ormj0jJJZ5OZIzxrZYJI",
        locationId: "PAA1RJZZKXBFG",
        jobId: "FzbJAtt9qEWncK1BWgVCxQ6M",
        startAt: "2019-01-25T03:11:00-05:00",
        endAt: "2019-01-25T13:11:00-05:00",
        notes: "Dont forget to prep the vegetables",
        isDeleted: false,
      },
    },
  })
})

Inputs

Every input accepts a compatible signal. It requires TIMECARDS_WRITE.

Field	Type	Required	Default	Description
`idempotencyKey`	`string`	No	—	A unique identifier for the `CreateScheduledShift` request, used to ensure the idempotency of the operation.
`scheduledShift`	`Square.ScheduledShift`	Yes	—	The scheduled shift with `draft_shift_details`. If needed, call ListLocations to get location IDs, ListJobs to get job IDs, and SearchTeamMembers to get team member IDs and current job assignments. The `start_at` and `end_at` timestamps must be provided in the time zone + offset of the shift location specified in `location_id`. Example for Pacific Standard Time: 2024-10-31T12:30:00-08:00

Use the official CreateScheduledShift reference for provider field semantics and limits.

Output

Returns the official Square.CreateScheduledShiftResponse response as a codec-safe object. Square integer money amounts remain bigint values.