post
https://api.zenoti.com/v1/classes//registrations
Purpose: Use this API to register a guest for a class.
You must specify class_id as path params and mention the following in the body params - Check the body params section for more details.
Response Object
| Name | Type | Description |
|---|---|---|
| registrations | object | Object containing the guest's registration details. |
registrations Object
| Name | Type | Description |
|---|---|---|
| id | long | Identifier of the registration. |
| invoice_id | guid | Unique identifier of the invoice. |
| app_group_id | guid | Unique identifier of the appointment group id. |
| status | enum | Status of the registration. |
| custom_form_status | enum | Status of the custom form used in the registration of the guest. |
| guest_form_status | enum | Status of the guest form used in the registration. |
| membership_balance | object | (optional) Object containing the membership balance details. |
| guest_registrations | object | Object containing the details of the guest registering for the class. |
| group_invoice_id | guid | Unique identifier of the group invoice. |
guest_registrations Object
| Name | Type | Description |
|---|---|---|
| id | long | Identifier of the guest registration. |
| guest_id | guid | Unique identifier of the guest. |
| invoice_id | guid | Unique identifier of the invoice. |
| app_group_id | guid | Unique identifier of the appointment group id |
| custom_form_status | enum | Status of the custom form used in the regis |
| guest_form_status | enum | Status of the guest form used i |
| is_virtual_guest | bool | Denotes if the guest is a virtual guest. |
membership_balance Object
| Name | Type | Description |
|---|---|---|
| membership_name | string | Name of the guest's membership. |
| benefit_details | object | membership_balance - expand parameter |
| quantity | float | Quantity of the guest's membership. |
| frequency | string | Service frequency in the membership. |
| expiry_days | int | Days of validity post which the membership will expire. |
| used | double | Membership credits used. |
| notes | string | Notes on the membership. |
| allow_direct_booking | bool | Denotes if the guest is allowed to book directly |
| has_equivalents | bool | Denotes if the membership has any equivalents. |
| balance | double | Membership balance. |
| is_category | bool | Denotes the category of the membership. |
| discount_details | object | MembershipBenefitDiscountModelV1 - expand parameter |
| all_services | bool | Denotes if the membership includes all services. |
| is_addon | bool | Denotes if the services in the membership are addons. |
| redeemable_balance | double | The remaining balance in the guest's membership. |
MembershipBenefitDiscountModelV1 Object
| Name | Type | Description |
|---|---|---|
| discount_type | enum | Type of discount provided on the membership. (Percentage = 0, Flat = 1) |
| peak_discount | decimal | Discount offered during the peak hours. |
| off_peak_discount | decimal | Discount offered during the off peak hours. |
| post_credit_peak_discount | decimal | Discount offered after the service credits during peak hours. |
| post_credit_off_peak_discount | decimal | Discount offered after the service credits during off peak hours. |