get
https://api.zenoti.com/v1/guests/guest_id/Packages?center_id=&show_redeemable=&page_num=&page_size=
This API lists the details of the Series packages that a particular guest has bought or redeemed from a specific center.
You need to provide details for the following parameters: guest_id, center_id, show redeemable, page_num, and page_size.
This API does not provide information on the Day packages that the guest has bought or redeemed at a center.
Response Details
| Name | Type | Description |
|---|---|---|
| user_package_id | guid | Unique 32-character ID of the package that the guest bought or redeemed at the center. |
| user_package_state | enum | Indicates the state details of the package: Closed = 0, Open = 1, WithProcessing = 2, and Default = -1. |
| redeemable | bool? | Indicates whether the guest can redeem a package at the center. |
| invoice | object | An object that contains the list of invoice elements. For more information, refer the invoice Object table below. |
| status | enum | Indicates the status details of the package: Active = 1, Frozen = 3, Expired = 5, CancelledRefund = 6, NotStarted = 7, NotApplicable = 8, and Default = -1 |
| package | object | An object that contains the list of package elements. For more information, refer the package Object table below. |
| date | object | An object that contains the list of date elements. For more information, refer the invoice Object table below. |
| products | object | An object that contains the list of product elements. For more information, refer the products Object table below. |
| services | object | An object that contains the list of service elements. For more information, refer the services Object table below. |
| redemption_setting_details | object | An object that contains the list of redemption setting elements. For more information, refer the redemption_setting_details Object table below |
invoice Object
| Name | Type | Description |
|---|---|---|
| status | enum | Indicates the status details of the package invoice: Open = 0, Processed = 1, Closed = 4, NotSpecified = 11, Default = 12, and Void = 13. |
| receipt_no | string | Receipt number of the package invoice. |
| id | guid | Unique 32-character ID of the receipt of the package invoice. |
| no | string | Number of the package invoice. |
package Object
| Name | Type | Description |
|---|---|---|
| type | enum | Indicates the type of package: Regular = 0, Custom = 1, Offer = 2, and CustomOffer = 3. |
| id | guid | Unique 32-character ID of the package. |
| name | string | Name of the package. |
date Object
| Name | Type | Description |
|---|---|---|
| end_date_with_grace | datetime | Expiry date and time of the package including the grace period. |
| start | datetime | Date and time on which the package was created. |
| end | datetime | Expiry date and time of the package. |
products Object
| Name | Type | Description |
|---|---|---|
| product_type_info | object | Object that contains the following information about the product that is added to the package: product_category_type, name, and id. |
| product_category_type | enum | Indicates the category type of the product: Category = 1, Product = 2, and Tags = 3. |
| name | string | Name of the product. |
| id | guid | Unique 32-character ID of the product. |
| exists_in_current_center | bool | Indicates whether the product is available at the current center. |
| total | int | Total number of products that the guest can buy as part of the package. |
| used | int | Number of products that the guest has bought as part of the package. |
| balance | int | Remaining number of products that the guest can avail as part of the package. |
| balance_amount | decimal | Remaining balance price of the products that the guest can buy as part of the package. |
| price | object | Product price object that contains: currency_id, sales, tax, and final. |
| currency_id | int | Unique ID of the currency in which the product price is displayed. |
| sales | decimal | Price of the product (excluding the tax amount). |
| tax | decimal | Tax amount that is added to the price of the product. |
| final | decimal | Final price (including the tax amount) of the product. |
services Object
| Name | Type | Description |
|---|---|---|
| service_type_info | object | Object that contains the following information about the service that is added to the package: service_category_type, id, name, duration, and has_segments. |
| service_category_type | enum | Indicates the category type of the service: Default = -1, Category = 1, Service = 2, and Tag = 3. |
| id | guid | Unique 32-character ID of the service. |
| name | string | Name of the service. |
| duration | int | Time duration of the service. |
| has_segments | bool | Indicates whether the service contains any segments. |
| exists_in_current_center | bool | Indicates whether the service is available at the current center. |
| total | int | Total number of services that the guest can avail as part of the package. |
| used | int | Number of services that the guest has availed as part of the package. |
| balance | int | Remaining number of services that the guest can avail as part of the package. |
| balance_amount | decimal | Remaining balance price of the services that the guest can avail as part of the package. |
| price | object | Service price object that contains: currency_id, sales, tax, and final. |
| currency_id | int | Unique ID of the currency in which the service price is displayed. |
| sales | decimal | Price of the service (excluding the tax amount). |
| tax | decimal | Tax amount that is added to the price of the service. |
| final | decimal | Final price (including the tax amount) of the service. |
| package_service_price | decimal | Total price of the service. |
| sale_as_part_of_package_or_membership_only | bool? | Indicates whether services can only be sold as part of a package or membership. |
| book_with_partial_balance | enum | Indicates whether the guest can book an add-on service with the package by using partial balance: NotApplicable = 1, Block = 2, and AllowWithWarning = 3. |
redemption_setting_details Object
| Name | Type | Description |
|---|---|---|
| total_payment | decimal | Total amount that the guest paid to buy the package. |
| intial_recognized_revenue | decimal | Initial recognized revenue that the guest can use for a package. |
| service_frequency_factor | decimal | Frequency of the recurring service (bundled with the package) that the guest must avail. |
| closed | boolean | Indicates whether the use of the package is currently suspended for the guest. |
| allowed_redeemable_amount_for_partial_payment | decimal | Total redeemable amount that the guest can use to make a partial payment for the package. |
| is_frozen | boolean | Indicates whether the package is frozen for the guest for a certain period of time. |
| has_products | boolean | Indicates whether the package contains any bundled products. |
| partial_payment_without_initially_recognized_amount | decimal | Partial amount that the guest can pay for the package, without including the initially recognized amount. |
| restrict_redemption_in_this_center | boolean | If this is true (1), guests can redeem a package only at the center from which they bought it. If false (0), guests can redeem the package at any center. |
| center_name | string | Center from which the guest bought or redeemed the package. |