get
https://api.zenoti.com/v1/centers//packages
This API helps you to retrieve all the packages that are active in the center. You must specify the unique identifier of the center as center_id in the API request.You can also leverage the pagination feature by passing page and size query parameters if you have a large number of records to be displayed. By default, page is set as 1 and size is set as 10. size cannot be more than 100: which means that the maximum records per page cannot be more than 100.
Response Details
| Name | Type | Description |
|---|---|---|
| packages | object | Object that contains all the packages-related elements. |
| page_info | object | Object that contains all the display page-related elements. |
| error | object | Object that contains error message and error code details. For more information, refer to the error Object table. |
| code | message |
|---|---|
| 401 | Authorization has been denied for this request. |
| 502 | invalid center_id. |
| 400 | The request is invalid. |
ListPackageInfo
| Json property | Data type | Description |
|---|---|---|
| packages | List | List of package info objects. |
| page_info | PaginationDetailsViewModel | Contains page information. |
| error |
packages object (PackageInfo)
| Json property | Data type | Description |
|---|---|---|
| id | Guid | ID of the package. |
| code | string | Code of the package. |
| name | string | Name of the package. |
| description | string | Description of the package. |
| type | PackageType | Package type: day, series, or promo. |
| active | bool | Indicates whether the package is active. |
| category_id | Guid? | Category ID of the package. |
| business_unit_id | Guid? | Business unit ID of the package. |
| version_id | Guid | Version ID of the package. |
| html_description | string | HTML description content. |
| time | int | Package length in minutes. |
| booking_start_date | DateTime? | Booking start date. |
| booking_end_date | DateTime? | Booking end date. |
| sac | string | SAC of the package. Ignored when null. |
| commission | PackageComission | Commission details of the package. |
| day_package | DayPackageInfo | Day package details. Ignored when null. |
| promo_package | PromoPackageInfo | Promo package details. Ignored when null. |
| series_package | SeriesPAckageInfo | Series package details. Ignored when null. |
| preferences | PackagePreferences | Package settings and preferences. |
| catalog_info | ServiceCatalogInfo | Catalog information of the package. |
| centers | List | Center pricing details for the package. |
| tags | List | Tag IDs linked to the package. |
| benefits | Benefits | Services, products, and bundled products. |
| discounts | Discounts | For future use. Ignored when null. |
| internal | ProductInfoInternal | Internal-only information. Ignored when null. |
centers object (PackagePriceInfo)
| Json property | Data type | Description |
|---|---|---|
| center_id | Guid | Center identifier. |
| currency_id | int | Currency identifier. |
| sale_price | decimal | Sale price at the center. |
| price_with_tax | decimal | Price including tax. |
| tax_id | Guid? | Tax identifier of the center. |
| auto_renewal | bool | Auto renewal price setting. |
| discount_price | decimal? | Final member price when applicable. |
SeriesPAckageInfo
| Json property | Data type | Description |
|---|---|---|
| type | SeriesPackageType | Series package type. |
| cost_to_center | decimal? | Cost of the package to the center. |
| initial_recognization | decimal | Initial revenue recognition value. |
| schedule | PackageSchedule | Schedule details of the package. |
| freeze_count | int | Allowed freeze count. |
| validity | SeriesPackageValidityInfo | Validity details of the package. |
| validate_first_redemption | bool | Start validity from first redemption. |
| transfer_service_credits | bool | Whether service credits are transferable. |
| terms_and_conditions | string | Terms and conditions text. |
| regular | RegularSeriesPackageInfo | Regular series package details. |
| offer | OfferSeriesPackageInfo | Offer series package details. |
| custom_template | CustomSeriesPackageInfo | Custom series package template details. |
PackagePreferences
| Json property | Data type | Description |
|---|---|---|
| allow_cancellation_fee | bool | Allow cancellation fee. |
| allow_cancellation_comission | bool | Allow cancellation commission. |
| allow_no_show_fee | bool | Allow no-show fee. |
| allow_no_show_comission | bool | Allow no-show commission. |
| allow_membership_redemption | bool | Allow membership redemption. |
| allow_giftcard_redemption | bool | Allow gift card redemption. |
| enforce_otp | bool | Enforce OTP for package redemption. |
PackageComission
| Json property | Data type | Description |
|---|---|---|
| eligible | bool | Indicates commission eligibility. |
| factor | decimal | Commission factor. |
| type | PackageComissionTypes | Type of commission. |
| value | decimal | Commission value. |
PackageSchedule
| Json property | Data type | Description |
|---|---|---|
| days_for_first_payment | int? | Days until first payment starts. |
| payment_frequency | int? | Payment frequency count. |
| payment_frequency_type | int? | Frequency type: days or months. |
| number_of_instalments | int? | Number of installments. |
RegularSeriesPackageInfo
| Json property | Data type | Description |
|---|---|---|
| min_partial_payment | decimal | Minimum partial payment amount. |
| price_inclusive_of_bundled_products | bool | Include bundled products in price. |
| appointment_start_time | string | Booking start time. |
| appointment_end_time | string | Booking end time. |
| target | PackageTarget | Target details for the package. |
PackageTarget
| Json property | Data type | Description |
|---|---|---|
| target_name | string | Name of the target. |
| target_type | int? | Type of the target. |
| target_value | decimal? | Value of the target. |
| close_when_target_met | bool | Close when target services are met. |
SeriesPackageValidityInfo
| Json property | Data type | Description |
|---|---|---|
| expiry_date | DateTime? | Expiry date of the package. |
| expiry | int? | Expires after these many days. |
| grace_period | string | Grace period settings. |
| validity_id | string | Package validity identifier. |
PackageServiceInfo
| Json property | Data type | Description |
|---|---|---|
| id | Guid | Service identifier. |
| item_type | int | Category, service, or tag type. |
| quantity | int | Quantity of the item. |
| order | int | Display order. |
| recognize_revenue | bool | Recognize revenue for this item. |
PackageProductInfo
| Json property | Data type | Description |
|---|---|---|
| id | Guid | Product identifier. |
| item_type | int | Category, product, or tag type. |
| quantity | int | Quantity of the item. |
Enum: PackageComissionTypes
| Name | Value | Description |
|---|---|---|
| comission_settings | 1 | Use commission settings. |
| flat_amount | 2 | Flat amount commission. |
| revenue_percentage | 3 | Revenue percentage commission. |