Get Packages by Category
Search for all packages within a single category.
zapiGetPackagesByCategoryId
GET https://{yourdomainname}.zaui.net/zapi/
Request Body
Name
Type
Description
zapiToken*
integer
Token that must be used for a reseller to communicate with the supplier system.
zapiAccountId*
integer
Generated by the supplier system.
zapiUserId*
integer
Generated by the supplier system when a new contact is created.
methodName*
string
The method being called.
categoryId*
integer
ID of the category.
verboseMode
string
True or False. Using this flag will curtail the amount of detail provided in the response.
<?xml version="1.0" encoding="utf-8"?>
<response>
<zapiVersion>2.1</zapiVersion>
<error>0</error>
<message>OK</message>
<methodResponse>
<methodName>zapiGetPackagesByCategoryId</methodName>
<methodErrorCode>0</methodErrorCode>
<methodErrorMessage>OK</methodErrorMessage>
<verboseMode>false</verboseMode>
<categoryId>3</categoryId>
<categoryName>
<![CDATA[The Best of London]]>
</categoryName>
<imageUrl>
<![CDATA[https://suppliertestsystem.zaui.net/themes/default/img/image_not_available.png]]>
</imageUrl>
<description>
<![CDATA[]]>
</description>
<packages>
<package>
<packageId>4</packageId>
<imageUrl>
<![CDATA[https://zaui.azureedge.net/application/suppliertestsystem/data/packageImages/4-10018.jpg?v=1632420621]]>
</imageUrl>
<packageType>0</packageType>
<allowsOpenDatedActivities>0</allowsOpenDatedActivities>
<enforceOpenDatesInSequencialOrder>0</enforceOpenDatesInSequencialOrder>
<categoryId>3</categoryId>
<packageName>
<![CDATA[The Best of London]]>
</packageName>
<description>
<![CDATA[]]>
</description>
<shortDescription>
<![CDATA[]]>
</shortDescription>
<packageStartDate>2021-09-23</packageStartDate>
<packageEndDate>2022-09-23</packageEndDate>
<priceCodeId>448</priceCodeId>
<allowedPassengers>
<passengerType>
<systemTypeId>10</systemTypeId>
<systemTypeName>seniors</systemTypeName>
<name>
<![CDATA[Seniors]]>
</name>
<defaultValue>0</defaultValue>
<basePrice>$65.00</basePrice>
</passengerType>
<passengerType>
<systemTypeId>11</systemTypeId>
<systemTypeName>adults</systemTypeName>
<name>
<![CDATA[Adults]]>
</name>
<defaultValue>2</defaultValue>
<basePrice>$90.00</basePrice>
</passengerType>
<passengerType>
<systemTypeId>12</systemTypeId>
<systemTypeName>students</systemTypeName>
<name>
<![CDATA[Students]]>
</name>
<defaultValue>0</defaultValue>
<basePrice>$65.00</basePrice>
</passengerType>
<passengerType>
<systemTypeId>13</systemTypeId>
<systemTypeName>children</systemTypeName>
<name>
<![CDATA[Children]]>
</name>
<defaultValue>0</defaultValue>
<basePrice>$50.00</basePrice>
</passengerType>
<passengerType>
<systemTypeId>14</systemTypeId>
<systemTypeName>infants</systemTypeName>
<name>
<![CDATA[Infants]]>
</name>
<defaultValue>0</defaultValue>
<basePrice>$0.00</basePrice>
</passengerType>
</allowedPassengers>
<activities>
<activity>
<categoryName>
<![CDATA[Canyon Walks]]>
</categoryName>
<categoryId>8</categoryId>
<activityName>
<![CDATA[Canyon Icewalk ]]>
</activityName>
<activityId>80</activityId>
<activityDate>2021-11-25</activityDate>
<activityTypeId>500</activityTypeId>
<activityTypeAsString>Regular</activityTypeAsString>
<activityTypeSubType>FIXEDTIME</activityTypeSubType>
<activityIsMultiday>false</activityIsMultiday>
<activityMultiDayStart/>
<activityMultiDayDuration>0</activityMultiDayDuration>
<activityTimeDuration>0</activityTimeDuration>
<activityTimeDurationUnits>minutes</activityTimeDurationUnits>
<isFreeSell>false</isFreeSell>
</activity>
<activity>
<categoryName>
<![CDATA[Walking Tours]]>
</categoryName>
<categoryId>33</categoryId>
<activityName>
<![CDATA[Harry Potter Magical Walking Tour]]>
</activityName>
<activityId>123</activityId>
<activityDate>2021-11-25</activityDate>
<activityTypeId>500</activityTypeId>
<activityTypeAsString>Regular</activityTypeAsString>
<activityTypeSubType>FIXEDTIME</activityTypeSubType>
<activityIsMultiday>false</activityIsMultiday>
<activityMultiDayStart/>
<activityMultiDayDuration>0</activityMultiDayDuration>
<activityTimeDuration>0</activityTimeDuration>
<activityTimeDurationUnits>minutes</activityTimeDurationUnits>
<isFreeSell>false</isFreeSell>
</activity>
</activities>
<products/>
</package>
<package>
<packageId>5</packageId>
<imageUrl>
<![CDATA[https://suppliertestsystem.zaui.net/themes/default/img/image_not_available.png]]>
</imageUrl>
<packageType>1</packageType>
<allowsOpenDatedActivities>0</allowsOpenDatedActivities>
<enforceOpenDatesInSequencialOrder>0</enforceOpenDatesInSequencialOrder>
<categoryId>3</categoryId>
<packageName>
<![CDATA[The Best of London (Multi-Day)]]>
</packageName>
<description>
<![CDATA[]]>
</description>
<shortDescription>
<![CDATA[]]>
</shortDescription>
<packageStartDate>2021-11-19</packageStartDate>
<packageEndDate>2022-11-19</packageEndDate>
<priceCodeId>448</priceCodeId>
<allowedPassengers>
<passengerType>
<systemTypeId>10</systemTypeId>
<systemTypeName>seniors</systemTypeName>
<name>
<![CDATA[Seniors]]>
</name>
<defaultValue>0</defaultValue>
<basePrice>$65.00</basePrice>
</passengerType>
<passengerType>
<systemTypeId>11</systemTypeId>
<systemTypeName>adults</systemTypeName>
<name>
<![CDATA[Adults]]>
</name>
<defaultValue>2</defaultValue>
<basePrice>$90.00</basePrice>
</passengerType>
<passengerType>
<systemTypeId>12</systemTypeId>
<systemTypeName>students</systemTypeName>
<name>
<![CDATA[Students]]>
</name>
<defaultValue>0</defaultValue>
<basePrice>$65.00</basePrice>
</passengerType>
<passengerType>
<systemTypeId>13</systemTypeId>
<systemTypeName>children</systemTypeName>
<name>
<![CDATA[Children]]>
</name>
<defaultValue>0</defaultValue>
<basePrice>$50.00</basePrice>
</passengerType>
<passengerType>
<systemTypeId>14</systemTypeId>
<systemTypeName>infants</systemTypeName>
<name>
<![CDATA[Infants]]>
</name>
<defaultValue>0</defaultValue>
<basePrice>$0.00</basePrice>
</passengerType>
</allowedPassengers>
<multiDayItineraries>
<multiDayItinerary>
<startDate>2021-11-19</startDate>
<endDate>2022-11-19</endDate>
<priceCodeId>448</priceCodeId>
<days>
<day>
<activities>
<activity>
<categoryName>
<![CDATA[Canyon Walks]]>
</categoryName>
<categoryId>8</categoryId>
<activityName>
<![CDATA[Canyon Icewalk ]]>
</activityName>
<activityId>80</activityId>
<activityDate>2021-11-25</activityDate>
<activityTypeId>500</activityTypeId>
<activityTypeAsString>Regular</activityTypeAsString>
<activityTypeSubType>FIXEDTIME</activityTypeSubType>
<activityIsMultiday>false</activityIsMultiday>
<activityMultiDayStart/>
<activityMultiDayDuration>0</activityMultiDayDuration>
<activityTimeDuration>0</activityTimeDuration>
<activityTimeDurationUnits>minutes</activityTimeDurationUnits>
<isFreeSell>false</isFreeSell>
</activity>
</activities>
<products/>
</day>
<day>
<activities>
<activity>
<categoryName>
<![CDATA[Walking Tours]]>
</categoryName>
<categoryId>33</categoryId>
<activityName>
<![CDATA[Harry Potter Magical Walking Tour]]>
</activityName>
<activityId>123</activityId>
<activityDate>2021-11-26</activityDate>
<activityTypeId>500</activityTypeId>
<activityTypeAsString>Regular</activityTypeAsString>
<activityTypeSubType>FIXEDTIME</activityTypeSubType>
<activityIsMultiday>false</activityIsMultiday>
<activityMultiDayStart/>
<activityMultiDayDuration>0</activityMultiDayDuration>
<activityTimeDuration>0</activityTimeDuration>
<activityTimeDurationUnits>minutes</activityTimeDurationUnits>
<isFreeSell>false</isFreeSell>
</activity>
</activities>
<products/>
</day>
</days>
</multiDayItinerary>
</multiDayItineraries>
<activities/>
<products/>
</package>
</packages>
</methodResponse>
</response><request>
<zapiToken></zapiToken>
<zapiAccountId></zapiAccountId>
<zapiUserId></zapiUserId>
<zapiMethod>
<methodName>zapiGetPackagesByCategoryId</methodName>
<categoryId></categoryId>
<verboseMode></verboseMode>
</zapiMethod>
</request><?xml version="1.0" encoding="utf-8"?>
<response>
<zapiVersion>2.1</zapiVersion>
<error>0</error>
<message>OK</message>
<methodResponse>
<methodName>zapiGetPackagesByCategoryId</methodName>
<methodErrorCode>0</methodErrorCode>
<methodErrorMessage>OK</methodErrorMessage>
<verboseMode>true</verboseMode>
<categoryId></categoryId>
<categoryName></categoryName>
<imageUrl></imageUrl>
<description></description>
<packages>
<package>
<packageId></packageId>
<imageUrl></imageUrl>
<packageType></packageType>
<allowsOpenDatedActivities></allowsOpenDatedActivities>
<enforceOpenDatesInSequencialOrder>0</enforceOpenDatesInSequencialOrder>
<categoryId></categoryId>
<packageName></packageName>
<description></description>
<shortDescription></shortDescription>
<packageStartDate></packageStartDate>
<packageEndDate></packageEndDate>
<priceCodeId></priceCodeId>
<allowedPassengers>
<passengerType>
<systemTypeId></systemTypeId>
<systemTypeName>adults</systemTypeName>
<name></name>
<defaultValue></defaultValue>
<basePrice></basePrice>
</passengerType>
</allowedPassengers>
<activities>
<activity>
<categoryName></categoryName>
<categoryId></categoryId>
<activityName></activityName>
<activityId></activityId>
<activityDate></activityDate>
<activityTypeId></activityTypeId>
<activityTypeAsString></activityTypeAsString>
<activityTypeSubType></activityTypeSubType>
<activityIsMultiday></activityIsMultiday>
<activityMultiDayStart></activityMultiDayStart>
<activityMultiDayDuration></activityMultiDayDuration>
<activityTimeDuration></activityTimeDuration>
<activityTimeDurationUnits></activityTimeDurationUnits>
<isFreeSell></isFreeSell>
<supplierConfirmationNumberSystemManaged></supplierConfirmationNumberSystemManaged>
<supplierConfirmationNumberDisplayed></supplierConfirmationNumberDisplayed>
<operatedByCompanyId></operatedByCompanyId>
<operatedByCompanyName></operatedByCompanyName>
<ticketExpiry/>
<ticketPrinterText></ticketPrinterText>
<description></description>
<shortDescription></shortDescription>
<imageUrl></imageUrl>
<activityTimes>
<activityTime>
<activityTimeStart></activityTimeStart>
<activityTimeCancelled></activityTimeCancelled>
<activityTimeAvailable></activityTimeAvailable>
<activityTimeCancelledOnlineOnly></activityTimeCancelledOnlineOnly>
<activityTimeAvailableMessage></activityTimeAvailableMessage>
<inventoryCheckCode></inventoryCheckCode>
<inventoryCheckMessage></inventoryCheckMessage>
<activityTimeSpotsRemaining></activityTimeSpotsRemaining>
<numberOnStandby></numberOnStandby>
<isStandbyAvailable></isStandbyAvailable>
<status></status>
<fixedDepartureOptions/>
</activityTime>
</activityTimes>
<daysOfWeekAvailable>
<dateRange>
<startDate></startDate>
<daysOfWeek>
<sunday></sunday>
<monday></monday>
<tuesday></tuesday>
<wednesday></wednesday>
<thursday></thursday>
<friday></friday>
<saturday></saturday>
</daysOfWeek>
<endDate></endDate>
</dateRange>
</daysOfWeekAvailable>
<businessHours>
<hours>
<startDate></startDate>
<openingTime></openingTime>
<closingTime></closingTime>
<endDate></endDate>
</hours>
</businessHours>
<pickupLocations></pickupLocations>
<dropOffLocations></dropOffLocations>
<pricingOptions></pricingOptions>
<priceCodeId></priceCodeId>
<allowedPassengers>
<passengerType>
<systemTypeId></systemTypeId>
<systemTypeName>adults</systemTypeName>
<name></name>
<defaultValue></defaultValue>
<basePrice></basePrice>
</passengerType>
<passengerType>
<systemTypeId></systemTypeId>
<systemTypeName>students</systemTypeName>
<name></name>
<defaultValue></defaultValue>
<basePrice></basePrice>
</passengerType>
<passengerType>
<systemTypeId></systemTypeId>
<systemTypeName>children</systemTypeName>
<name></name>
<defaultValue></defaultValue>
<basePrice></basePrice>
</passengerType>
<passengerType>
<systemTypeId></systemTypeId>
<systemTypeName>infants</systemTypeName>
<name></name>
<defaultValue></defaultValue>
<basePrice></basePrice>
</passengerType>
</allowedPassengers>
<sharedInventoryDetails>
<isParent></isParent>
</sharedInventoryDetails>
</activity>
<activity>
<categoryName></categoryName>
<categoryId></categoryId>
<activityName></activityName>
<activityId></activityId>
<activityDate></activityDate>
<activityTypeId></activityTypeId>
<activityTypeAsString></activityTypeAsString>
<activityTypeSubType></activityTypeSubType>
<activityIsMultiday></activityIsMultiday>
<activityMultiDayStart/>
<activityMultiDayDuration></activityMultiDayDuration>
<activityTimeDuration></activityTimeDuration>
<activityTimeDurationUnits></activityTimeDurationUnits>
<isFreeSell></isFreeSell>
<supplierConfirmationNumberSystemManaged></supplierConfirmationNumberSystemManaged>
<supplierConfirmationNumberDisplayed></supplierConfirmationNumberDisplayed>
<operatedByCompanyId></operatedByCompanyId>
<operatedByCompanyName></operatedByCompanyName>
<ticketExpiry/>
<ticketPrinterText></ticketPrinterText>
<description></description>
<shortDescription></shortDescription>
<imageUrl></imageUrl>
<activityTimes>
<activityTime>
<activityTimeStart></activityTimeStart>
<activityTimeCancelled></activityTimeCancelled>
<activityTimeAvailable></activityTimeAvailable>
<activityTimeCancelledOnlineOnly></activityTimeCancelledOnlineOnly>
<activityTimeAvailableMessage></activityTimeAvailableMessage>
<inventoryCheckCode></inventoryCheckCode>
<inventoryCheckMessage></inventoryCheckMessage>
<activityTimeSpotsRemaining></activityTimeSpotsRemaining>
<numberOnStandby></numberOnStandby>
<isStandbyAvailable></isStandbyAvailable>
<status></status>
<fixedDepartureOptions/>
</activityTime>
</activityTimes>
<daysOfWeekAvailable>
<dateRange>
<startDate></startDate>
<daysOfWeek>
<sunday></sunday>
<monday></monday>
<tuesday></tuesday>
<wednesday></wednesday>
<thursday></thursday>
<friday></friday>
<saturday></saturday>
</daysOfWeek>
<endDate></endDate>
</dateRange>
</daysOfWeekAvailable>
<businessHours>
<hours>
<startDate></startDate>
<openingTime></openingTime>
<closingTime></closingTime>
<endDate></endDate>
</hours>
</businessHours>
<pickupLocations/>
<dropOffLocations/>
<pricingOptions/>
<priceCodeId></priceCodeId>
<allowedPassengers>
<passengerType>
<systemTypeId></systemTypeId>
<systemTypeName>seniors</systemTypeName>
<name></name>
<defaultValue></defaultValue>
<basePrice></basePrice>
</passengerType>
<passengerType>
<systemTypeId></systemTypeId>
<systemTypeName>adults</systemTypeName>
<name></name>
<defaultValue></defaultValue>
<basePrice></basePrice>
</passengerType>
<passengerType>
<systemTypeId></systemTypeId>
<systemTypeName>students</systemTypeName>
<name></name>
<defaultValue></defaultValue>
<basePrice></basePrice>
</passengerType>
<passengerType>
<systemTypeId></systemTypeId>
<systemTypeName>children</systemTypeName>
<name></name>
<defaultValue></defaultValue>
<basePrice></basePrice>
</passengerType>
<passengerType>
<systemTypeId></systemTypeId>
<systemTypeName>infants</systemTypeName>
<name></name>
<defaultValue></defaultValue>
<basePrice></basePrice>
</passengerType>
</allowedPassengers>
<sharedInventoryDetails>
<isParent></isParent>
</sharedInventoryDetails>
</activity>
</activities>
<products></products>
</package>
</packages>
</methodResponse>
</response>Last updated
Was this helpful?