{"version":1,"pages":[{"id":"-MSk3qWqilCXVDwTPjK_","title":"Supplier API (ZAPI)","pathname":"/zapi","siteSpaceId":"sitesp_i5rBD","description":"API documentation for deep integration with a single Zaui platform instance","breadcrumbs":[{"label":"Getting Started"}]},{"id":"-MT75QLYqErp750IzJZc","title":"Getting Started","pathname":"/zapi/getting-started/getting-started","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"Getting Started"}]},{"id":"Wkx54uAfYwDVuchrsv3N","title":"Implementing Exponential Back-Off","pathname":"/zapi/getting-started/getting-started/implementing-exponential-back-off","siteSpaceId":"sitesp_i5rBD","description":"Exponential back-off is the process of a client periodically retrying a failed request over an increasing amount of time. It is a standard error handling strategy for network applications.","breadcrumbs":[{"label":"Getting Started"},{"label":"Getting Started"}]},{"id":"-MT7WqrzWrOdbkl4W8aK","title":"API Specification","pathname":"/zapi/getting-started/api-specification","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"Getting Started"}]},{"id":"LWERpKVYY5MS8NBhDCcl","title":"API Specification Enhancements","pathname":"/zapi/getting-started/api-specification-enhancements","siteSpaceId":"sitesp_i5rBD","description":"New enhancements to the API will be added directly here.","breadcrumbs":[{"label":"Getting Started"}]},{"id":"nC5hHKJLmvHjKT5WXwXK","title":"Glossary of Terms","pathname":"/zapi/getting-started/glossary-of-terms","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"Getting Started"}]},{"id":"BX5CATMF2bAVHKWW1J0C","title":"Supporting Nodes","pathname":"/zapi/supporting-nodes/supporting-nodes","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"Supporting Nodes"}]},{"id":"yAd8zSIXqNH70SV2VW9t","title":"Single Booking Details","pathname":"/zapi/supporting-nodes/supporting-nodes/single-booking-details","siteSpaceId":"sitesp_i5rBD","description":"When retrieving details for a single activity node, using various request calls in the system, Zaui will return a described single booking activity node in the following way:","breadcrumbs":[{"label":"Supporting Nodes"},{"label":"Supporting Nodes"}]},{"id":"9G3xT1gg0JsMIN4NPPfp","title":"Currencies","pathname":"/zapi/supporting-nodes/supporting-nodes/currencies","siteSpaceId":"sitesp_i5rBD","description":"Since users of the back office system in Zaui can configure currencies, based on the sale dates in the system, the API will return:","breadcrumbs":[{"label":"Supporting Nodes"},{"label":"Supporting Nodes"}]},{"id":"mrbOkcRI90H1xL49niRl","title":"Cart","pathname":"/zapi/supporting-nodes/supporting-nodes/cart","siteSpaceId":"sitesp_i5rBD","description":"The following XML will depend on the contents of the cart:","breadcrumbs":[{"label":"Supporting Nodes"},{"label":"Supporting Nodes"}]},{"id":"5XZhFOUfLScyEhVA32ok","title":"Activity Times","pathname":"/zapi/supporting-nodes/supporting-nodes/activity-times","siteSpaceId":"sitesp_i5rBD","description":"The following XML represents a single activity time node, but depending on the type of activity which the request is for, you may have many of these returned. The <activityTimes> node is singular and","breadcrumbs":[{"label":"Supporting Nodes"},{"label":"Supporting Nodes"}]},{"id":"1FbuKCSoF2wltdptKJwo","title":"Products","pathname":"/zapi/supporting-nodes/supporting-nodes/products","siteSpaceId":"sitesp_i5rBD","description":"Basic result data for products when sent back in response structures:","breadcrumbs":[{"label":"Supporting Nodes"},{"label":"Supporting Nodes"}]},{"id":"4ePygn8HNqJykARrWjoT","title":"Business Hours","pathname":"/zapi/supporting-nodes/supporting-nodes/business-hours","siteSpaceId":"sitesp_i5rBD","description":"Basic result data for business hours when sent back in response structures:","breadcrumbs":[{"label":"Supporting Nodes"},{"label":"Supporting Nodes"}]},{"id":"rXUz8yv1XuWQ9xbC3P1Z","title":"Pickup Locations","pathname":"/zapi/supporting-nodes/supporting-nodes/pickup-locations","siteSpaceId":"sitesp_i5rBD","description":"Basic result data for pickup locations when sent back in response structures:","breadcrumbs":[{"label":"Supporting Nodes"},{"label":"Supporting Nodes"}]},{"id":"fvC3QZP4LUJmhbk6iHN2","title":"Dropoff Location","pathname":"/zapi/supporting-nodes/supporting-nodes/dropoff-location","siteSpaceId":"sitesp_i5rBD","description":"Basic result data for drop-off locations when sent back in response structures","breadcrumbs":[{"label":"Supporting Nodes"},{"label":"Supporting Nodes"}]},{"id":"CENLtDntWiqQceHKC9Y6","title":"Rental Date & Times","pathname":"/zapi/supporting-nodes/supporting-nodes/rental-date-and-times","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"Supporting Nodes"},{"label":"Supporting Nodes"}]},{"id":"VluMNSvL53OW3UmFTxiF","title":"Allowed Guest Types","pathname":"/zapi/supporting-nodes/supporting-nodes/allowed-guest-types","siteSpaceId":"sitesp_i5rBD","description":"Basic result data describing the allowed guest types for any given activity or package in the system:","breadcrumbs":[{"label":"Supporting Nodes"},{"label":"Supporting Nodes"}]},{"id":"fwW715JvcgLtd3o5xSAN","title":"Waitlist","pathname":"/zapi/supporting-nodes/supporting-nodes/waitlist","siteSpaceId":"sitesp_i5rBD","description":"Basic node describing waitlists guests in the system:","breadcrumbs":[{"label":"Supporting Nodes"},{"label":"Supporting Nodes"}]},{"id":"algQO4X33vZY3xclcq3u","title":"Passenger List","pathname":"/zapi/supporting-nodes/supporting-nodes/passenger-list","siteSpaceId":"sitesp_i5rBD","description":"Basic node describing passenger types in the system:","breadcrumbs":[{"label":"Supporting Nodes"},{"label":"Supporting Nodes"}]},{"id":"o92Tn3Baw0ic8wtzf4dd","title":"Guest or Agent Details","pathname":"/zapi/supporting-nodes/supporting-nodes/guest-or-agent-details","siteSpaceId":"sitesp_i5rBD","description":"Basic node describing a single guest or agent in the system. Please note the root node here will be either <guestDetails> or <agentDetails>.","breadcrumbs":[{"label":"Supporting Nodes"},{"label":"Supporting Nodes"}]},{"id":"G9B04VzJMw8IwiChzQh9","title":"User Custom Fields","pathname":"/zapi/supporting-nodes/supporting-nodes/user-custom-fields","siteSpaceId":"sitesp_i5rBD","description":"These are fields that can be defined using the back office of Zaui, providing an easy mechanism to create and define your own custom user fields within the system. The format of these fields in XML is","breadcrumbs":[{"label":"Supporting Nodes"},{"label":"Supporting Nodes"}]},{"id":"vLUGEWb2jsBUl839u3Vo","title":"Related Bookings","pathname":"/zapi/supporting-nodes/supporting-nodes/related-bookings","siteSpaceId":"sitesp_i5rBD","description":"Basic node describing all bookings related to a guest in the system","breadcrumbs":[{"label":"Supporting Nodes"},{"label":"Supporting Nodes"}]},{"id":"KEtKMAMB7iPtIkRmHsou","title":"Transaction Details","pathname":"/zapi/supporting-nodes/supporting-nodes/transaction-details","siteSpaceId":"sitesp_i5rBD","description":"Refer to the trailing appendix in this document for those transactions that are available on the API. Depending on the type of transaction being submitted, your request will be required to provide par","breadcrumbs":[{"label":"Supporting Nodes"},{"label":"Supporting Nodes"}]},{"id":"pINyEgWb8FfyYm0yHjvm","title":"Basic Transaction","pathname":"/zapi/supporting-nodes/supporting-nodes/transaction-details/basic-transaction","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"Supporting Nodes"},{"label":"Supporting Nodes"},{"label":"Transaction Details"}]},{"id":"1hmMZRaETPWZB7F8jWjb","title":"Credit Card Transaction","pathname":"/zapi/supporting-nodes/supporting-nodes/transaction-details/credit-card-transaction","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"Supporting Nodes"},{"label":"Supporting Nodes"},{"label":"Transaction Details"}]},{"id":"gH6Y27FWfjD76w2vVRDT","title":"Voucher/Invoice Transaction","pathname":"/zapi/supporting-nodes/supporting-nodes/transaction-details/voucher-invoice-transaction","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"Supporting Nodes"},{"label":"Supporting Nodes"},{"label":"Transaction Details"}]},{"id":"MAPVNMCp4zXgyTQSXZtO","title":"Discount Transaction","pathname":"/zapi/supporting-nodes/supporting-nodes/transaction-details/discount-transaction","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"Supporting Nodes"},{"label":"Supporting Nodes"},{"label":"Transaction Details"}]},{"id":"i8azxhnE2jaXN9kCWRlt","title":"Days of the Week","pathname":"/zapi/supporting-nodes/supporting-nodes/days-of-the-week","siteSpaceId":"sitesp_i5rBD","description":"The days of week node provides a description of configuration, by date ranges, of the days of the week that the activity is available.","breadcrumbs":[{"label":"Supporting Nodes"},{"label":"Supporting Nodes"}]},{"id":"d4mCKJNPOcJLf6OC7z8S","title":"Price Code","pathname":"/zapi/supporting-nodes/supporting-nodes/price-code","siteSpaceId":"sitesp_i5rBD","description":"The following node describes a single price code as configured within the system.","breadcrumbs":[{"label":"Supporting Nodes"},{"label":"Supporting Nodes"}]},{"id":"XgzmZqNHl9c0Jps2fkFM","title":"Multi-Day Package Itinerary","pathname":"/zapi/supporting-nodes/supporting-nodes/multi-day-package-itinerary","siteSpaceId":"sitesp_i5rBD","description":"The following node describes a multi-day package as configured within the system.","breadcrumbs":[{"label":"Supporting Nodes"},{"label":"Supporting Nodes"}]},{"id":"Xzoh16GilZH1u4mtgBmh","title":"Booking - Search Results","pathname":"/zapi/supporting-nodes/supporting-nodes/booking-search-results","siteSpaceId":"sitesp_i5rBD","description":"The node for a single booking returned from a search is the following markup.","breadcrumbs":[{"label":"Supporting Nodes"},{"label":"Supporting Nodes"}]},{"id":"Rj8IFZSR1qzq3akvrxJg","title":"Mobile Data","pathname":"/zapi/supporting-nodes/supporting-nodes/mobile-data","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"Supporting Nodes"},{"label":"Supporting Nodes"}]},{"id":"hqpKYSP2kzI8aXqFQFq1","title":"Start Here","pathname":"/zapi/zapi-calls/start-here","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"ZAPI Calls"}]},{"id":"XyVchg7ReWOtCviNbFd2","title":"Ping Test","pathname":"/zapi/zapi-calls/start-here/ping-test","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Start Here"}]},{"id":"eUJ1vuqAto9kOO1YzKCQ","title":"Activity Calls","pathname":"/zapi/zapi-calls/activity-calls","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"ZAPI Calls"}]},{"id":"exNwgk6JwnnhIImGSB7H","title":"All Activities by Date","pathname":"/zapi/zapi-calls/activity-calls/all-activities-by-date","siteSpaceId":"sitesp_i5rBD","description":"Get a list of all activities available by date.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Activity Calls"}]},{"id":"iokDzvy1OjYoddtoDDqC","title":"All Activities by Name","pathname":"/zapi/zapi-calls/activity-calls/all-activities-by-name","siteSpaceId":"sitesp_i5rBD","description":"Get a list of all activities available by name.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Activity Calls"}]},{"id":"vB61KUlpfqyd47P3klf3","title":"Activity & Product Catalog","pathname":"/zapi/zapi-calls/activity-calls/activity-and-product-catalog","siteSpaceId":"sitesp_i5rBD","description":"Get a list of all activities and products available.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Activity Calls"}]},{"id":"-MdTLnUbCu9ov4P85lCJ","title":"Activity Categories","pathname":"/zapi/zapi-calls/activity-calls/activity-categories","siteSpaceId":"sitesp_i5rBD","description":"Performs a fetch of all configured categories.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Activity Calls"}]},{"id":"4vVj0Gb2QM1MoH2jA3Oo","title":"Activity Category by ID","pathname":"/zapi/zapi-calls/activity-calls/activity-category-by-id","siteSpaceId":"sitesp_i5rBD","description":"Performs a fetch of all configured categories by ID.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Activity Calls"}]},{"id":"lArTqSvxsgC58GoEmDy9","title":"Cancelled Activities","pathname":"/zapi/zapi-calls/activity-calls/cancelled-activities","siteSpaceId":"sitesp_i5rBD","description":"Performs a fetch of a single cancelled activity or all cancelled activities by date.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Activity Calls"}]},{"id":"qOHpfaZgwfKQwp5EZ0HW","title":"Create Cancellation","pathname":"/zapi/zapi-calls/activity-calls/create-cancellation","siteSpaceId":"sitesp_i5rBD","description":"Create a cancellation for a specific activity for a single date or date range.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Activity Calls"}]},{"id":"-McASXAzkAEIB_uNKjwz","title":"Check Inventory","pathname":"/zapi/zapi-calls/activity-calls/check-inventory","siteSpaceId":"sitesp_i5rBD","description":"Performs a single inventory check by travel date.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Activity Calls"}]},{"id":"-Mbv9TH4bpjGC5iLaVaZ","title":"Single Activity Details","pathname":"/zapi/zapi-calls/activity-calls/activity-details","siteSpaceId":"sitesp_i5rBD","description":"Get details on a single activity, attraction or event.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Activity Calls"}]},{"id":"-MbrqjZUNmbkBcYgqEIa","title":"Upcoming Activities","pathname":"/zapi/zapi-calls/activity-calls/api-updates","siteSpaceId":"sitesp_i5rBD","description":"Returns a list of activity objects upcoming for sale, based on the parameters in your query.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Activity Calls"}]},{"id":"KDOqyemFb1DqQtUrXLRw","title":"Remove Cancellation","pathname":"/zapi/zapi-calls/activity-calls/remove-cancellation","siteSpaceId":"sitesp_i5rBD","description":"Removes an existing cancellation for an activity.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Activity Calls"}]},{"id":"3aXarHBT25CdCaktxfML","title":"Rental Equipment Calls","pathname":"/zapi/zapi-calls/activity-calls/rental-equipment-calls","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Activity Calls"}]},{"id":"-MgBaIv8n7yTqpqMkkXj","title":"Equipment Price Quote","pathname":"/zapi/zapi-calls/activity-calls/rental-equipment-calls/zapipricequote","siteSpaceId":"sitesp_i5rBD","description":"Pricing per piece of equipment","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Activity Calls"},{"label":"Rental Equipment Calls"}]},{"id":"-MfsIAWM5V_GI35SH8G6","title":"Equipment Availability","pathname":"/zapi/zapi-calls/activity-calls/rental-equipment-calls/zapi_getequipmentavailability","siteSpaceId":"sitesp_i5rBD","description":"Availability for a specific piece of equipment, equipment within a category or equipment used by the activity","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Activity Calls"},{"label":"Rental Equipment Calls"}]},{"id":"VGKBKZM1olFMRNSUuNTO","title":"Cart Contents","pathname":"/zapi/zapi-calls/activity-calls/rental-equipment-calls/cart-contents","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Activity Calls"},{"label":"Rental Equipment Calls"}]},{"id":"YA4GZIOOeA6QaT6RaQ6w","title":"Add to Cart","pathname":"/zapi/zapi-calls/activity-calls/rental-equipment-calls/add-to-cart","siteSpaceId":"sitesp_i5rBD","description":"Please Note: Response not currently available","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Activity Calls"},{"label":"Rental Equipment Calls"}]},{"id":"DiLUqRhVQ3SdHfQFUTwp","title":"Agent Calls","pathname":"/zapi/zapi-calls/agent-calls","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"ZAPI Calls"}]},{"id":"qVTHj6LPsbXMRKBhnXnj","title":"Agent Login","pathname":"/zapi/zapi-calls/agent-calls/agent-login","siteSpaceId":"sitesp_i5rBD","description":"This call will return the API token, API User ID and API Account ID, which can then be used on subsequent calls.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Agent Calls"}]},{"id":"tEzPqJvlkiRaJ3SXEoL8","title":"Authenticate Agent","pathname":"/zapi/zapi-calls/agent-calls/authenticate-agent","siteSpaceId":"sitesp_i5rBD","description":"Authenticates that the agent is part of the system","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Agent Calls"}]},{"id":"DL3djnoF9TY7gFF6tjuj","title":"Get Agent Profile","pathname":"/zapi/zapi-calls/agent-calls/get-agent-profile","siteSpaceId":"sitesp_i5rBD","description":"Retrieve the profile of any agent by ID.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Agent Calls"}]},{"id":"ijEF2wp1qJ3zAc2cvw0b","title":"Update Agent Username","pathname":"/zapi/zapi-calls/agent-calls/update-agent-username","siteSpaceId":"sitesp_i5rBD","description":"Update the username of the agent.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Agent Calls"}]},{"id":"FSKMTpOuS1ZHAqpyhuLZ","title":"Update Agent Password","pathname":"/zapi/zapi-calls/agent-calls/update-agent-password","siteSpaceId":"sitesp_i5rBD","description":"Update the password of the agent.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Agent Calls"}]},{"id":"zErFfmOhhNUX9Ap62kEw","title":"Booking","pathname":"/zapi/zapi-calls/booking","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"ZAPI Calls"}]},{"id":"VIe9a05L6aKDFf8AxKeH","title":"Batch Availability","pathname":"/zapi/zapi-calls/booking/batch-availability","siteSpaceId":"sitesp_i5rBD","description":"This call will allow checking availability for a single activity, across many days.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Booking"}]},{"id":"Rb1iMRHSYw06ROfmaxFH","title":"Booking Search","pathname":"/zapi/zapi-calls/booking/booking-search","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Booking"}]},{"id":"ExKqLIzOVOOyotPHmjBM","title":"Search Bookings","pathname":"/zapi/zapi-calls/booking/booking-search/search-bookings","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Booking"},{"label":"Booking Search"}]},{"id":"Nz10KfeoF9cYLFGOTwv1","title":"Search by Booking Number","pathname":"/zapi/zapi-calls/booking/booking-search/search-by-booking-number","siteSpaceId":"sitesp_i5rBD","description":"Search for a booking using the confirmation number.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Booking"},{"label":"Booking Search"}]},{"id":"LqjbmpkLiMZ38GFSRP5R","title":"Search by Last Name","pathname":"/zapi/zapi-calls/booking/booking-search/search-by-last-name","siteSpaceId":"sitesp_i5rBD","description":"Search for a booking using the last name on the booking.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Booking"},{"label":"Booking Search"}]},{"id":"Fz0M5v66NcDJmd5Skmwy","title":"Search by Mobile Number","pathname":"/zapi/zapi-calls/booking/booking-search/search-by-mobile-number","siteSpaceId":"sitesp_i5rBD","description":"Search for a booking using the mobile phone number on the booking.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Booking"},{"label":"Booking Search"}]},{"id":"DmcsimOyVnJC725L8p8q","title":"Cancel Booking","pathname":"/zapi/zapi-calls/booking/cancel-booking","siteSpaceId":"sitesp_i5rBD","description":"This call will cancel the booking, even if there is an outstanding balance on the booking.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Booking"}]},{"id":"XChdnpQmHeatoINNfsrU","title":"Email Itinerary","pathname":"/zapi/zapi-calls/booking/email-itinerary","siteSpaceId":"sitesp_i5rBD","description":"Send a notification based on booking status.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Booking"}]},{"id":"8P5d7b2BC8O3UbJ8PhK7","title":"Generate Barcode Image","pathname":"/zapi/zapi-calls/booking/generate-barcode-image","siteSpaceId":"sitesp_i5rBD","description":"Create a barcode for activity or product related to a single booking ID.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Booking"}]},{"id":"MJTRj3YpLVzrCbN2A5jK","title":"Ticket Data by Booking ID","pathname":"/zapi/zapi-calls/booking/ticket-data-by-booking-id","siteSpaceId":"sitesp_i5rBD","description":"Retrieve ticket information related to a single booking.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Booking"}]},{"id":"CYjnYrWamr8xdpbjUaw6","title":"Guest Specific","pathname":"/zapi/zapi-calls/guest-specific","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"ZAPI Calls"}]},{"id":"XOAKD2xnlP7wWxf4gkhu","title":"Authenticate Guest","pathname":"/zapi/zapi-calls/guest-specific/authenticate-guest","siteSpaceId":"sitesp_i5rBD","description":"Authenticates that the guest is part of the system","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Guest Specific"}]},{"id":"bskWqAwCoUSa8AVHw99N","title":"Booking Details","pathname":"/zapi/zapi-calls/guest-specific/booking-details","siteSpaceId":"sitesp_i5rBD","description":"Get single booking details of a single guest.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Guest Specific"}]},{"id":"CzlLIt3TokUXy6geE9JV","title":"Get Guest Profile","pathname":"/zapi/zapi-calls/guest-specific/get-guest-profile","siteSpaceId":"sitesp_i5rBD","description":"Retrieve the profile of any guest by ID.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Guest Specific"}]},{"id":"AGIFyfdrYTEuHEmyDyEq","title":"Guest Lookup","pathname":"/zapi/zapi-calls/guest-specific/guest-lookup","siteSpaceId":"sitesp_i5rBD","description":"Search for a guest based on certain pieces of information.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Guest Specific"}]},{"id":"TXEuTfyfOE2RKCML9cEL","title":"Update Username","pathname":"/zapi/zapi-calls/guest-specific/update-username","siteSpaceId":"sitesp_i5rBD","description":"Update the username of the guest.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Guest Specific"}]},{"id":"7HBkYv4Pbyl7rbE5zqmo","title":"Update Password","pathname":"/zapi/zapi-calls/guest-specific/update-password","siteSpaceId":"sitesp_i5rBD","description":"Update the password of the guest.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Guest Specific"}]},{"id":"CkNnESH3rxoapztXFmnd","title":"Update Profile","pathname":"/zapi/zapi-calls/guest-specific/update-profile","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Guest Specific"}]},{"id":"nGjbmYsx8ryo7MkzH6YU","title":"Interacting with a Cart","pathname":"/zapi/zapi-calls/interacting-with-a-cart","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"ZAPI Calls"}]},{"id":"-Mc2QupVRt-Q-f7_mb1L","title":"Add Activity to Cart","pathname":"/zapi/zapi-calls/interacting-with-a-cart/add-activity","siteSpaceId":"sitesp_i5rBD","description":"Adds a single activity to the cart order","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Interacting with a Cart"}]},{"id":"BDVAe8ntQnp0LFuUym2e","title":"Add Package to Cart","pathname":"/zapi/zapi-calls/interacting-with-a-cart/add-package-to-cart","siteSpaceId":"sitesp_i5rBD","description":"Adds a package to the cart order","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Interacting with a Cart"}]},{"id":"qr6hN7ghvpcvPPhyMrgy","title":"Add Product to Cart","pathname":"/zapi/zapi-calls/interacting-with-a-cart/add-product-to-cart","siteSpaceId":"sitesp_i5rBD","description":"This API call will add the requested quantity to any existing quantities that are in the cart for the same product.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Interacting with a Cart"}]},{"id":"TdKQa6uWqSuCtAWldUg7","title":"Clear Cart Session","pathname":"/zapi/zapi-calls/interacting-with-a-cart/clear-cart-session","siteSpaceId":"sitesp_i5rBD","description":"Clear a current cart session.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Interacting with a Cart"}]},{"id":"Y1KZiRMygbYIAviSxJiB","title":"Create a Unique Cart","pathname":"/zapi/zapi-calls/interacting-with-a-cart/create-a-unique-cart","siteSpaceId":"sitesp_i5rBD","description":"Create a new cart session.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Interacting with a Cart"}]},{"id":"xnq49ggW09q4FzOmwift","title":"Get All Cart Sessions","pathname":"/zapi/zapi-calls/interacting-with-a-cart/get-all-cart-sessions","siteSpaceId":"sitesp_i5rBD","description":"Will return a list of all the valid cart sessions active.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Interacting with a Cart"}]},{"id":"3ifBxzWSl5ySDagx2wAR","title":"Get Cart Contents","pathname":"/zapi/zapi-calls/interacting-with-a-cart/get-cart-contents","siteSpaceId":"sitesp_i5rBD","description":"Returns information for a specific cart.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Interacting with a Cart"}]},{"id":"RpTB9U9CyILrQqla4rKR","title":"Load Booking into Cart","pathname":"/zapi/zapi-calls/interacting-with-a-cart/load-booking-into-cart","siteSpaceId":"sitesp_i5rBD","description":"Add an existing booking into the cart.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Interacting with a Cart"}]},{"id":"0epcpJRBrbMVDCOdeXDs","title":"Remove Activity","pathname":"/zapi/zapi-calls/interacting-with-a-cart/remove-activity","siteSpaceId":"sitesp_i5rBD","description":"This API callback will remove the activity entirely from the cart. If the activity is part of a package that is also within the cart, this will remain.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Interacting with a Cart"}]},{"id":"5uk3jKkhXA8ZFzXXuArj","title":"Remove Product","pathname":"/zapi/zapi-calls/interacting-with-a-cart/remove-product","siteSpaceId":"sitesp_i5rBD","description":"This API callback will remove the product entirely from the cart, regardless of the quantity for that product. If the same product is part of a package that is also within the cart, these will remain.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Interacting with a Cart"}]},{"id":"NYCEP0PGUY2tFPltUEbR","title":"Remove Cart Session","pathname":"/zapi/zapi-calls/interacting-with-a-cart/remove-cart-session","siteSpaceId":"sitesp_i5rBD","description":"Will remove the cartId from your list of allowed sessions, and clear any order contents that you might have attached to this session Id.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Interacting with a Cart"}]},{"id":"BgXcSFsUaGuNfdEnDh03","title":"Update Notes to Cart","pathname":"/zapi/zapi-calls/interacting-with-a-cart/update-notes-to-cart","siteSpaceId":"sitesp_i5rBD","description":"Add or update notes to a new or existing cart.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Interacting with a Cart"}]},{"id":"QM50Y9ycLQSiHpzwmri0","title":"Update Customer Details","pathname":"/zapi/zapi-calls/interacting-with-a-cart/update-customer-details","siteSpaceId":"sitesp_i5rBD","description":"Add or update customer details to a new or existing cart.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Interacting with a Cart"}]},{"id":"59XAummOlOVrIolRl0kr","title":"Transactions","pathname":"/zapi/zapi-calls/interacting-with-a-cart/transactions","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Interacting with a Cart"}]},{"id":"YTEbuqHtZj5iuUi9ylFO","title":"Process Payment","pathname":"/zapi/zapi-calls/interacting-with-a-cart/transactions/process-payment","siteSpaceId":"sitesp_i5rBD","description":"Process Cart with Payment is used to create a new booking from the cart contents.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Interacting with a Cart"},{"label":"Transactions"}]},{"id":"-MfZRSHHf8h2R-7lQAhY","title":"Process Single Transaction","pathname":"/zapi/zapi-calls/interacting-with-a-cart/transactions/process-single-transaction","siteSpaceId":"sitesp_i5rBD","description":"This method is used to create all transactions on open ZAPI cart objects (this includes refunds).","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Interacting with a Cart"},{"label":"Transactions"}]},{"id":"HXpRpyIJFjUAzm6l6oNG","title":"Apply Promo Code","pathname":"/zapi/zapi-calls/interacting-with-a-cart/transactions/apply-promo-code","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Interacting with a Cart"},{"label":"Transactions"}]},{"id":"u6zHaVQax6gYEDGbSHfa","title":"Apply Gift Card","pathname":"/zapi/zapi-calls/interacting-with-a-cart/transactions/apply-gift-card","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Interacting with a Cart"},{"label":"Transactions"}]},{"id":"flmq4pSZGh9N5w9bQcPk","title":"Manifest","pathname":"/zapi/zapi-calls/manifest","siteSpaceId":"sitesp_i5rBD","description":"zapiGetManifestEntireDayByDate","breadcrumbs":[{"label":"ZAPI Calls"}]},{"id":"CWuweemOv5ouvGY9yRHH","title":"Entire Day Manifest","pathname":"/zapi/zapi-calls/manifest/entire-day-manifest","siteSpaceId":"sitesp_i5rBD","description":"Get the manifest that lists every booking for every activity for a single date.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Manifest"}]},{"id":"e0pVpz6i3Hf2BLXzc44k","title":"Activity Manifest","pathname":"/zapi/zapi-calls/manifest/activity-manifest","siteSpaceId":"sitesp_i5rBD","description":"Get the daily manifest for a single activity.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Manifest"}]},{"id":"RlmZbHxFC0kmHZdKdFcP","title":"Mobile","pathname":"/zapi/zapi-calls/mobile","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"ZAPI Calls"}]},{"id":"P0PligewBJ2gHvtseBfS","title":"Check In","pathname":"/zapi/zapi-calls/mobile/check-in","siteSpaceId":"sitesp_i5rBD","description":"Check in a guest or guests for a single activity in a single booking","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Mobile"}]},{"id":"CN3FeG5G0HH8a6GjwjrR","title":"Generate Z Report","pathname":"/zapi/zapi-calls/mobile/generate-z-report","siteSpaceId":"sitesp_i5rBD","description":"Print the cash out report for all mobile users.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Mobile"}]},{"id":"a9yQKPyyMhctTif5ghYq","title":"User Logout","pathname":"/zapi/zapi-calls/mobile/user-logout","siteSpaceId":"sitesp_i5rBD","description":"Log a user out of a mobile session.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Mobile"}]},{"id":"SweS5WnVM6bnmWMCbh8U","title":"Packages","pathname":"/zapi/zapi-calls/packages","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"ZAPI Calls"}]},{"id":"a6Vt0ESC2jrotKjtSOdS","title":"Get Package Categories","pathname":"/zapi/zapi-calls/packages/get-package-categories","siteSpaceId":"sitesp_i5rBD","description":"Search for all available package categories.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Packages"}]},{"id":"P412rl35G1jbFwepF3pT","title":"Get Packages by Category","pathname":"/zapi/zapi-calls/packages/get-packages-by-category","siteSpaceId":"sitesp_i5rBD","description":"Search for all packages within a single category.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Packages"}]},{"id":"1EreuZvXVVdWiv7NMKlR","title":"Get Package Details","pathname":"/zapi/zapi-calls/packages/get-package-details","siteSpaceId":"sitesp_i5rBD","description":"Get details for a single package ID.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Packages"}]},{"id":"EmxNkWCxQiONFsECC0yM","title":"Minimum Dates to Book","pathname":"/zapi/zapi-calls/packages/minimum-dates-to-book","siteSpaceId":"sitesp_i5rBD","description":"Determine when a package needs to be booked by.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Packages"}]},{"id":"rPBcgANyWqXIytyTagDs","title":"Package Pricing Details","pathname":"/zapi/zapi-calls/packages/package-pricing-details","siteSpaceId":"sitesp_i5rBD","description":"Get pricing for either a standard or multi-day package.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Packages"}]},{"id":"Wf4c41iwgfxKJR0Yvc38","title":"Products","pathname":"/zapi/zapi-calls/products","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"ZAPI Calls"}]},{"id":"z0nEKyzjEa3r1ZZhsPrG","title":"Product Inventory","pathname":"/zapi/zapi-calls/products/product-inventory","siteSpaceId":"sitesp_i5rBD","description":"Search against all available inventory for a product or only for a specific quantity.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Products"}]},{"id":"2vtNytz2SNgmkxm7BSjc","title":"Product Categories","pathname":"/zapi/zapi-calls/products/product-categories","siteSpaceId":"sitesp_i5rBD","description":"Search for all available product categories.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Products"}]},{"id":"1Dy1aae6bFqqyUsNtZ17","title":"Product by Category","pathname":"/zapi/zapi-calls/products/product-by-category","siteSpaceId":"sitesp_i5rBD","description":"Search for a product by Category ID.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Products"}]},{"id":"seWrq7lcqUKgVIn9TnZ3","title":"Product by Name","pathname":"/zapi/zapi-calls/products/product-by-name","siteSpaceId":"sitesp_i5rBD","description":"Search for a specific product by name.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Products"}]},{"id":"Jw4ViqMvGXovxviw4f25","title":"Single Product Detail","pathname":"/zapi/zapi-calls/products/single-product-detail","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Products"}]},{"id":"TdUdOKjhyx0EaNgUCCkx","title":"System Info","pathname":"/zapi/zapi-calls/system-info","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"ZAPI Calls"}]},{"id":"hELWwjt2bDsHzWnNPL7B","title":"All Companies","pathname":"/zapi/zapi-calls/system-info/all-companies","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"System Info"}]},{"id":"ZibffW5BmE42r8L6rzc4","title":"All Equipment","pathname":"/zapi/zapi-calls/system-info/all-equipment","siteSpaceId":"sitesp_i5rBD","description":"Returns a list of all equipment for a system","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"System Info"}]},{"id":"iw2W2b0mzclkTNwl410I","title":"Custom Fields List","pathname":"/zapi/zapi-calls/system-info/custom-fields-list","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"System Info"}]},{"id":"ALMRaEu0FUNqzMJSdD43","title":"Employee List","pathname":"/zapi/zapi-calls/system-info/employee-list","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"System Info"}]},{"id":"-Mf_0x038wtVcvYTXm7H","title":"Get System Info","pathname":"/zapi/zapi-calls/system-info/get-system-info","siteSpaceId":"sitesp_i5rBD","description":"Returns key info about the Zaui System and important settings.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"System Info"}]},{"id":"H1baWGdKFXC72AD2iaXD","title":"User List","pathname":"/zapi/zapi-calls/system-info/user-list","siteSpaceId":"sitesp_i5rBD","description":"Returns a list of all users for the system","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"System Info"}]},{"id":"7ImA85lMVgidr3dOXhyE","title":"Waitlist","pathname":"/zapi/zapi-calls/waitlist","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"ZAPI Calls"}]},{"id":"1FxSJhwSI266eKEGImGr","title":"Single Activity Waitlist","pathname":"/zapi/zapi-calls/waitlist/single-activity-waitlist","siteSpaceId":"sitesp_i5rBD","description":"Get the waitlist for a single date per activity.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Waitlist"}]},{"id":"DMHmfr8T00RgWKGQSKDE","title":"Add Guest","pathname":"/zapi/zapi-calls/waitlist/add-guest","siteSpaceId":"sitesp_i5rBD","description":"Add guest or guests to the waitlist for a single activity.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Waitlist"}]},{"id":"mXbbtFZlt1ufXFR9uuji","title":"Convert to Cart","pathname":"/zapi/zapi-calls/waitlist/convert-to-cart","siteSpaceId":"sitesp_i5rBD","description":"Convert a waitlist item to a cart and confirm booking by adding a transaction.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Waitlist"}]},{"id":"K7DIStVAaABneR9b6X2g","title":"Remove Guest","pathname":"/zapi/zapi-calls/waitlist/remove-guest","siteSpaceId":"sitesp_i5rBD","description":"Remove a guest or guests from the waitlist.","breadcrumbs":[{"label":"ZAPI Calls"},{"label":"Waitlist"}]},{"id":"xZBf3afRUDyoVwsmAHMn","title":"Activity Type IDs","pathname":"/zapi/appendix/activity-type-ids","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"Appendix"}]},{"id":"LzUXSzkh7g5F8C5Ljs4B","title":"Error Codes","pathname":"/zapi/appendix/error-codes","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"Appendix"}]},{"id":"SDXc4y8GN41cqn5cCylp","title":"Package Type IDs","pathname":"/zapi/appendix/package-type-ids","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"Appendix"}]},{"id":"PEgEs7eOtNaRRFHTrL3H","title":"Product Type IDs","pathname":"/zapi/appendix/product-type-ids","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"Appendix"}]},{"id":"PKFRJOBEAT0mqe1RudCU","title":"Payment Method Type IDs","pathname":"/zapi/appendix/payment-method-type-ids","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"Appendix"}]},{"id":"FhKoMcNbVk8IuIcnsWaV","title":"User Type IDs","pathname":"/zapi/appendix/user-type-ids","siteSpaceId":"sitesp_i5rBD","description":"","breadcrumbs":[{"label":"Appendix"}]}]}