v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

List the Series Packages of a Guest

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.

get/v1/guests/guest_id/Packages?center_id={center_id}&show_redeemable={true/false}&page_num={page_num}&page_size={page_size}

Path parameters

guest_idstring required

Mandatory Unique 32-character ID of a specific guest.

Query parameters

center_idstring

Optional Unique 32-character ID of a specific center. If you specify the required details for center_id in the request, the API will list only those packages that can be redeemed at this particular center. If you do not pass the center_id parameter in the request, the API will list all the packages that the guest has purchased in all centers.

show_redeemableboolean

Optional Indicates whether the guest can redeem packages at the specific center. If you do not provide a value for 'center_id', this field is considered as 'false'. You must provide a boolean value for this parameter.

page_numinteger

Optional The number of pages on which you want the guest's package records to be retrieved and displayed. Send ‘-1’ to show all the package records of the guest, irrespective of page number. You must provide an integer value for this parameter.

page_sizeinteger

Optional The number of the guest's package records that you want to be retrieved and displayed per page. Send ‘0’ to retrieve all package records of the guest. You must provide an integer value for this parameter.

Response

200