Development
  • Guides
  • API Reference
  • API Explorer
  • SDKs
  • Sample apps
  • System status
Support
  • Developer forums
  • Developer blog
  • YouTube
  • X
More
  • Square Home
  • Square Developer
  • App Marketplace
  • Partner with Square
  • Solutions Partner Program
  • Pricing
  • Sales

© 2026 Square, Inc.

  • Developer terms of service
  • Developer Integration and Marketing Agreement
  • Privacy policy
  • Partnerships
  • Sign In
  • Sign In

Objects

  • ACHDetails

  • AcceptedPaymentMethods

  • Address

  • AfterpayDetails

  • ApplicationDetails

  • AppointmentSegment

  • Availability

  • BankAccount

  • BankAccountPaymentDetails

  • BatchRetrieveInventoryChangesSort

  • Booking

  • BookingCreatorDetails

  • Break

  • BreakType

  • BulkCreateCustomerData

  • BulkDeleteOrderCustomAttributesRequestDeleteCustomAttribute

  • BulkPublishScheduledShiftsData

  • BulkUpdateCustomerData

  • BulkUpsertOrderCustomAttributesRequestUpsertCustomAttribute

  • BusinessAppointmentSettings

  • BusinessBookingProfile

  • BusinessHours

  • BusinessHoursPeriod

  • BuyNowPayLaterDetails

  • Card

  • CardForgottenEventCard

  • CardPaymentDetails

  • CardPaymentTimeline

  • CardSurchargeDetails

  • CashAppDetails

  • CashDrawerDevice

  • CashDrawerShift

  • CashDrawerShiftEvent

  • CashDrawerShiftSummary

  • CashPaymentDetails

  • CatalogAvailabilityPeriod

  • CatalogCategory

  • CatalogCustomAttributeDefinition

  • CatalogCustomAttributeDefinitionNumberConfig

  • CatalogCustomAttributeDefinitionSelectionConfig

  • CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection

  • CatalogCustomAttributeDefinitionStringConfig

  • CatalogCustomAttributeValue

  • CatalogDiscount

  • CatalogEcomSeoData

  • CatalogIdMapping

  • CatalogImage

  • CatalogInfoResponseLimits

  • CatalogItem

  • CatalogItemFoodAndBeverageDetails

  • CatalogItemFoodAndBeverageDetailsDietaryPreference

  • CatalogItemFoodAndBeverageDetailsIngredient

  • CatalogItemModifierListInfo

  • CatalogItemOption

  • CatalogItemOptionForItem

  • CatalogItemOptionValue

  • CatalogItemOptionValueForItemVariation

  • CatalogItemVariation

  • CatalogItemVariationVendorInformation

  • CatalogMeasurementUnit

  • CatalogModifier

  • CatalogModifierList

  • CatalogModifierOverride

  • CatalogObject

  • CatalogObjectBatch

  • CatalogObjectCategory

  • CatalogObjectReference

  • CatalogPricingRule

  • CatalogProductSet

  • CatalogQuery

  • CatalogQueryExact

  • CatalogQueryItemVariationsForItemOptionValues

  • CatalogQueryItemsForItemOptions

  • CatalogQueryItemsForModifierList

  • CatalogQueryItemsForTax

  • CatalogQueryModifiersForChildList

  • CatalogQueryPrefix

  • CatalogQueryRange

  • CatalogQuerySet

  • CatalogQuerySortedAttribute

  • CatalogQueryText

  • CatalogQuickAmount

  • CatalogQuickAmountsSettings

  • CatalogStockConversion

  • CatalogSubscriptionPlan

  • CatalogSubscriptionPlanVariation

  • CatalogTax

  • CatalogTimePeriod

  • CatalogV1Id

  • CatalogVersionUpdatedEventCatalogVersion

  • CategoryPathToRootNode

  • Channel

  • Checkout

  • CheckoutLocationSettings

  • CheckoutLocationSettingsBranding

  • CheckoutLocationSettingsCoupons

  • CheckoutLocationSettingsPolicy

  • CheckoutLocationSettingsTipping

  • CheckoutMerchantSettings

  • CheckoutMerchantSettingsPaymentMethods

  • CheckoutMerchantSettingsPaymentMethodsAfterpayClearpay

  • CheckoutMerchantSettingsPaymentMethodsAfterpayClearpayEligibilityRange

  • CheckoutMerchantSettingsPaymentMethodsPaymentMethod

  • CheckoutOptions

  • ClearpayDetails

  • CollectedData

  • Component

  • ConfirmationDecision

  • ConfirmationOptions

  • Coordinates

  • CreateTransferOrderData

  • CreateTransferOrderLineData

  • CustomAttribute

  • CustomAttributeDefinition

  • CustomAttributeDefinitionEventDataObject

  • CustomAttributeEventDataObject

  • CustomAttributeFilter

  • CustomField

  • Customer

  • CustomerAddressFilter

  • CustomerCreatedEventEventContext

  • CustomerCreatedEventEventContextMerge

  • CustomerCreationSourceFilter

  • CustomerCustomAttributeFilter

  • CustomerCustomAttributeFilterValue

  • CustomerCustomAttributeFilters

  • CustomerDeletedEventEventContext

  • CustomerDeletedEventEventContextMerge

  • CustomerDetails

  • CustomerFilter

  • CustomerGroup

  • CustomerPreferences

  • CustomerQuery

  • CustomerSegment

  • CustomerSort

  • CustomerTaxIds

  • CustomerTextFilter

  • DataCollectionOptions

  • DateRange

  • Destination

  • DestinationDetails

  • DestinationDetailsCardRefundDetails

  • DestinationDetailsCashRefundDetails

  • DestinationDetailsExternalRefundDetails

  • Device

  • DeviceAttributes

  • DeviceCheckoutOptions

  • DeviceCode

  • DeviceComponentDetails

  • DeviceComponentDetailsApplicationDetails

  • DeviceComponentDetailsBatteryDetails

  • DeviceComponentDetailsCardReaderDetails

  • DeviceComponentDetailsEthernetDetails

  • DeviceComponentDetailsMeasurement

  • DeviceComponentDetailsNetworkInterfaceDetails

  • DeviceComponentDetailsWiFiDetails

  • DeviceDetails

  • DeviceMetadata

  • DeviceStatus

  • DigitalWalletDetails

  • Dispute

  • DisputeEvidence

  • DisputeEvidenceFile

  • DisputedPayment

  • ElectronicMoneyDetails

  • Error

  • Event

  • EventMetadata

  • EventTypeMetadata

  • ExternalPaymentDetails

  • FelicaDetails

  • FilterValue

  • FloatNumberRange

  • Fulfillment

  • FulfillmentDeliveryDetails

  • FulfillmentFulfillmentEntry

  • FulfillmentFulfillmentStateNotifications

  • FulfillmentInStoreDetails

  • FulfillmentPickupDetails

  • FulfillmentPickupDetailsCurbsidePickupDetails

  • FulfillmentRecipient

  • FulfillmentShipmentDetails

  • GiftCard

  • GiftCardActivity

  • GiftCardActivityActivate

  • GiftCardActivityAdjustDecrement

  • GiftCardActivityAdjustIncrement

  • GiftCardActivityBlock

  • GiftCardActivityClearBalance

  • GiftCardActivityDeactivate

  • GiftCardActivityImport

  • GiftCardActivityImportReversal

  • GiftCardActivityLoad

  • GiftCardActivityRedeem

  • GiftCardActivityRefund

  • GiftCardActivityTransferBalanceFrom

  • GiftCardActivityTransferBalanceTo

  • GiftCardActivityUnblock

  • GiftCardActivityUnlinkedActivityRefund

  • IncludeOptions

  • IncludedResources

  • InventoryAdjustment

  • InventoryAdjustmentGroup

  • InventoryAdjustmentReason

  • InventoryAdjustmentReasonId

  • InventoryChange

  • InventoryCount

  • InventoryPhysicalCount

  • Invoice

  • InvoiceAcceptedPaymentMethods

  • InvoiceAttachment

  • InvoiceCustomField

  • InvoiceFilter

  • InvoicePaymentReminder

  • InvoiceQuery

  • InvoiceRecipient

  • InvoiceRecipientTaxIds

  • InvoiceSort

  • ItemVariationLocationOverrides

  • Job

  • JobAssignment

  • LightningDetails

  • Location

  • LocationBookingProfile

  • LoyaltyAccount

  • LoyaltyAccountExpiringPointDeadline

  • LoyaltyAccountMapping

  • LoyaltyEvent

  • LoyaltyEventAccumulatePoints

  • LoyaltyEventAccumulatePromotionPoints

  • LoyaltyEventAdjustPoints

  • LoyaltyEventCreateReward

  • LoyaltyEventDateTimeFilter

  • LoyaltyEventDeleteReward

  • LoyaltyEventExpirePoints

  • LoyaltyEventFilter

  • LoyaltyEventLocationFilter

  • LoyaltyEventLoyaltyAccountFilter

  • LoyaltyEventOrderFilter

  • LoyaltyEventOther

  • LoyaltyEventQuery

  • LoyaltyEventRedeemReward

  • LoyaltyEventTypeFilter

  • LoyaltyProgram

  • LoyaltyProgramAccrualRule

  • LoyaltyProgramAccrualRuleCategoryData

  • LoyaltyProgramAccrualRuleItemVariationData

  • LoyaltyProgramAccrualRuleSpendData

  • LoyaltyProgramAccrualRuleVisitData

  • LoyaltyProgramExpirationPolicy

  • LoyaltyProgramRewardTier

  • LoyaltyProgramTerminology

  • LoyaltyPromotion

  • LoyaltyPromotionAvailableTimeData

  • LoyaltyPromotionIncentive

  • LoyaltyPromotionIncentivePointsAdditionData

  • LoyaltyPromotionIncentivePointsMultiplierData

  • LoyaltyPromotionTriggerLimit

  • LoyaltyReward

  • MeasurementUnit

  • MeasurementUnitCustom

  • Merchant

  • ModifierLocationOverrides

  • Money

  • OauthAuthorizationRevokedEventRevocationObject

  • Order

  • OrderCreated

  • OrderCreatedObject

  • OrderEntry

  • OrderFulfillment

  • OrderFulfillmentDeliveryDetails

  • OrderFulfillmentFulfillmentEntry

  • OrderFulfillmentPickupDetails

  • OrderFulfillmentPickupDetailsCurbsidePickupDetails

  • OrderFulfillmentRecipient

  • OrderFulfillmentShipmentDetails

  • OrderFulfillmentUpdated

  • OrderFulfillmentUpdatedObject

  • OrderFulfillmentUpdatedUpdate

  • OrderLineItem

  • OrderLineItemAppliedDiscount

  • OrderLineItemAppliedServiceCharge

  • OrderLineItemAppliedTax

  • OrderLineItemDiscount

  • OrderLineItemModifier

  • OrderLineItemPricingBlocklists

  • OrderLineItemPricingBlocklistsBlockedDiscount

  • OrderLineItemPricingBlocklistsBlockedServiceCharge

  • OrderLineItemPricingBlocklistsBlockedTax

  • OrderLineItemTax

  • OrderMoneyAmounts

  • OrderPricingOptions

  • OrderQuantityUnit

  • OrderReturn

  • OrderReturnDiscount

  • OrderReturnLineItem

  • OrderReturnLineItemModifier

  • OrderReturnServiceCharge

  • OrderReturnTax

  • OrderReturnTip

  • OrderReward

  • OrderRoundingAdjustment

  • OrderServiceCharge

  • OrderSource

  • OrderUpdated

  • OrderUpdatedObject

  • PaginationCursor

  • Payment

  • PaymentBalanceActivityAppFeeRefundDetail

  • PaymentBalanceActivityAppFeeRevenueDetail

  • PaymentBalanceActivityAutomaticSavingsDetail

  • PaymentBalanceActivityAutomaticSavingsReversedDetail

  • PaymentBalanceActivityChargeDetail

  • PaymentBalanceActivityDepositFeeDetail

  • PaymentBalanceActivityDepositFeeReversedDetail

  • PaymentBalanceActivityDisputeDetail

  • PaymentBalanceActivityFeeDetail

  • PaymentBalanceActivityFreeProcessingDetail

  • PaymentBalanceActivityHoldAdjustmentDetail

  • PaymentBalanceActivityOpenDisputeDetail

  • PaymentBalanceActivityOtherAdjustmentDetail

  • PaymentBalanceActivityOtherDetail

  • PaymentBalanceActivityRefundDetail

  • PaymentBalanceActivityReleaseAdjustmentDetail

  • PaymentBalanceActivityReserveHoldDetail

  • PaymentBalanceActivityReserveReleaseDetail

  • PaymentBalanceActivitySquareCapitalPaymentDetail

  • PaymentBalanceActivitySquareCapitalReversedPaymentDetail

  • PaymentBalanceActivitySquarePayrollTransferDetail

  • PaymentBalanceActivitySquarePayrollTransferReversedDetail

  • PaymentBalanceActivityTaxOnFeeDetail

  • PaymentBalanceActivityThirdPartyFeeDetail

  • PaymentBalanceActivityThirdPartyFeeRefundDetail

  • PaymentLink

  • PaymentLinkRelatedResources

  • PaymentOptions

  • PaymentRefund

  • Payout

  • PayoutEntry

  • PayoutFee

  • Phase

  • PhaseInput

  • PrePopulatedData

  • ProcessingFee

  • QrCodeOptions

  • QuantityRatio

  • QuickPay

  • Range

  • ReceiptOptions

  • Reference

  • Refund

  • RiskEvaluation

  • SaveCardOptions

  • ScheduledShift

  • ScheduledShiftDetails

  • ScheduledShiftFilter

  • ScheduledShiftQuery

  • ScheduledShiftSort

  • ScheduledShiftWorkday

  • SearchAvailabilityFilter

  • SearchAvailabilityQuery

  • SearchEventsFilter

  • SearchEventsQuery

  • SearchEventsSort

  • SearchLoyaltyAccountsRequestLoyaltyAccountQuery

  • SearchLoyaltyRewardsRequestLoyaltyRewardQuery

  • SearchOrdersCustomerFilter

  • SearchOrdersDateTimeFilter

  • SearchOrdersFilter

  • SearchOrdersFulfillmentFilter

  • SearchOrdersQuery

  • SearchOrdersSort

  • SearchOrdersSourceFilter

  • SearchOrdersStateFilter

  • SearchSubscriptionsFilter

  • SearchSubscriptionsQuery

  • SearchTeamMembersFilter

  • SearchTeamMembersQuery

  • SearchVendorsRequestFilter

  • SearchVendorsRequestSort

  • SegmentFilter

  • SelectOption

  • SelectOptions

  • ShippingFee

  • SignatureImage

  • SignatureOptions

  • Site

  • Snippet

  • SourceApplication

  • SquareAccountDetails

  • StandardUnitDescription

  • StandardUnitDescriptionGroup

  • Subscription

  • SubscriptionAction

  • SubscriptionEvent

  • SubscriptionEventInfo

  • SubscriptionPhase

  • SubscriptionPricing

  • SubscriptionSource

  • SubscriptionTestResult

  • TaxIds

  • TeamMember

  • TeamMemberAssignedLocations

  • TeamMemberBookingProfile

  • TeamMemberWage

  • Tender

  • TenderBankAccountDetails

  • TenderBuyNowPayLaterDetails

  • TenderCardDetails

  • TenderCashDetails

  • TenderSquareAccountDetails

  • TerminalAction

  • TerminalActionQuery

  • TerminalActionQueryFilter

  • TerminalActionQuerySort

  • TerminalCheckout

  • TerminalCheckoutQuery

  • TerminalCheckoutQueryFilter

  • TerminalCheckoutQuerySort

  • TerminalRefund

  • TerminalRefundQuery

  • TerminalRefundQueryFilter

  • TerminalRefundQuerySort

  • TimeRange

  • Timecard

  • TimecardFilter

  • TimecardQuery

  • TimecardSort

  • TimecardWage

  • TimecardWorkday

  • TipSettings

  • TransferOrder

  • TransferOrderFilter

  • TransferOrderGoodsReceipt

  • TransferOrderGoodsReceiptLineItem

  • TransferOrderLine

  • TransferOrderQuery

  • TransferOrderSort

  • UpdateTransferOrderData

  • UpdateTransferOrderLineData

  • Vendor

  • VendorContact

  • WageSetting

  • WebhookSubscription

  • WorkweekConfig

<- Object

Object

All versions ->

ScheduledShiftDetailsBeta

Represents shift details for draft and published versions of a scheduled shift, such as job ID, team member assignment, and start and end times.

Link to section

Properties

Link to section

team_member_id

string

The ID of the team member scheduled for the shift.

Max Length
255
Link to section

location_id

string

The ID of the location the shift is scheduled for.

Max Length
255
Link to section

job_id

string

The ID of the job the shift is scheduled for.

Link to section

start_at

string

The start time of the shift, in RFC 3339 format in the time zone + offset of the shift location specified in location_id. Precision up to the minute is respected; seconds are truncated.

Link to section

end_at

string

The end time for the shift, in RFC 3339 format in the time zone + offset of the shift location specified in location_id. Precision up to the minute is respected; seconds are truncated.

Link to section

notes

string

Optional notes for the shift.

Max Length
1000
Link to section

is_deleted

boolean

Indicates whether the draft shift version is deleted. If set to true when the shift is published, the entire scheduled shift (including the published shift) is deleted and cannot be accessed using any endpoint.

Link to section

timezone

string

Read only The time zone of the shift location, calculated based on the location_id. This field is provided for convenience.