Skip to content

Latest commit

 

History

History
48 lines (39 loc) · 2.1 KB

shift-filter.md

File metadata and controls

48 lines (39 loc) · 2.1 KB

Shift Filter

Defines a filter used in a search for Shift records. AND logic is used by Square's servers to apply each filter property specified.

Structure

Shift Filter

Fields

Name Type Tags Description
location_ids List[str] Optional Fetch shifts for the specified location.
employee_ids List[str] Optional Fetch shifts for the specified employees. DEPRECATED at version 2020-08-26. Use team_member_ids instead.
status str (Shift Filter Status) Optional Specifies the status of Shift records to be returned.
start Time Range Optional Represents a generic time range. The start and end values are
represented in RFC 3339 format. Time ranges are customized to be
inclusive or exclusive based on the needs of a particular endpoint.
Refer to the relevant endpoint-specific documentation to determine
how time ranges are handled.
end Time Range Optional Represents a generic time range. The start and end values are
represented in RFC 3339 format. Time ranges are customized to be
inclusive or exclusive based on the needs of a particular endpoint.
Refer to the relevant endpoint-specific documentation to determine
how time ranges are handled.
workday Shift Workday Optional A Shift search query filter parameter that sets a range of days that
a Shift must start or end in before passing the filter condition.
team_member_ids List[str] Optional Fetch shifts for the specified team members. Replaced employee_ids at version "2020-08-26".

Example (as JSON)

{
  "location_ids": [
    "location_ids8",
    "location_ids9",
    "location_ids0"
  ],
  "employee_ids": [
    "employee_ids3",
    "employee_ids4",
    "employee_ids5"
  ],
  "status": "OPEN",
  "start": {
    "start_at": "start_at6",
    "end_at": "end_at6"
  },
  "end": {
    "start_at": "start_at0",
    "end_at": "end_at2"
  }
}