Sign in

v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

List all packages of a center

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.

get/v1/centers/{center_id}/packages

Path parameters

center_idstring required

Mandatory Unique 32-character identifier of the center.

Query parameters

appointment_datestring date

Optional Date of the appointment.

type''

Optional Indicates the type of package: DayPackage - 1, SeriesPackage - 2, PromoPackage - 3.

excludeServicesboolean

Optional Indicates whether any services are to be excluded from the package.

blockServiceLevelTaxPackagesboolean

Optional Indicates whether any service-level tax packages are to be blocked.

pageinteger

Optional Number of the display page. Default value is 1.

sizeinteger

Optional Number of records per page. Default value is 10.

show_in_catalogboolean

Optional Indicates whether the package is displayed on the Catalog tab. Default value is false.

expandstring

Expands specific sections of the package details such as centers, catalog_info, preferences, benefits, tags.

category_idinteger

Filter packages by category.

search_textstring

Text filter to search packages by name or description.

is_activeboolean

Returns only active packages when true.

PackageType''

Filters results by package type (e.g., Day, Series, Promo).

series_package_type''

Type of the series package (e.g., Regular, Offer, Custom).

member_priceboolean

Include member pricing in the response. Returns discount_price for eligible guests.

guest_idinteger

Guest identifier to determine member pricing when using an API key. Must be used with member_price=true.

is_giftcard_enabledboolean

Include only day packages that can be sold as gift cards.

Response

200

OR

Example response

{
  "packages": [
    {
      "id": "960c75ea-e632-45fd-ba11-a5566cb6acda",
      "code": "bp1",
      "name": "belu pack1",
      "description": "belu pack1",
      "type": 2,
      "category_id": "1db904e6-71da-4911-9f11-ad4cfa0a060f",
      "Business_unit_id": "708fb934-4fa1-4e55-ab4d-21a083454893",
      "version_id": "0b5d4cbc-2065-48b0-ad4f-4828633c055b",
      "html_description": "belu+pack1",
      "time": 15,
      "booking_start_date": "2017-03-21T00:00:00",
      "booking_end_date": "2020-03-01T00:00:00",
      "commission": {
        "eligible": true,
        "factor": 100
      },
      "preferences": {
        "allow_giftcard_redemption": true
      },
      "catalog_info": {
        "show_in_catalog": true,
        "can_book": true,
        "show_price": true,
        "display_name": "belu pack1 - web",
        "display_price": "100"
      },
      "centers": [
        {
          "center_id": "64b05ce4-ecfd-4478-bb42-b7378194bfa8",
          "currency_id": 61,
          "sale_price": 100
        }
      ],
      "benefits": {
        "services": [
          {
            "id": "6f7c8b4c-4344-4375-8af5-a0ecc673d568",
            "item_type": 2,
            "quantity": 3,
            "order": -1,
            "recognize_revenue": true
          }
        ]
      }
    }
  ],
  "page_info": {
    "total": 27,
    "page": 1,
    "size": 10
  }
}