Creates a booking.
643 matches
100 actions
Square Connect
100 actions
- CreateBookingPOSTv1.0.0
- CreateBreakTypePOSTv1.0.0
- CreateCardPOSTv1.0.0
- CreateCustomerGroupPOSTv1.0.0
- CreateDeviceCodePOSTv1.0.0
- CreateDisputeEvidenceTextPOSTv1.0.0
- CreateGiftCardPOSTv1.0.0
- CreateGiftCardActivityPOSTv1.0.0
- CreateInvoicePOSTv1.0.0
- CreateLocationPOSTv1.0.0
- CreateLoyaltyAccountPOSTv1.0.0
- CreateLoyaltyRewardPOSTv1.0.0
- CreateMobileAuthorizationCodePOSTv1.0.0
- CreateOrderPOSTv1.0.0
- CreateShiftPOSTv1.0.0
- CreateTeamMemberPOSTv1.0.0
- CreateTerminalCheckoutPOSTv1.0.0
- CreateTerminalRefundPOSTv1.0.0
- GetBankAccountGETv1.0.0
- GetBankAccountByV1IdGETv1.0.0
- GetBreakTypeGETv1.0.0
- GetDeviceCodeGETv1.0.0
- GetEmployeeWageGETv1.0.0
- GetInvoiceGETv1.0.0
- GetPaymentGETv1.0.0
- GetPaymentRefundGETv1.0.0
- GetShiftGETv1.0.0
- GetTeamMemberWageGETv1.0.0
- GetTerminalCheckoutGETv1.0.0
- GetTerminalRefundGETv1.0.0
- ListBankAccountsGETv1.0.0
- ListBreakTypesGETv1.0.0
- ListCardsGETv1.0.0
- ListCashDrawerShiftEventsGETv1.0.0
- ListCatalogGETv1.0.0
- ListCustomerGroupsGETv1.0.0
- ListCustomersGETv1.0.0
- ListCustomerSegmentsGETv1.0.0
- ListDeviceCodesGETv1.0.0
- ListDisputeEvidenceGETv1.0.0
- ListDisputesGETv1.0.0
- ListEmployeeRolesGETv1.0.0
- ListEmployeesGETv1.0.0
- ListEmployeeWagesGETv1.0.0
- ListGiftCardsGETv1.0.0
- ListInvoicesGETv1.0.0
- ListLocationsGETv1.0.0
- ListLoyaltyProgramsGETv1.0.0
- ListMerchantsGETv1.0.0
- ListOrdersGETv1.0.0
- ListRefundsGETv1.0.0
- ListSitesGETv1.0.0
- ListSubscriptionEventsGETv1.0.0
- ListTeamMemberBookingProfilesGETv1.0.0
- ListTeamMemberWagesGETv1.0.0
- ListTransactionsGETv1.0.0
- ListWorkweekConfigsGETv1.0.0
- RetrieveBookingGETv1.0.0
- RetrieveBusinessBookingProfileGETv1.0.0
- RetrieveCardGETv1.0.0
- RetrieveCashDrawerShiftGETv1.0.0
- RetrieveCatalogObjectGETv1.0.0
- RetrieveCustomerGETv1.0.0
- RetrieveCustomerGroupGETv1.0.0
- RetrieveCustomerSegmentGETv1.0.0
- RetrieveDisputeGETv1.0.0
- RetrieveDisputeEvidenceGETv1.0.0
- RetrieveEmployeeGETv1.0.0
- RetrieveEmployeeGETv1.0.0
- RetrieveEmployeeRoleGETv1.0.0
- RetrieveGiftCardGETv1.0.0
- RetrieveGiftCardFromGANPOSTv1.0.0
- RetrieveGiftCardFromNoncePOSTv1.0.0
- RetrieveInventoryAdjustmentGETv1.0.0
- RetrieveInventoryChangesGETv1.0.0
- RetrieveInventoryCountGETv1.0.0
- RetrieveInventoryPhysicalCountGETv1.0.0
- RetrieveInventoryTransferGETv1.0.0
- RetrieveLocationGETv1.0.0
- RetrieveLoyaltyAccountGETv1.0.0
- RetrieveLoyaltyProgramGETv1.0.0
- RetrieveLoyaltyRewardGETv1.0.0
- RetrieveMerchantGETv1.0.0
- RetrieveOrderGETv1.0.0
- RetrieveOrderGETv1.0.0
- RetrievePaymentGETv1.0.0
- RetrieveSettlementGETv1.0.0
- RetrieveSnippetGETv1.0.0
- RetrieveSubscriptionGETv1.0.0
- RetrieveTeamMemberGETv1.0.0
- RetrieveTeamMemberBookingProfileGETv1.0.0
- RetrieveTransactionGETv1.0.0
- RetrieveWageSettingGETv1.0.0
- SearchAvailabilityPOSTv1.0.0
- SearchCustomersPOSTv1.0.0
- SearchInvoicesPOSTv1.0.0
- SearchLoyaltyAccountsPOSTv1.0.0
- SearchLoyaltyEventsPOSTv1.0.0
- SearchLoyaltyRewardsPOSTv1.0.0
- SearchOrdersPOSTv1.0.0
Other/Square Connect
CreateBooking
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
{
"type": "object",
"required": [
"booking"
],
"properties": {
"booking": {
"type": "object",
"description": "Represents a booking as a time-bound service contract for a seller's staff member to provide a specified service\nat a given location to a requesting customer in one or more appointment segments.",
"properties": {
"appointment_segments": {
"type": "array",
"description": "A list of appointment segments for this booking.",
"items": {
"type": "object",
"description": "Defines an appointment segment of a booking.",
"required": [
"duration_minutes",
"service_variation_id",
"team_member_id",
"service_variation_version"
],
"properties": {
"duration_minutes": {
"type": "integer",
"description": "The time span in minutes of an appointment segment."
},
"service_variation_id": {
"type": "string",
"description": "The ID of the [CatalogItemVariation](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogItemVariation) object representing the service booked in this segment."
},
"service_variation_version": {
"type": "integer",
"format": "int64",
"description": "The current version of the item variation representing the service booked in this segment."
},
"team_member_id": {
"type": "string",
"description": "The ID of the [TeamMember](https://developer.squareup.com/reference/square_2021-08-18/objects/TeamMember) object representing the team member booked in this segment."
}
}
}
},
"created_at": {
"type": "string",
"description": "The timestamp specifying the creation time of this booking, in RFC 3339 format."
},
"customer_id": {
"type": "string",
"description": "The ID of the [Customer](https://developer.squareup.com/reference/square_2021-08-18/objects/Customer) object representing the customer attending this booking"
},
"customer_note": {
"type": "string",
"description": "The free-text field for the customer to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a relevant [CatalogObject](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogObject) instance."
},
"id": {
"type": "string",
"description": "A unique ID of this object representing a booking."
},
"location_id": {
"type": "string",
"description": "The ID of the [Location](https://developer.squareup.com/reference/square_2021-08-18/objects/Location) object representing the location where the booked service is provided."
},
"seller_note": {
"type": "string",
"description": "The free-text field for the seller to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a specific [CatalogObject](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogObject) instance.\nThis field should not be visible to customers."
},
"start_at": {
"type": "string",
"description": "The timestamp specifying the starting time of this booking, in RFC 3339 format."
},
"status": {
"type": "string",
"description": "The status of the booking, describing where the booking stands with respect to the booking state machine."
},
"updated_at": {
"type": "string",
"description": "The timestamp specifying the most recent update time of this booking, in RFC 3339 format."
},
"version": {
"type": "integer",
"description": "The revision number for the booking used for optimistic concurrency."
}
}
},
"idempotency_key": {
"type": "string",
"description": "A unique key to make this request an idempotent operation."
}
}
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
{
"type": "object",
"properties": {
"booking": {
"type": "object",
"description": "Represents a booking as a time-bound service contract for a seller's staff member to provide a specified service\nat a given location to a requesting customer in one or more appointment segments.",
"properties": {
"appointment_segments": {
"type": "array",
"description": "A list of appointment segments for this booking.",
"items": {
"type": "object",
"description": "Defines an appointment segment of a booking.",
"required": [
"duration_minutes",
"service_variation_id",
"team_member_id",
"service_variation_version"
],
"properties": {
"duration_minutes": {
"type": "integer",
"description": "The time span in minutes of an appointment segment."
},
"service_variation_id": {
"type": "string",
"description": "The ID of the [CatalogItemVariation](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogItemVariation) object representing the service booked in this segment."
},
"service_variation_version": {
"type": "integer",
"format": "int64",
"description": "The current version of the item variation representing the service booked in this segment."
},
"team_member_id": {
"type": "string",
"description": "The ID of the [TeamMember](https://developer.squareup.com/reference/square_2021-08-18/objects/TeamMember) object representing the team member booked in this segment."
}
}
}
},
"created_at": {
"type": "string",
"description": "The timestamp specifying the creation time of this booking, in RFC 3339 format."
},
"customer_id": {
"type": "string",
"description": "The ID of the [Customer](https://developer.squareup.com/reference/square_2021-08-18/objects/Customer) object representing the customer attending this booking"
},
"customer_note": {
"type": "string",
"description": "The free-text field for the customer to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a relevant [CatalogObject](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogObject) instance."
},
"id": {
"type": "string",
"description": "A unique ID of this object representing a booking."
},
"location_id": {
"type": "string",
"description": "The ID of the [Location](https://developer.squareup.com/reference/square_2021-08-18/objects/Location) object representing the location where the booked service is provided."
},
"seller_note": {
"type": "string",
"description": "The free-text field for the seller to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a specific [CatalogObject](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogObject) instance.\nThis field should not be visible to customers."
},
"start_at": {
"type": "string",
"description": "The timestamp specifying the starting time of this booking, in RFC 3339 format."
},
"status": {
"type": "string",
"description": "The status of the booking, describing where the booking stands with respect to the booking state machine."
},
"updated_at": {
"type": "string",
"description": "The timestamp specifying the most recent update time of this booking, in RFC 3339 format."
},
"version": {
"type": "integer",
"description": "The revision number for the booking used for optimistic concurrency."
}
}
},
"errors": {
"type": "array",
"description": "Any errors that occurred during the request.",
"items": {
"type": "object",
"description": "Represents an error encountered during a request to the Connect API.\n\nSee [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) for more information.",
"required": [
"category",
"code"
],
"properties": {
"category": {
"type": "string",
"description": "The high-level category for the error."
},
"code": {
"type": "string",
"description": "The specific code of the error."
},
"detail": {
"type": "string",
"description": "A human-readable description of the error for debugging purposes."
},
"field": {
"type": "string",
"description": "The name of the field provided in the original request (if any) that\nthe error pertains to."
}
}
}
}
}
}